com.lexmark.saperion.client.implementation.administration

Class UserClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.administration.UserClientImpl

All Implemented Interfaces:

UserClient

Direct Known Subclasses:

UserContextClientImpl

public class UserClientImpl
extends Object
implements UserClient

This is the default implementation of UserClient.

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
UserClientImpl(com.lexmark.saperion.administration.UserManagementService userManagementService, com.lexmark.saperion.administration.UserReferenceType userReference)

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the user.
void	deleteExtension() This method deletes the schema-extension properties of the user.
void	expirePassword() This method makes the users password expire.
List<com.lexmark.saperion.administration.AclReferenceType>	getACLs() This method returns the ACLs currently set on the user.
Date	getPasswordExpiration() This method gets the date when the users password will expire or null if the password never expires.
com.lexmark.saperion.administration.ExtensionPropertiesType	getSchemaExtension() This method returns the schema-extension properties of the user.
com.lexmark.saperion.administration.UserType	load() This method loads the user entity from the user management system.
void	setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension) This method sets the schema-extension properties of the user.
void	undelete() This method un-deletes the user.
void	update(com.lexmark.saperion.administration.UserPropertiesType properties) This method updates the referenced user with the given properties.
void	updatePassword(String password) This method updates the password of the user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lexmark.saperion.client.administration.UserClient

getExtension, setExtension

Constructor Detail

UserClientImpl

public UserClientImpl(com.lexmark.saperion.administration.UserManagementService userManagementService,
                      com.lexmark.saperion.administration.UserReferenceType userReference)

Method Detail

delete

public void delete()
            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method deletes the user.

Specified by:

delete in interface UserClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

undelete

public void undelete()
              throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method un-deletes the user.

Specified by:

undelete in interface UserClient

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

load

public com.lexmark.saperion.administration.UserType load()
                                                  throws com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException,
                                                         com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method loads the user entity from the user management system. If the user exists the corresponding user entity is returned. Otherwise an exception is thrown.

Specified by:

load in interface UserClient

Returns:

the referenced user entity

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

com.lexmark.saperion.exceptions.runtime.ResourceNotFoundException

update

public void update(com.lexmark.saperion.administration.UserPropertiesType properties)
            throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method updates the referenced user with the given properties.

Specified by:

update in interface UserClient

Parameters:

properties - the properties to change

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

updatePassword

public void updatePassword(String password)
                    throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method updates the password of the user.

Specified by:

updatePassword in interface UserClient

Parameters:

password - the password of the user

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

getPasswordExpiration

public Date getPasswordExpiration()
                           throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

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

Specified by:

getPasswordExpiration in interface UserClient

Returns:

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

Throws:

com.lexmark.saperion.exceptions.EcmException

expirePassword

public void expirePassword()
                    throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method makes the users password expire.

Specified by:

expirePassword in interface UserClient

Throws:

com.lexmark.saperion.exceptions.EcmException

setSchemaExtension

public void setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
                        throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method sets the schema-extension properties of the user. Note that only non-null values will be updated when a schema-extension already exists.

Specified by:

setSchemaExtension in interface UserClient

Parameters:

extension - schema-extension properties

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

getSchemaExtension

public com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension()
                                                                               throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method returns the schema-extension properties of the user.

Specified by:

getSchemaExtension in interface UserClient

Returns:

schema-extension properties of the user

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

deleteExtension

public void deleteExtension()
                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

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

Specified by:

deleteExtension in interface UserClient

Throws:

com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted

getACLs

public List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                                   throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: UserClient

This method returns the ACLs currently set on the user.

Specified by:

getACLs in interface UserClient

Returns:

the ACLs currently set on the user

Throws:

com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed