de.innovationgate.webgate.api.auth

Interface AuthenticationModule

All Known Implementing Classes:

FileAuthenticationModule, RedirectionAuthModule

public interface AuthenticationModule

Interface for a generic authentication module, that authenticates user logins and provides some additional information about logged in users One authentication module is bound to a WGDatabase object.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	QUERY_USER_DN Query type fetching a specific user and group for a given distinguished name
static java.lang.String	QUERY_USERS_AND_GROUPS Query type that queries for users and groups
static java.lang.String	USERLABEL_COMMONNAME A predefined, yet optional labeled name denoting a display name for the user that is easy on the eye

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticationSourceListener(AuthenticationSourceListener listener) Method to add a listener to authentication source events.
void	clearCache() Called to notify the module to drop authentication caches (if it uses them)
void	destroy() Called when an auth module is no longer needed.
java.lang.Class<?>[]	getAllowedCredentialClasses() Returns the classes that are allowed as credentials for this module
java.lang.String	getAuthenticationSource() Descriptive string representation of the used authentication source
java.lang.String	getEMailAddress(java.lang.String user) Tries to retrieve the E-Mail-Address of the given user.
void	init(java.util.Map<java.lang.String,java.lang.String> params, WGDatabase db) Called when the Authentication module is created, providing additional information
boolean	isGeneratesSessionToken() Determines if this auth module can create a session token that can be used for some kind of single sign-on architecture.
boolean	isQueryable(java.lang.String queryType) Determines, if this auth module supports queries of the given query type.
AuthenticationSession	login(java.lang.String user, java.lang.Object credentials) Called to verify a login.
java.lang.Object	query(java.lang.Object query, java.lang.String queryType) executes a query for authentication objects (users, groups etc.) and returns the result.
void	removeAuthenticationSourceListener(AuthenticationSourceListener listener) Removes an authentication source listener from the list of listeners

Field Detail

QUERY_USERS_AND_GROUPS

static final java.lang.String QUERY_USERS_AND_GROUPS

Query type that queries for users and groups

See Also:

Constant Field Values

QUERY_USER_DN

static final java.lang.String QUERY_USER_DN

Query type fetching a specific user and group for a given distinguished name

See Also:

Constant Field Values

USERLABEL_COMMONNAME

static final java.lang.String USERLABEL_COMMONNAME

A predefined, yet optional labeled name denoting a display name for the user that is easy on the eye

See Also:

Constant Field Values

Method Detail

init

void init(java.util.Map<java.lang.String,java.lang.String> params,
        WGDatabase db)
          throws ConfigurationException

Called when the Authentication module is created, providing additional information

Parameters:

params - Configuration parameters for the module

db - The db that this module is bound to

Throws:

ConfigurationException

login

AuthenticationSession login(java.lang.String user,
                          java.lang.Object credentials)
                            throws AuthenticationException

Called to verify a login. Returns a session object if it succeeds.

Parameters:

user - The user

credentials - The users credentials, f.e. a password

Returns:

An authentication session object if the login succeeds. null otherwise.

Throws:

AuthenticationException - If the login cannot be verified

getEMailAddress

java.lang.String getEMailAddress(java.lang.String user)

Tries to retrieve the E-Mail-Address of the given user.

Parameters:

user - The user

Returns:

The users E-Mail address

clearCache

void clearCache()

Called to notify the module to drop authentication caches (if it uses them)

getAuthenticationSource

java.lang.String getAuthenticationSource()

Descriptive string representation of the used authentication source

isGeneratesSessionToken

boolean isGeneratesSessionToken()

Determines if this auth module can create a session token that can be used for some kind of single sign-on architecture.

addAuthenticationSourceListener

void addAuthenticationSourceListener(AuthenticationSourceListener listener)

Method to add a listener to authentication source events. These events may get fired by the auth module when authentication data changes, so that listeners can clear their cache. Authentication modules are not obliged to throw those events.

removeAuthenticationSourceListener

void removeAuthenticationSourceListener(AuthenticationSourceListener listener)

Removes an authentication source listener from the list of listeners

getAllowedCredentialClasses

java.lang.Class<?>[] getAllowedCredentialClasses()

Returns the classes that are allowed as credentials for this module

isQueryable

boolean isQueryable(java.lang.String queryType)

Determines, if this auth module supports queries of the given query type.

query

java.lang.Object query(java.lang.Object query,
                     java.lang.String queryType)
                       throws WGQueryException

executes a query for authentication objects (users, groups etc.) and returns the result. While there is no general contract for the form of the result it should consist of a List of UserGroupInfo objects, so the result can be processed in a platform independent manner. Use constants QUERY_... to specify query type.

Throws:

WGQueryException

destroy

void destroy()

Called when an auth module is no longer needed. Should return all resources