org.geomajas.security

Class Authentication

java.lang.Object

org.geomajas.security.Authentication

All Implemented Interfaces:

UserInfo

@Api(allMethods=true)
public class Authentication
extends Object
implements UserInfo

Success object which is returned on successful authentication by the SecurityManager. It contains some information about the authenticated user (all optional), and the authorization objects.

Since:

1.6.0

Author:

Joachim Van der Auwera

Constructor Summary

Constructors

Constructor and Description
Authentication()

Method Summary

Methods

Modifier and Type	Method and Description
BaseAuthorization[]	getAuthorizations() Get array of authorizations which apply for the user.
long	getExtendValid() Get the period (in ms) by which the validity of the authentication is extended when it is accessed.
Date	getInvalidAfter() Get final deadline for the validity of this authentication.
String	getSecurityServiceId() Get the id of the SecurityService which created this authentication.
String	getUserDivision() Get the organization's division for the user.
String	getUserId() Get the user id if known.
Locale	getUserLocale() Get the users locale if known.
String	getUserName() Get the users name if known.
String	getUserOrganization() Set the organization for the user.
Date	getValidUntil() Get deadline for validity of the authentication.
void	setAuthorizations(BaseAuthorization[] authorizations) Set the Authorizations which apply for this authentication.
void	setExtendValid(long extendValid) Set the period (in ms) by which the validity of the authentication is extended when it is accessed.
void	setInvalidAfter(Date invalidAfter) Set the final deadline for the validity of the authentication.
void	setSecurityServiceId(String securityServiceId) Set the id of the SecurityService which created this authentication.
void	setUserDivision(String userDivision) Get the division of the users organization if known.
void	setUserId(String userId) Set the user id.
void	setUserLocale(Locale userLocale) Set the locale for the user.
void	setUserName(String userName) Set the user name.
void	setUserOrganization(String userOrganization) Get the organization for the user if known.
void	setValidUntil(Date validUntil) Set deadline for validity of the authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

Authentication

public Authentication()

Method Detail

getSecurityServiceId

public String getSecurityServiceId()

Get the id of the SecurityService which created this authentication.

It is not required that this is set by the authentication service. The authentication manager will set this itself.

Returns:

id of the security service which created this authentication

setSecurityServiceId

public void setSecurityServiceId(String securityServiceId)

Set the id of the SecurityService which created this authentication.

It is not required that this is set by the authentication service. The authentication manager will set this itself.

Parameters:

securityServiceId - id of the security service which created this authentication

getValidUntil

public Date getValidUntil()

Get deadline for validity of the authentication.

This is used for possible caching of the authentication result.

It is not required that this is set by the authentication service. The authentication manager will set this itself if "extendValid" is set. If neither is set, the authentication is rechecked on each attempt to create the SecurityContext.

Returns:

timestamp until when the authtication may be cached

setValidUntil

public void setValidUntil(Date validUntil)

Set deadline for validity of the authentication.

This can be used by the security manager for possible caching of the authentication result.

It is not required that this is set by the authentication service. The authentication manager will set this itself if "extendValid" is set. If neither is set, the authentication is rechecked on each attempt to create the SecurityContext.

Parameters:

validUntil - deadline until which the authentication is valid

getInvalidAfter

public Date getInvalidAfter()

Get final deadline for the validity of this authentication.

On each attempt to check the validity of the authentication, the cached valued is searched first. This is used as long as validUntil is not expired. At that time, validUntil is also update to "min(max(xalidUntil, now()+extendValid), invalidAfter)".

Returns:

final timestamp, validUntil can not be extended beyond this

setInvalidAfter

public void setInvalidAfter(Date invalidAfter)

Set the final deadline for the validity of the authentication.

On each attempt to check the validity of the authentication, the cached valued is searched first. This is used as long as validUntil is not expired. At that time, validUntil is also update to "min(max(xalidUntil, now()+extendValid), invalidAfter)".

Parameters:

invalidAfter - final deadline for the validity of this authentication

getExtendValid

public long getExtendValid()

Get the period (in ms) by which the validity of the authentication is extended when it is accessed.

This can never extend the validity beyond the timestamp in invalidAfter.

Returns:

number of ms to extend validUntil when authentication is accessed

setExtendValid

public void setExtendValid(long extendValid)

Set the period (in ms) by which the validity of the authentication is extended when it is accessed.

This can never extend the validity beyond the timestamp in invalidAfter.

Parameters:

extendValid - the period (in ms) by which the validity of the authentication is extended when it is accessed

getUserId

public String getUserId()

Get the user id if known.

Specified by:

getUserId in interface UserInfo

Returns:

user id

setUserId

public void setUserId(String userId)

Set the user id. This value is optional and may be null.

Parameters:

userId - user id or null when not known

getUserName

public String getUserName()

Get the users name if known.

Specified by:

getUserName in interface UserInfo

Returns:

name of user or null when not known

setUserName

public void setUserName(String userName)

Set the user name. This value is optional and may be null.

Parameters:

userName - full name of user or null when not known

getUserLocale

public Locale getUserLocale()

Get the users locale if known.

Specified by:

getUserLocale in interface UserInfo

Returns:

locale for the user or null when not known

setUserLocale

public void setUserLocale(Locale userLocale)

Set the locale for the user. This value is optional and may be null.

Parameters:

userLocale - locale for the user or null when not known

getUserOrganization

public String getUserOrganization()

Set the organization for the user. This value is optional and may be null.

Specified by:

getUserOrganization in interface UserInfo

Returns:

organization for the user or null when not known

setUserOrganization

public void setUserOrganization(String userOrganization)

Get the organization for the user if known.

Parameters:

userOrganization - organization for the user or null when not known

getUserDivision

public String getUserDivision()

Get the organization's division for the user. This value is optional and may be null.

Specified by:

getUserDivision in interface UserInfo

Returns:

organizational division for the user or null when not known

setUserDivision

public void setUserDivision(String userDivision)

Get the division of the users organization if known.

Parameters:

userDivision - organizational division for the user or null when not known

getAuthorizations

public BaseAuthorization[] getAuthorizations()

Get array of authorizations which apply for the user. In many cases there is one object for each role. A union is used to combine these authorizations (and any other which may apply for the authentication token).

Returns:

array of BaseAuthorization objects

setAuthorizations

public void setAuthorizations(BaseAuthorization[] authorizations)

Set the Authorizations which apply for this authentication.

Parameters:

authorizations - array of authentications