de.aristaflow.adept2.core.orgmodelmanager

Interface ClientAdministration

public interface ClientAdministration

The client administration interface allows controlled access to data in the organisational model, thus allowing end-user to easily change their own data. It is a convenient wrapper interface for ModelChangeOperations.

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
RichAgent	changeMailAddress(SessionToken session, java.lang.String mailAddress) Changes the mail address of the user identified by the session token.
void	changePassword(SessionToken session, java.lang.String oldPassword, java.lang.String newPassword) This method changes the password of the user identified by the session token.
RichAgent	changePreferredLocale(SessionToken session, java.util.Locale locale) Changes the preferred locale of the user identified by the session token.
java.lang.String	getMailAddress(SessionToken session) Returns the current mail address of the user identified by the session token.
java.util.Locale	getPreferredLocale(SessionToken session) Returns the current preferred locale of the user identified by the session token.

Method Detail

changePassword

void changePassword(SessionToken session,
                    java.lang.String oldPassword,
                    java.lang.String newPassword)
             throws AuthenticationException,
                    PasswordPolicyException,
                    DataSourceException

This method changes the password of the user identified by the session token. The old password is needed for security reasons, for instance, to prevent changes by unauthorised persons when logged in.

Parameters:

session - The session token identifying the user to change the password of and the session for the change process.

oldPassword - The old password of the user.

newPassword - The new password to set.

Throws:

AuthenticationException - If the old password is incorrect, an AuthenticationException will be thrown.

PasswordPolicyException - If the new password doesn't comply to one or more password policies, a PasswordPolicyException will be thrown.

DataSourceException - If an an unrecoverable error occurs while accessing the data source containing the username and the passwords, a DataSourceException will be thrown.

getMailAddress

java.lang.String getMailAddress(SessionToken session)
                         throws DataSourceException

Returns the current mail address of the user identified by the session token.

Parameters:

session - The session token identifying the user to get the mail address of.

Returns:

The current mail address of the user identified by the session token or null in case the user does not have a mail address.

Throws:

DataSourceException - If an error occurs while accessing the data source, a DataSourceException will be thrown.

changeMailAddress

RichAgent changeMailAddress(SessionToken session,
                            java.lang.String mailAddress)
                     throws DataSourceException

Changes the mail address of the user identified by the session token. The mail address is used for notifying the user, for instance when the mail notification for the worklist is set.

Parameters:

session - The session token identifying the user to change the mail address of.

mailAddress - The new mail address of the designated user.

Returns:

The agent object containing the set mail address.

Throws:

DataSourceException - If an error occurs while accessing the data source, a DataSourceException will be thrown.

getPreferredLocale

java.util.Locale getPreferredLocale(SessionToken session)
                             throws DataSourceException

Returns the current preferred locale of the user identified by the session token.

Parameters:

session - The session token identifying the user to get the preferred locale.

Returns:

The current preferred locale of the user identified by the session token or null in case the user does not have a preferred locale.

Throws:

DataSourceException - If an error occurs while accessing the data source, a DataSourceException will be thrown.

changePreferredLocale

RichAgent changePreferredLocale(SessionToken session,
                                java.util.Locale locale)
                         throws DataSourceException

Changes the preferred locale of the user identified by the session token. This locale is used for the clients the user logs on to - if it is available on this client. Otherwise the client falls back to its default locale

Parameters:

session - The session token identifying the user to change the preferred locale.

locale - The locale the designated user prefers. null can be used to reset the preferred locale.

Returns:

The agent object containing the locale.

Throws:

DataSourceException - If an error occurs while accessing the data source, a DataSourceException will be thrown.