Interface AclManagementServiceClient

  • All Known Implementing Classes:
    AclManagementServiceClientImpl

    public interface AclManagementServiceClient
    This client provides methods for administrating access control lists.
    Author:
    tfrisch
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.lexmark.saperion.administration.AclReferenceType createAcl​(com.lexmark.saperion.administration.AclPropertiesType properties)
      This method creates a new access control list with the given properties and returns a reference to it.
      AclClient resolve​(com.lexmark.saperion.administration.AclReferenceType reference)
      This method returns an administration client for the access control list with the given reference.
      AclClient resolveName​(java.lang.String aclName)
      This method returns an administration client for the access control list with the given name.
      SearchClient<com.lexmark.saperion.administration.AclListItemType> search()
      This method returns a search client for searching access control lists.
      SearchClient<com.lexmark.saperion.administration.AclListItemType> searchDeleted()
      This method returns a search client for searching deleted access control lists.
    • Method Detail

      • resolve

        AclClient resolve​(com.lexmark.saperion.administration.AclReferenceType reference)
                   throws com.lexmark.saperion.exceptions.EcmException
        This method returns an administration client for the access control list with the given reference.
        Parameters:
        reference - a reference to the access control list to administrate
        Returns:
        an administration client for the access control list with the given reference
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • resolveName

        AclClient resolveName​(java.lang.String aclName)
                       throws com.lexmark.saperion.exceptions.EcmException
        This method returns an administration client for the access control list with the given name.
        Parameters:
        aclName - the name of the access control list to administrate
        Returns:
        an administration client for the access control list with the given name
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • search

        SearchClient<com.lexmark.saperion.administration.AclListItemType> search()
                                                                          throws com.lexmark.saperion.exceptions.EcmException
        This method returns a search client for searching access control lists.
        Returns:
        a search client for searching access control lists
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • searchDeleted

        SearchClient<com.lexmark.saperion.administration.AclListItemType> searchDeleted()
                                                                                 throws com.lexmark.saperion.exceptions.EcmException
        This method returns a search client for searching deleted access control lists.
        Returns:
        a search client for searching deleted access control lists
        Throws:
        com.lexmark.saperion.exceptions.EcmException
      • createAcl

        com.lexmark.saperion.administration.AclReferenceType createAcl​(com.lexmark.saperion.administration.AclPropertiesType properties)
                                                                throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new access control list with the given properties and returns a reference to it.
        Parameters:
        properties - the properties of the new access control list
        Returns:
        a reference to access control list created
        Throws:
        com.lexmark.saperion.exceptions.EcmException