Class UserManagementServiceClientImpl
java.lang.Object
com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl
- All Implemented Interfaces:
UserManagementServiceClient
This is the default implementation of
UserManagementService
.- Author:
- jschwarz
-
Constructor Summary
ConstructorsConstructorDescriptionUserManagementServiceClientImpl
(com.lexmark.saperion.administration.UserManagementService userManagementService) -
Method Summary
Modifier and TypeMethodDescriptioncom.lexmark.saperion.administration.UserReferenceType
createUser
(com.lexmark.saperion.administration.CreateUserPropertiesType properties) This method creates a new user with the given properties.com.lexmark.saperion.administration.UserReferenceType
createUser
(String shortName, String password) This is a shorthand toUserManagementServiceClient.createUser(CreateUserPropertiesType)
.com.lexmark.saperion.administration.UserReferenceType
createUser
(String shortName, String fullName, String password, String description, String emailAddress) This method creates a new user with the given properties.This method returns an administration client for the current user.resolve
(com.lexmark.saperion.administration.UserReferenceType reference) This method returns an administration client for the user referenced.resolveName
(String userName) This method returns an administration client for the user with the given name.SearchClient<com.lexmark.saperion.administration.UserType>
search()
This method returns a search client for searching users.SearchClient<com.lexmark.saperion.administration.UserType>
This method returns a search client for searching deleted users.
-
Constructor Details
-
UserManagementServiceClientImpl
public UserManagementServiceClientImpl(com.lexmark.saperion.administration.UserManagementService userManagementService)
-
-
Method Details
-
resolve
public UserClient resolve(com.lexmark.saperion.administration.UserReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException Description copied from interface:UserManagementServiceClient
This method returns an administration client for the user referenced.- Specified by:
resolve
in interfaceUserManagementServiceClient
- Parameters:
reference
- a reference to the user to administrate- Returns:
- an administration client for the user referenced
- Throws:
com.lexmark.saperion.exceptions.EcmException
-
resolveName
Description copied from interface:UserManagementServiceClient
This method returns an administration client for the user with the given name.- Specified by:
resolveName
in interfaceUserManagementServiceClient
- 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
public SearchClient<com.lexmark.saperion.administration.UserType> search() throws com.lexmark.saperion.exceptions.EcmExceptionDescription copied from interface:UserManagementServiceClient
This method returns a search client for searching users.- Specified by:
search
in interfaceUserManagementServiceClient
- Returns:
- a search client for searching users
- Throws:
com.lexmark.saperion.exceptions.EcmException
-
searchDeleted
Description copied from interface:UserManagementServiceClient
This method returns a search client for searching deleted users.- Specified by:
searchDeleted
in interfaceUserManagementServiceClient
- Returns:
- a search client for searching deleted users
- Throws:
com.lexmark.saperion.exceptions.EcmException
Exception
-
createUser
public com.lexmark.saperion.administration.UserReferenceType createUser(com.lexmark.saperion.administration.CreateUserPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException Description copied from interface:UserManagementServiceClient
This method creates a new user with the given properties.- Specified by:
createUser
in interfaceUserManagementServiceClient
- Parameters:
properties
- the properties of the user- Returns:
- a reference to the user created
- Throws:
com.lexmark.saperion.exceptions.EcmException
-
createUser
public com.lexmark.saperion.administration.UserReferenceType createUser(String shortName, String fullName, String password, String description, String emailAddress) throws com.lexmark.saperion.exceptions.EcmException Description copied from interface:UserManagementServiceClient
This method creates a new user with the given properties.- Specified by:
createUser
in interfaceUserManagementServiceClient
- Parameters:
shortName
- the short name (display name) of the new userfullName
- the full name of the new userpassword
- the password of the userdescription
- a description of the new useremailAddress
- the email address of the user- Returns:
- a reference to the user created
- Throws:
com.lexmark.saperion.exceptions.EcmException
-
createUser
public com.lexmark.saperion.administration.UserReferenceType createUser(String shortName, String password) throws com.lexmark.saperion.exceptions.EcmException Description copied from interface:UserManagementServiceClient
This is a shorthand toUserManagementServiceClient.createUser(CreateUserPropertiesType)
. It is equivalent to calingcreateUser(shortName, shortName, password, "", "")
.- Specified by:
createUser
in interfaceUserManagementServiceClient
- Parameters:
shortName
- the short name (display name) of the new userpassword
- the password of the user- Returns:
- a reference to the user created
- Throws:
com.lexmark.saperion.exceptions.EcmException
-
getCurrentUser
Description copied from interface:UserManagementServiceClient
This method returns an administration client for the current user.- Specified by:
getCurrentUser
in interfaceUserManagementServiceClient
- Returns:
- an administration client for the current user
- Throws:
com.lexmark.saperion.exceptions.EcmException
- when loading the current user failed
-
getCurrentUserContext
public UserContextClient getCurrentUserContext() throws com.lexmark.saperion.exceptions.EcmException- Specified by:
getCurrentUserContext
in interfaceUserManagementServiceClient
- Throws:
com.lexmark.saperion.exceptions.EcmException
-