Package com.lexmark.saperion.client.administration

Interface UserManagementServiceClient

All Known Implementing Classes:
UserManagementServiceClientImpl
public interface UserManagementServiceClient
This client provides functionality to administrate the users of a saperion system.
Author:
jschwarz

  • Method Details

    • resolve

      UserClient resolve(com.lexmark.saperion.administration.UserReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      This method returns an administration client for the user referenced.
      Parameters:
      reference - a reference to the user to administrate
      Returns:
      an administration client for the user referenced
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • resolveName

      UserClient resolveName(String userName) throws com.lexmark.saperion.exceptions.EcmException
      This method returns an administration client for the user with the given name.
      Parameters:
      userName - the name of the user to administrate
      Returns:
      an administration client for the user with the given name
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • search

      SearchClient<com.lexmark.saperion.administration.UserType> search() throws com.lexmark.saperion.exceptions.EcmException
      This method returns a search client for searching users.
      Returns:
      a search client for searching users
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • searchDeleted

      SearchClient<com.lexmark.saperion.administration.UserType> searchDeleted() throws Exception
      This method returns a search client for searching deleted users.
      Returns:
      a search client for searching deleted users
      Throws:
      com.lexmark.saperion.exceptions.EcmException
      Exception

    • createUser

      com.lexmark.saperion.administration.UserReferenceType createUser(com.lexmark.saperion.administration.CreateUserPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException
      This method creates a new user with the given properties.
      Parameters:
      properties - the properties of the user
      Returns:
      a reference to the user created
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createUser

      com.lexmark.saperion.administration.UserReferenceType createUser(String shortName, String fullName, String password, String description, String emailAddress) throws com.lexmark.saperion.exceptions.EcmException
      This method creates a new user with the given properties.
      Parameters:
      shortName - the short name (display name) of the new user
      fullName - the full name of the new user
      password - the password of the user
      description - a description of the new user
      emailAddress - the email address of the user
      Returns:
      a reference to the user created
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createUser

      com.lexmark.saperion.administration.UserReferenceType createUser(String shortName, String password) throws com.lexmark.saperion.exceptions.EcmException
      This is a shorthand to createUser(CreateUserPropertiesType). It is equivalent to caling createUser(shortName, shortName, password, "", "").
      Parameters:
      shortName - the short name (display name) of the new user
      password - the password of the user
      Returns:
      a reference to the user created
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • getCurrentUser

      @Deprecated UserClient getCurrentUser() throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use getCurrentUserContext() instead
      This method returns an administration client for the current user.
      Returns:
      an administration client for the current user
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when loading the current user failed

    • getCurrentUserContext

      UserContextClient getCurrentUserContext() throws com.lexmark.saperion.exceptions.EcmException
      Throws:
      com.lexmark.saperion.exceptions.EcmException