de.tif.jacob.security
Interface IUser

public interface IUser

User interface, which has to be implemented by an application developer to provide application specific user information.

Field Summary

static java.lang.String	RCS_ID The internal revision control system id.
static java.lang.String	RCS_REV The internal revision control system id in short form.

Method Summary

java.lang.String	getCellPhone() Returns the cell phone number of this user.
java.lang.String	getEMail() Returns the email address of this user.
java.lang.String	getFax() Returns the fax number of this user.
java.lang.String	getFullName() Returns the full name of this user.
java.lang.String	getKey() Returns the unique id of this user.
java.util.Locale	getLocale() The preferred language, i.e. locale, of this user.
java.lang.String	getLoginId() Returns the login id of this user.
java.lang.String	getMandatorId() Returns the mandator id of this user.
java.lang.String	getPhone() Returns the phone number of this user.
java.lang.Object	getProperty(java.lang.String key) Retrieve a property value from the underlying user session.
IRole	getRole(java.lang.String roleName) Returns the role object for the given role name.
java.util.Iterator	getRoles() Returns all roles of this user.
int	getTimezoneOffset() The timezone offset of the client to the jACOB server in minutes
boolean	hasOneRoleOf(java.util.List roleNames) Checks whether this user obtains one of the given roles.
boolean	hasRole(java.lang.String roleName) Checks whether this user has the given role.
boolean	isSystem() Checks whether the given user is a system user or a real user.
void	setPassword(java.lang.String password) Changes the password of this user.
void	setProperty(java.lang.String key, java.lang.Object value) Sets a property value within the underlying user session.

Field Detail

RCS_ID

static final java.lang.String RCS_ID

The internal revision control system id.

See Also:

Constant Field Values

RCS_REV

static final java.lang.String RCS_REV

The internal revision control system id in short form.

See Also:

Constant Field Values

Method Detail

getLoginId

java.lang.String getLoginId()

Returns the login id of this user.

Returns:

the login id of this user

getMandatorId

java.lang.String getMandatorId()

Returns the mandator id of this user.

Returns:

the mandator id of this user if existing, otherwise null

getLocale

java.util.Locale getLocale()

The preferred language, i.e. locale, of this user.

Returns:

The preferred locale of this user.

getTimezoneOffset

int getTimezoneOffset()

The timezone offset of the client to the jACOB server in minutes

Returns:

The timezone offset of the client to the jACOB server in minutes

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)

Sets a property value within the underlying user session.

Parameters:

key - the property key

value - the property value

getProperty

java.lang.Object getProperty(java.lang.String key)

Retrieve a property value from the underlying user session.

Parameters:

key - the property key

Returns:

the property value or null, if no value exists for this property so far

setPassword

void setPassword(java.lang.String password)
                 throws InvalidNewPasswordException,
                        java.lang.Exception

Changes the password of this user.

Parameters:

password - the new password to set

Throws:

InvalidNewPasswordException - the password is not valid

java.lang.Exception - any other problem

isSystem

boolean isSystem()

Checks whether the given user is a system user or a real user.

Returns:

true if system user, false if real user.

getKey

java.lang.String getKey()

Returns the unique id of this user.

Returns:

the unique id of the user

getFullName

java.lang.String getFullName()

Returns the full name of this user.

Returns:

the fullname of this user

getEMail

java.lang.String getEMail()

Returns the email address of this user.

Returns:

The email address of the user or null if not existing.

getPhone

java.lang.String getPhone()

Returns the phone number of this user.

Returns:

The phone number of the user or null if not existing.

getCellPhone

java.lang.String getCellPhone()

Returns the cell phone number of this user.

Returns:

The cell phone number of the user or null if not existing.

getFax

java.lang.String getFax()

Returns the fax number of this user.

Returns:

The fax number of the user or null if not existing.

hasRole

boolean hasRole(java.lang.String roleName)
                throws java.security.GeneralSecurityException

Checks whether this user has the given role.

Parameters:

roleName - the name of the role to check.

Returns:

true if this user has the given role, otherwise false

Throws:

java.security.GeneralSecurityException - any security concern

hasOneRoleOf

boolean hasOneRoleOf(java.util.List roleNames)
                     throws java.security.GeneralSecurityException

Checks whether this user obtains one of the given roles.

Parameters:

roleNames - a list of role names (String)

Returns:

true if this user obtains at least one of the given roles, false otherwise.

Throws:

java.security.GeneralSecurityException

getRole

IRole getRole(java.lang.String roleName)
              throws java.security.GeneralSecurityException

Returns the role object for the given role name.

Parameters:

roleName - the role name

Returns:

the desired role object

Throws:

java.security.GeneralSecurityException - if the role object of this user could not be fetched.

getRoles

java.util.Iterator getRoles()
                            throws java.security.GeneralSecurityException

Returns all roles of this user.

Returns:

The roles, i.e. Iterator of IRole.

Throws:

java.security.GeneralSecurityException - if the roles of this user could not be fetched.