com.lexmark.saperion.administration

Interface UserManagementService

public interface UserManagementService

The user management service provides the required operations to create, read, update and delete user entities in the user management system.

Author:

owaeldrich

Method Summary

Modifier and Type	Method and Description
UserReferenceType	createUser(CreateUserPropertiesType properties) Creates a new user entity with the given properties in the current user's tenant.
void	deleteSchemaExtension(UserReferenceType user) This method deletes the schema-extension of the given user.
void	deleteUser(UserReferenceType reference) Deletes the referenced user.
void	expirePassword(UserReferenceType user) This method makes the users password expire.
List<AclReferenceType>	getACLs(UserReferenceType reference) This method returns the ACLs set on the referenced user.
Date	getPasswordExpiration(UserReferenceType user) This method gets the date when the users password will expire or null if the password never expires.
Map<String,PropertyType>	getSchemaExtension(UserReferenceType user) This method returns the schema-extension for the given user.
List<GroupListItemType>	loadGroups(UserReferenceType reference) This method returns the groups the given user is a member of.
UserType	loadUser(UserReferenceType reference) Load the user entity identified by the given user reference from the user management system.
UserType	loadUserByName(String userName) This method loads a user given by name.
SearchExecutionService<UserListItemType>	newTenantDeletedUserSearchService() This method returns a new search execution service that lists all deleted users of the current user's tenant.
SearchExecutionService<UserListItemType>	newTenantUserSearchService() This method returns a new search execution service that lists all users of the current user's tenant.
void	setSchemaExtension(UserReferenceType user, Map<String,PropertyType> schemaExtension) This method stores the given schema-extension for the given user.
void	undeleteUser(UserReferenceType reference) Un-deletes the referenced user.
void	updateUser(UserReferenceType reference, UserPropertiesType properties) Updates the referenced user with the given properties.
void	updateUserPassword(UserReferenceType reference, String password) Updates the referenced user with the given properties.

Method Detail

createUser

UserReferenceType createUser(CreateUserPropertiesType properties)
                      throws EcmException

Creates a new user entity with the given properties in the current user's tenant. Upon successful user creation the system returns a reference to the new created entity.

Parameters:

properties - the properties of the user

Returns:

reference to the new created user entity

Throws:

SystemException - indicates that a system exception occurred

EcmException

deleteUser

void deleteUser(UserReferenceType reference)
         throws EcmException

Deletes the referenced user.

Parameters:

reference - the user reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

undeleteUser

void undeleteUser(UserReferenceType reference)
           throws EcmException

Un-deletes the referenced user.

Parameters:

reference - the user reference

Throws:

SystemException - indicates that a system exception occurred

EcmException

newTenantUserSearchService

SearchExecutionService<UserListItemType> newTenantUserSearchService()
                                                             throws EcmException

This method returns a new search execution service that lists all users of the current user's tenant.

Returns:

a new SearchExecutionService

Throws:

EcmException - indicates that a system exception occurred

newTenantDeletedUserSearchService

SearchExecutionService<UserListItemType> newTenantDeletedUserSearchService()
                                                                    throws EcmException

This method returns a new search execution service that lists all deleted users of the current user's tenant.

Returns:

a list of all deleted users of the tenant

Throws:

EcmException - indicates that a system exception occurred

loadGroups

List<GroupListItemType> loadGroups(UserReferenceType reference)
                            throws ResourceNotFoundException,
                                   EcmException

This method returns the groups the given user is a member of.

Parameters:

reference - the user reference

Returns:

a list with the groups the user is a member of

Throws:

ResourceNotFoundException - the referenced user does not exist in the backend system

SystemException - indicated that a system exception hat occurred

EcmException

loadUser

UserType loadUser(UserReferenceType reference)
           throws ResourceNotFoundException,
                  EcmException

Load the user entity identified by the given user reference from the user management system. If the user exists the corresponding user entity is returned. Otherwise an exception is thrown.

Parameters:

reference - the user entity reference

Returns:

the referenced user entity

Throws:

ResourceNotFoundException - the referenced user does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

updateUser

void updateUser(UserReferenceType reference,
                UserPropertiesType properties)
         throws EcmException

Updates the referenced user with the given properties.

Parameters:

reference - the user reference

properties - the properties to change

Throws:

ResourceNotFoundException - the referenced user does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

updateUserPassword

void updateUserPassword(UserReferenceType reference,
                        String password)
                 throws EcmException

Updates the referenced user with the given properties.

Parameters:

reference - the user reference

password - the password of the user

Throws:

ResourceNotFoundException - the referenced user does not exist in the backend system

SystemException - indicates that a system exception occurred

EcmException

loadUserByName

UserType loadUserByName(String userName)
                 throws EcmException

This method loads a user given by name.

Parameters:

userName - the name of the user to load

Returns:

the user with the given name

Throws:

EcmException - indicates that a system exception occurred

getSchemaExtension

Map<String,PropertyType> getSchemaExtension(UserReferenceType user)
                                     throws EcmException

This method returns the schema-extension for the given user.

Parameters:

user - the user

Returns:

the schema-extension of the user

Throws:

EcmException

setSchemaExtension

void setSchemaExtension(UserReferenceType user,
                        Map<String,PropertyType> schemaExtension)
                 throws EcmException

This method stores the given schema-extension for the given user. Note that only non-null values will be updated when a schema-extension already exists.

Parameters:

user - the user

schemaExtension - the schema-extension to store

Throws:

EcmException

deleteSchemaExtension

void deleteSchemaExtension(UserReferenceType user)
                    throws EcmException

This method deletes the schema-extension of the given user.

Parameters:

user - the user

Throws:

EcmException - when deleting the schema-extension failed

getPasswordExpiration

Date getPasswordExpiration(UserReferenceType user)
                    throws EcmException

This method gets the date when the users password will expire or null if the password never expires.

Parameters:

user - a reference to the user

Returns:

the date when the users password will expire or null if the password never expires

Throws:

EcmException

expirePassword

void expirePassword(UserReferenceType user)
             throws EcmException

This method makes the users password expire.

Parameters:

user - the user whose password is to expire.

Throws:

EcmException

getACLs

List<AclReferenceType> getACLs(UserReferenceType reference)
                        throws EcmException

This method returns the ACLs set on the referenced user.

Parameters:

reference - a reference to the user

Returns:

a list of ACLs set on the user

Throws:

EcmException - when loading the ACLs failed