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(UserManagementService userManagementService)

Method Summary

Modifier and Type	Method and Description
UserReferenceType	createUser(CreateUserPropertiesType properties) This method creates a new user with the given properties.
UserReferenceType	createUser(String shortName, String password) This is a shorthand to UserManagementServiceClient.createUser(CreateUserPropertiesType).
UserReferenceType	createUser(String shortName, String fullName, String password, String description, String emailAddress) This method creates a new user with the given properties.
UserClient	resolve(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<UserListItemType>	search() This method returns a search client for searching users.
SearchClient<UserListItemType>	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(UserManagementService userManagementService)

Method Detail

resolve

public UserClient resolve(UserReferenceType reference)
                   throws 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:

EcmException

resolveName

public UserClient resolveName(String userName)
                       throws 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:

EcmException

search

public SearchClient<UserListItemType> search()
                                      throws 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:

EcmException

searchDeleted

public SearchClient<UserListItemType> 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:

EcmException

Exception

createUser

public UserReferenceType createUser(CreateUserPropertiesType properties)
                             throws 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:

EcmException

createUser

public UserReferenceType createUser(String shortName,
                                    String fullName,
                                    String password,
                                    String description,
                                    String emailAddress)
                             throws 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:

EcmException

createUser

public UserReferenceType createUser(String shortName,
                                    String password)
                             throws 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:

EcmException