de.innovationgate.webgate.api.auth

Class FileAuthenticationModule

java.lang.Object

de.innovationgate.webgate.api.auth.FileAuthenticationModule

All Implemented Interfaces:

AuthenticationModule, PasswordCachingAuthenticationModule

public class FileAuthenticationModule
extends java.lang.Object
implements AuthenticationModule, PasswordCachingAuthenticationModule

This authentication module takes an XML file as base where users and groups are defined:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_FILE Creation option to specify the XML config file location.
static java.lang.String	AUTHMODULE_KEY
static org.apache.log4j.Logger	LOG
static java.lang.String	SYSPROPERTY_AUTH_FOLDER Sysproperty to specify a base path for XML config files.

Fields inherited from interface de.innovationgate.webgate.api.auth.AuthenticationModule

QUERY_USER_DN, QUERY_USERS_AND_GROUPS, USERLABEL_COMMONNAME

Constructor Summary

Constructors

Constructor and Description
FileAuthenticationModule()

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.
void	dropPasswordCache(java.lang.String loginName) Tells the authentication module to drop the password cache for the given login name.
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 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	isPoolable()
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

Methods inherited from class java.lang.Object

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

Field Detail

AUTHMODULE_KEY

public static final java.lang.String AUTHMODULE_KEY

See Also:

Constant Field Values

LOG

public static final org.apache.log4j.Logger LOG

SYSPROPERTY_AUTH_FOLDER

public static final java.lang.String SYSPROPERTY_AUTH_FOLDER

Sysproperty to specify a base path for XML config files.

See Also:

Constant Field Values

AUTH_FILE

public static final java.lang.String AUTH_FILE

Creation option to specify the XML config file location. If sysproperty de.innovationgate.wga.auth.folder is set, this is evaluated relative to it.

See Also:

Constant Field Values

Constructor Detail

FileAuthenticationModule

public FileAuthenticationModule()

Method Detail

init

public void init(java.util.Map params,
        WGDatabase db)
          throws ConfigurationException

Description copied from interface: AuthenticationModule

Called when the Authentication module is created, providing additional information

Specified by:

init in interface AuthenticationModule

Parameters:

params - Configuration parameters for the module

db - The db that this module is bound to

Throws:

ConfigurationException

login

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

Description copied from interface: AuthenticationModule

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

Specified by:

login in interface AuthenticationModule

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

clearCache

public void clearCache()

Description copied from interface: AuthenticationModule

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

Specified by:

clearCache in interface AuthenticationModule

getAuthenticationSource

public java.lang.String getAuthenticationSource()

Description copied from interface: AuthenticationModule

Descriptive string representation of the used authentication source

Specified by:

getAuthenticationSource in interface AuthenticationModule

getEMailAddress

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

Description copied from interface: AuthenticationModule

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

Specified by:

getEMailAddress in interface AuthenticationModule

Parameters:

user - The user

Returns:

The users E-Mail address

isPoolable

public boolean isPoolable()

addAuthenticationSourceListener

public void addAuthenticationSourceListener(AuthenticationSourceListener listener)

Description copied from interface: AuthenticationModule

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.

Specified by:

addAuthenticationSourceListener in interface AuthenticationModule

removeAuthenticationSourceListener

public void removeAuthenticationSourceListener(AuthenticationSourceListener listener)

Description copied from interface: AuthenticationModule

Removes an authentication source listener from the list of listeners

Specified by:

removeAuthenticationSourceListener in interface AuthenticationModule

getAllowedCredentialClasses

public java.lang.Class[] getAllowedCredentialClasses()

Description copied from interface: AuthenticationModule

Returns the classes that are allowed as credentials for this module

Specified by:

getAllowedCredentialClasses in interface AuthenticationModule

isQueryable

public boolean isQueryable(java.lang.String queryType)

Description copied from interface: AuthenticationModule

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

Specified by:

isQueryable in interface AuthenticationModule

query

public java.lang.Object query(java.lang.Object query,
                     java.lang.String queryType)

Description copied from interface: AuthenticationModule

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.

Specified by:

query in interface AuthenticationModule

destroy

public void destroy()

Description copied from interface: AuthenticationModule

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

Specified by:

destroy in interface AuthenticationModule

isGeneratesSessionToken

public boolean isGeneratesSessionToken()

Description copied from interface: AuthenticationModule

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

Specified by:

isGeneratesSessionToken in interface AuthenticationModule

dropPasswordCache

public void dropPasswordCache(java.lang.String loginName)

Description copied from interface: PasswordCachingAuthenticationModule

Tells the authentication module to drop the password cache for the given login name. Note that this not neccessarily needs to be the distinguished name, as it is the name which the user entered for a login.

Specified by:

dropPasswordCache in interface PasswordCachingAuthenticationModule