de.innovationgate.webgate.api.auth

Class BackendAuthSession

java.lang.Object

de.innovationgate.webgate.api.auth.BackendAuthSession

All Implemented Interfaces:

AuthenticationSession

public class BackendAuthSession
extends java.lang.Object
implements AuthenticationSession

An authentication session that needs to be authenticated in the WGAPI backend implementation. This is given to WGDatabaseCore.openSession(AuthenticationSession, Object, boolean) when the database has no authentication module configured. The WGAPI implementation may add authentication data like groups, mail address etc. to this object's data.

Constructor Summary

Constructors

Constructor and Description
BackendAuthSession(java.lang.String username, java.lang.Object credentials)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDistinguishedName() Returns the distinguished, fully qualified, unique name of the user
java.util.Set	getGroups() Returns the user groups that the user is member of
java.lang.String	getMailAddress() Returns the e-mail address of the user if known
java.util.Set	getNames() Returns all known name variants/aliases of the user
java.lang.String	getSessionToken() May return a session token as Single sign-on information
boolean	isValid() Returns if this session object is still valid
void	logout() Closes the authentication session making this object invalid
void	setMailAddress(java.lang.String mailAddress) Set the mail address of the session user
void	setSessionToken(java.lang.String sessionToken) Set a session token of the session
void	setValid(boolean valid) Set if this session is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendAuthSession

public BackendAuthSession(java.lang.String username,
                  java.lang.Object credentials)

Method Detail

getDistinguishedName

public java.lang.String getDistinguishedName()

Description copied from interface: AuthenticationSession

Returns the distinguished, fully qualified, unique name of the user

Specified by:

getDistinguishedName in interface AuthenticationSession

getGroups

public java.util.Set getGroups()

Description copied from interface: AuthenticationSession

Returns the user groups that the user is member of

Specified by:

getGroups in interface AuthenticationSession

getMailAddress

public java.lang.String getMailAddress()

Description copied from interface: AuthenticationSession

Returns the e-mail address of the user if known

Specified by:

getMailAddress in interface AuthenticationSession

getNames

public java.util.Set getNames()

Description copied from interface: AuthenticationSession

Returns all known name variants/aliases of the user

Specified by:

getNames in interface AuthenticationSession

getSessionToken

public java.lang.String getSessionToken()

Description copied from interface: AuthenticationSession

May return a session token as Single sign-on information

Specified by:

getSessionToken in interface AuthenticationSession

isValid

public boolean isValid()

Description copied from interface: AuthenticationSession

Returns if this session object is still valid

Specified by:

isValid in interface AuthenticationSession

logout

public void logout()

Description copied from interface: AuthenticationSession

Closes the authentication session making this object invalid

Specified by:

logout in interface AuthenticationSession

setValid

public void setValid(boolean valid)

Set if this session is valid

setMailAddress

public void setMailAddress(java.lang.String mailAddress)

Set the mail address of the session user

setSessionToken

public void setSessionToken(java.lang.String sessionToken)

Set a session token of the session