com.lexmark.saperion.client.implementation.administration

Class UserManagementServiceClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.administration.UserManagementServiceClientImpl

All Implemented Interfaces:

UserManagementServiceClient

public class UserManagementServiceClientImpl
extends Object
implements UserManagementServiceClient

This is the default implementation of UserManagementService.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
UserManagementServiceClientImpl(com.lexmark.saperion.administration.UserManagementService userManagementService)

Method Summary

Modifier and Type	Method and Description
com.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 to UserManagementServiceClient.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.
UserClient	getCurrentUser() This method returns an administration client for the current user.
UserContextClient	getCurrentUserContext()
UserClient	resolve(com.lexmark.saperion.administration.UserReferenceType reference) This method returns an administration client for the user referenced.
UserClient	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>	searchDeleted() This method returns a search client for searching deleted users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserManagementServiceClientImpl

public UserManagementServiceClientImpl(com.lexmark.saperion.administration.UserManagementService userManagementService)

Method Detail

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 interface UserManagementServiceClient

Parameters:

reference - a reference to the user to administrate

Returns:

an administration client for the user referenced

Throws:

com.lexmark.saperion.exceptions.EcmException

resolveName

public UserClient resolveName(String userName)
                       throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserManagementServiceClient

This method returns an administration client for the user with the given name.

Specified by:

resolveName in interface UserManagementServiceClient

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.EcmException

Description copied from interface: UserManagementServiceClient

This method returns a search client for searching users.

Specified by:

search in interface UserManagementServiceClient

Returns:

a search client for searching users

Throws:

com.lexmark.saperion.exceptions.EcmException

searchDeleted

public SearchClient<com.lexmark.saperion.administration.UserType> searchDeleted()
                                                                         throws Exception

Description copied from interface: UserManagementServiceClient

This method returns a search client for searching deleted users.

Specified by:

searchDeleted in interface UserManagementServiceClient

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 interface UserManagementServiceClient

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 interface UserManagementServiceClient

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

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 to UserManagementServiceClient.createUser(CreateUserPropertiesType). It is equivalent to caling createUser(shortName, shortName, password, "", "").

Specified by:

createUser in interface UserManagementServiceClient

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

public UserClient getCurrentUser()
                          throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserManagementServiceClient

This method returns an administration client for the current user.

Specified by:

getCurrentUser in interface UserManagementServiceClient

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 interface UserManagementServiceClient

Throws:

com.lexmark.saperion.exceptions.EcmException