de.innovationgate.webgate.api.auth

Class DefaultAuthModuleFactory

java.lang.Object

de.innovationgate.webgate.api.auth.DefaultAuthModuleFactory

All Implemented Interfaces:

AuthModuleFactory

public class DefaultAuthModuleFactory
extends java.lang.Object
implements AuthModuleFactory

Default implementation of an auth module factory. The auth module factory creates authentication modules based on auth module names.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SYSPROPERTY_AUTH_MAPPING System property prefix by which Auth module implementations can be mapped to a short name, usable in "auth.module".

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

COPTION_AUTH_MODULE

Constructor Summary

Constructors

Constructor and Description
DefaultAuthModuleFactory()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Should clear all caches of this auth module factory, so all resources are freed
AuthenticationModule	getAuthModule(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> settings, WGDatabase db) Retrieves an authentication module of the given type and for the given settings.

Methods inherited from class java.lang.Object

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

Field Detail

SYSPROPERTY_AUTH_MAPPING

public static final java.lang.String SYSPROPERTY_AUTH_MAPPING

System property prefix by which Auth module implementations can be mapped to a short name, usable in "auth.module". The property name is to be completed by the short name. The property value must be the implementation class name

See Also:

Constant Field Values

Constructor Detail

DefaultAuthModuleFactory

public DefaultAuthModuleFactory()

Method Detail

getAuthModule

public AuthenticationModule getAuthModule(java.lang.String type,
                                 java.util.Map<java.lang.String,java.lang.String> settings,
                                 WGDatabase db)
                                   throws ConfigurationException

Description copied from interface: AuthModuleFactory

Retrieves an authentication module of the given type and for the given settings.

Specified by:

getAuthModule in interface AuthModuleFactory

Parameters:

type - Type of module. Use constants AUTHMODULE_...

settings - The settings for this module

db - The database that this authentication source should be for

Throws:

ConfigurationException

clearCache

public void clearCache()

Description copied from interface: AuthModuleFactory

Should clear all caches of this auth module factory, so all resources are freed

Specified by:

clearCache in interface AuthModuleFactory