com.lexmark.saperion.administration

Interface AclManagementService

public interface AclManagementService

The acl management service provides the required operations to create, read, update and delete access control list entities in the user management system.

Author:

tfrisch

Method Summary

Modifier and Type	Method and Description
AclReferenceType	createAcl(AclPropertiesType properties) This method creates a new access control list with the properties and returns a reference to the new access control list.
void	deleteAcl(AclReferenceType reference) Deletes the access control list with the given reference.
List<AclReferenceType>	getACLs(AclReferenceType reference) This method returns the ACLs currently set on the references ACL.
AclType	loadAcl(AclReferenceType reference) This method returns an access control list with the given id.
AclType	loadAclByName(String name) Loads an access control list identified by its name.
SearchExecutionService<AclListItemType>	newTenantAclSearchService() This method returns a new SearchExecutionService that lists all access control lists of the current user's tenant.
SearchExecutionService<AclListItemType>	newTenantDeletedAclSearchService() This method returns a new SearchExecutionService that lists all deleted access control lists of the current user's tenant.
void	undeleteAcl(AclReferenceType reference) Un-deletes the access control list with the given reference.
void	updateAcl(AclReferenceType reference, AclPropertiesType properties) Updates the referenced access control list with the given properties.

Method Detail

loadAcl

AclType loadAcl(AclReferenceType reference)
         throws EcmException

This method returns an access control list with the given id.

Parameters:

reference - the reference of the access control list to get

Returns:

the access control list with the given id

Throws:

ResourceNotFoundException - the referenced access control list does not exist in the backend system

EcmException - indicates that a system exception occurred

loadAclByName

AclType loadAclByName(String name)
               throws EcmException

Loads an access control list identified by its name.

Parameters:

name - the name of the access control list to load

Returns:

the referenced access control list

Throws:

SystemException - indicates that a system exception occurred

EcmException

deleteAcl

void deleteAcl(AclReferenceType reference)
        throws EcmException

Deletes the access control list with the given reference.

Parameters:

reference - the access control list reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

undeleteAcl

void undeleteAcl(AclReferenceType reference)
          throws EcmException

Un-deletes the access control list with the given reference.

Parameters:

reference - the access control list reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

newTenantAclSearchService

SearchExecutionService<AclListItemType> newTenantAclSearchService()
                                                           throws EcmException

This method returns a new SearchExecutionService that lists all access control lists of the current user's tenant.

Returns:

a new SearchExecutionService

Throws:

EcmException - indicates that a system exception occurred

newTenantDeletedAclSearchService

SearchExecutionService<AclListItemType> newTenantDeletedAclSearchService()
                                                                  throws EcmException

This method returns a new SearchExecutionService that lists all deleted access control lists of the current user's tenant.

Returns:

a new SearchExecutionService

Throws:

EcmException - indicates that a system exception occurred

createAcl

AclReferenceType createAcl(AclPropertiesType properties)
                    throws EcmException

This method creates a new access control list with the properties and returns a reference to the new access control list.

Parameters:

properties - the properties of the access control list

Returns:

a reference to the newly created access control list

Throws:

SystemException - indicates that a system exception occurred

EcmException

updateAcl

void updateAcl(AclReferenceType reference,
               AclPropertiesType properties)
        throws EcmException

Updates the referenced access control list with the given properties.

Parameters:

reference - the access control list reference

properties - the new properties of the access control list

Throws:

ResourceNotFoundException - the referenced access control list does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

getACLs

List<AclReferenceType> getACLs(AclReferenceType reference)
                        throws EcmException

This method returns the ACLs currently set on the references ACL.

Parameters:

reference - a reference to the ACL

Returns:

the ACLs currently set

Throws:

EcmException - when loading the ACLs failed