de.innovationgate.webgate.api.auth

Interface AuthModuleFactory

All Known Implementing Classes:

DefaultAuthModuleFactory

public interface AuthModuleFactory

Interface for a factory creating auth modues

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPTION_AUTH_MODULE Creation option for databases that is used to determine the used auth modude.

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.

Field Detail

COPTION_AUTH_MODULE

static final java.lang.String COPTION_AUTH_MODULE

Creation option for databases that is used to determine the used auth modude.

See Also:

Constant Field Values

Method Detail

getAuthModule

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

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

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

void clearCache()

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