de.innovationgate.wgpublisher.auth

Class CSAuthModule

java.lang.Object

de.innovationgate.wgpublisher.auth.CSAuthModule

All Implemented Interfaces:

de.innovationgate.webgate.api.auth.AuthenticationModule, de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule, de.innovationgate.webgate.api.WGContentEventListener, CoreAwareAuthModule, WGACoreEventListener, WGACoreListener, java.util.EventListener

Direct Known Subclasses:

PluginAuthModule

public class CSAuthModule
extends java.lang.Object
implements CoreAwareAuthModule, de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule, WGACoreEventListener, de.innovationgate.webgate.api.WGContentEventListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CSAuthModule.AuthCollector
static class	CSAuthModule.AuthCollectorRunOccasion
class	CSAuthModule.CSLazyGroupMembershipResolver
class	CSAuthModule.CSPreloadGroupMembershipResolver
class	CSAuthModule.GroupMembership
class	CSAuthModule.LazyLoginLoader
class	CSAuthModule.LazyLoginSearcher

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,Group>	_groupInformation
static int	COLLECT_LAZY_CACHESIZE_DEFAULT
static java.lang.String	COLLECTMODE_LAZY
static java.lang.String	COLLECTMODE_PRELOAD
static java.lang.String	COPTION_ALIAS_ITEMS
static java.lang.String	COPTION_CA Filename of the CA to be used to verify clientcertificates
static java.lang.String	COPTION_CERTAUTH Enable certificate authentication
static java.lang.String	COPTION_COLLECT_CONDITION
static java.lang.String	COPTION_COLLECT_LAZY_CACHESIZE
static java.lang.String	COPTION_COLLECT_MODE
static java.lang.String	COPTION_COMMONNAME_EXPRESSION Determines a TMLScript expression by which to calculate the common name
static java.lang.String	COPTION_CRL Filename of the CRL for the given CA
static java.lang.String	COPTION_DBKEY
static java.lang.String	COPTION_GROUP_CONTENTCLASS
static java.lang.String	COPTION_ITEM_ALIASES
static java.lang.String	COPTION_ITEM_EMAIL
static java.lang.String	COPTION_ITEM_ENABLED
static java.lang.String	COPTION_ITEM_GROUPMEMBERS
static java.lang.String	COPTION_ITEM_GROUPNAME
static java.lang.String	COPTION_ITEM_PASSWORD
static java.lang.String	COPTION_ITEM_USERNAME
static java.lang.String	COPTION_LABELED_NAMES
static java.lang.String	COPTION_LOGIN_CONTENTCLASS
static java.lang.String	COPTION_ROOTDOC_GROUPS
static java.lang.String	COPTION_ROOTDOC_USERS
static java.lang.String	COPTION_SCRIPT_COLLECT
static java.lang.String	CSAUTH_PROPERTIES_FILE
static java.lang.String	DEFAULT_GROUPSROOT
static java.lang.String	DEFAULT_USERSROOT
static java.lang.String	DEFAULTITEM_EMAIL
static java.lang.String	DEFAULTITEM_ENABLED
static java.lang.String	DEFAULTITEM_GROUPNAME
static java.lang.String	DEFAULTITEM_MEMBERS
static java.lang.String	DEFAULTITEM_PASSWORD
static java.lang.String	DEFAULTITEM_USERALIASES
static java.lang.String	DEFAULTITEM_USERNAME
static org.apache.log4j.Logger	LOG
static int	STATUS_AUTHDB_PREPARED The database to take auth information from is known, prepared but not yet connected, so the auth module didn't yet collect login data
static int	STATUS_AUTHDB_UNKNOWN The database to take auth information from is yet unknown
static int	STATUS_READY The database to take auth information from is known and the login data has been fetched

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
CSAuthModule()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)
void	clearCache()
void	closeLazyCollectResources()
void	contentCreated(de.innovationgate.webgate.api.WGContentEvent contentEvent)
void	contentHasBeenDeleted(de.innovationgate.webgate.api.WGContentEvent event)
void	contentHasBeenMoved(de.innovationgate.webgate.api.WGContentEvent event)
void	contentHasBeenSaved(de.innovationgate.webgate.api.WGContentEvent event)
boolean	contentSaved(de.innovationgate.webgate.api.WGContentEvent contentEvent)
void	contentStatusChanged(de.innovationgate.webgate.api.WGContentEvent event)
void	contentStoreConnected(WGACoreEvent event) Called after a content store has been connected
void	contentStoreDisconnected(WGACoreEvent event) Called after a content store has been disconnected
void	destroy()
java.lang.String	getAliasesItem() returns the alias item name
java.lang.Class<?>[]	getAllowedCredentialClasses()
java.lang.String	getAuthenticationSource()
java.security.cert.X509Certificate	getCA() Returns the certificate authority for certificate authentication
java.lang.String	getCollectCondition() returns the collect condition
java.security.cert.X509CRL	getCRL() Returns the certificate revoke list for certificate authentication
java.lang.Thread	getCurrentCollectorThread()
java.lang.String	getDbkey() returns the dbkey of the authentication source
java.lang.String	getEMailAddress(java.lang.String user)
java.lang.String	getEmailItem() returns the email item name
java.lang.String	getEnabledItem() returns the enabled item name
java.lang.String	getGroupnameItem() returns the groupname item
java.lang.String	getGroupsRootDoc() returns the unique name of the root document for groups
de.innovationgate.webgate.api.WGStructEntryList	getGroupStructEntries(de.innovationgate.webgate.api.WGDatabase db, de.innovationgate.webgate.api.WGContent rootContent)
java.lang.String	getMembersItem() returns the members item name
java.lang.String	getPasswordItem() returns the password item name
java.lang.String	getScriptCollect() returns the script code for custom collection
int	getStatus()
java.lang.String	getUsernameItem() returns the username item
java.lang.String	getUserRootDoc() returns the unique name of the root document for users
void	init(java.util.Map<java.lang.String,java.lang.String> params, de.innovationgate.webgate.api.WGDatabase db)
boolean	isCertAuthEnabled()
boolean	isGeneratesSessionToken()
boolean	isPoolable()
boolean	isQueryable(java.lang.String queryType)
boolean	isTemporary()
de.innovationgate.webgate.api.auth.AuthenticationSession	login(java.lang.String user, java.lang.Object credentials)
de.innovationgate.webgate.api.auth.AuthenticationSession	login(java.security.cert.X509Certificate cert)
void	migrateMembershipsToRelations(org.apache.log4j.Logger log)
java.lang.Object	query(java.lang.Object query, java.lang.String queryType)
void	removeAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)
void	runAuthCollectorByEvent(de.innovationgate.webgate.api.WGContentEvent event)
void	setCore(WGACore core)
void	shutdownPostDisconnect(WGACoreEvent event) Called on WGA shutdown after databases haved been disconnected
void	shutdownPreDisconnect(WGACoreEvent event) Called on WGA shutdown before databases are disconnected
void	startupPostConnect(WGACoreEvent event) Called on WGA startup after databases have been connected
void	startupPreConnect(WGACoreEvent event) Called on WGA startup before databases are connected

Methods inherited from class java.lang.Object

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

Field Detail

COLLECT_LAZY_CACHESIZE_DEFAULT

public static final int COLLECT_LAZY_CACHESIZE_DEFAULT

See Also:

Constant Field Values

LOG

public static final org.apache.log4j.Logger LOG

DEFAULT_GROUPSROOT

public static final java.lang.String DEFAULT_GROUPSROOT

See Also:

Constant Field Values

DEFAULT_USERSROOT

public static final java.lang.String DEFAULT_USERSROOT

See Also:

Constant Field Values

STATUS_AUTHDB_UNKNOWN

public static final int STATUS_AUTHDB_UNKNOWN

The database to take auth information from is yet unknown

See Also:

Constant Field Values

STATUS_AUTHDB_PREPARED

public static final int STATUS_AUTHDB_PREPARED

The database to take auth information from is known, prepared but not yet connected, so the auth module didn't yet collect login data

See Also:

Constant Field Values

STATUS_READY

public static final int STATUS_READY

The database to take auth information from is known and the login data has been fetched

See Also:

Constant Field Values

_groupInformation

public java.util.Map<java.lang.String,Group> _groupInformation

COPTION_DBKEY

public static final java.lang.String COPTION_DBKEY

See Also:

Constant Field Values

COPTION_ROOTDOC_USERS

public static final java.lang.String COPTION_ROOTDOC_USERS

See Also:

Constant Field Values

COPTION_ROOTDOC_GROUPS

public static final java.lang.String COPTION_ROOTDOC_GROUPS

See Also:

Constant Field Values

COPTION_COLLECT_MODE

public static final java.lang.String COPTION_COLLECT_MODE

See Also:

Constant Field Values

COPTION_COLLECT_LAZY_CACHESIZE

public static final java.lang.String COPTION_COLLECT_LAZY_CACHESIZE

See Also:

Constant Field Values

COPTION_SCRIPT_COLLECT

public static final java.lang.String COPTION_SCRIPT_COLLECT

See Also:

Constant Field Values

COPTION_ITEM_USERNAME

public static final java.lang.String COPTION_ITEM_USERNAME

See Also:

Constant Field Values

COPTION_ITEM_GROUPNAME

public static final java.lang.String COPTION_ITEM_GROUPNAME

See Also:

Constant Field Values

COPTION_ITEM_GROUPMEMBERS

public static final java.lang.String COPTION_ITEM_GROUPMEMBERS

See Also:

Constant Field Values

COPTION_ITEM_PASSWORD

public static final java.lang.String COPTION_ITEM_PASSWORD

See Also:

Constant Field Values

COPTION_ITEM_ALIASES

public static final java.lang.String COPTION_ITEM_ALIASES

See Also:

Constant Field Values

COPTION_ALIAS_ITEMS

public static final java.lang.String COPTION_ALIAS_ITEMS

See Also:

Constant Field Values

COPTION_ITEM_EMAIL

public static final java.lang.String COPTION_ITEM_EMAIL

See Also:

Constant Field Values

COPTION_ITEM_ENABLED

public static final java.lang.String COPTION_ITEM_ENABLED

See Also:

Constant Field Values

COPTION_LABELED_NAMES

public static final java.lang.String COPTION_LABELED_NAMES

See Also:

Constant Field Values

COPTION_COLLECT_CONDITION

public static final java.lang.String COPTION_COLLECT_CONDITION

See Also:

Constant Field Values

COPTION_LOGIN_CONTENTCLASS

public static final java.lang.String COPTION_LOGIN_CONTENTCLASS

See Also:

Constant Field Values

COPTION_GROUP_CONTENTCLASS

public static final java.lang.String COPTION_GROUP_CONTENTCLASS

See Also:

Constant Field Values

DEFAULTITEM_EMAIL

public static final java.lang.String DEFAULTITEM_EMAIL

See Also:

Constant Field Values

DEFAULTITEM_USERALIASES

public static final java.lang.String DEFAULTITEM_USERALIASES

See Also:

Constant Field Values

DEFAULTITEM_PASSWORD

public static final java.lang.String DEFAULTITEM_PASSWORD

See Also:

Constant Field Values

DEFAULTITEM_USERNAME

public static final java.lang.String DEFAULTITEM_USERNAME

See Also:

Constant Field Values

DEFAULTITEM_GROUPNAME

public static final java.lang.String DEFAULTITEM_GROUPNAME

See Also:

Constant Field Values

DEFAULTITEM_MEMBERS

public static final java.lang.String DEFAULTITEM_MEMBERS

See Also:

Constant Field Values

DEFAULTITEM_ENABLED

public static final java.lang.String DEFAULTITEM_ENABLED

See Also:

Constant Field Values

COLLECTMODE_PRELOAD

public static final java.lang.String COLLECTMODE_PRELOAD

See Also:

Constant Field Values

COLLECTMODE_LAZY

public static final java.lang.String COLLECTMODE_LAZY

See Also:

Constant Field Values

CSAUTH_PROPERTIES_FILE

public static final java.lang.String CSAUTH_PROPERTIES_FILE

See Also:

Constant Field Values

COPTION_CERTAUTH

public static final java.lang.String COPTION_CERTAUTH

Enable certificate authentication

See Also:

Constant Field Values

COPTION_CA

public static final java.lang.String COPTION_CA

Filename of the CA to be used to verify clientcertificates

See Also:

Constant Field Values

COPTION_CRL

public static final java.lang.String COPTION_CRL

Filename of the CRL for the given CA

See Also:

Constant Field Values

COPTION_COMMONNAME_EXPRESSION

public static final java.lang.String COPTION_COMMONNAME_EXPRESSION

Determines a TMLScript expression by which to calculate the common name

See Also:

Constant Field Values

Constructor Detail

CSAuthModule

public CSAuthModule()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> params,
        de.innovationgate.webgate.api.WGDatabase db)
          throws de.innovationgate.webgate.api.auth.ConfigurationException

Specified by:

init in interface de.innovationgate.webgate.api.auth.AuthenticationModule

Throws:

de.innovationgate.webgate.api.auth.ConfigurationException

login

public de.innovationgate.webgate.api.auth.AuthenticationSession login(java.security.cert.X509Certificate cert)
                                                               throws de.innovationgate.webgate.api.auth.AuthenticationException

Specified by:

login in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule

Throws:

de.innovationgate.webgate.api.auth.AuthenticationException

login

public de.innovationgate.webgate.api.auth.AuthenticationSession login(java.lang.String user,
                                                             java.lang.Object credentials)
                                                               throws de.innovationgate.webgate.api.auth.AuthenticationException

Specified by:

login in interface de.innovationgate.webgate.api.auth.AuthenticationModule

Throws:

de.innovationgate.webgate.api.auth.AuthenticationException

getEMailAddress

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

Specified by:

getEMailAddress in interface de.innovationgate.webgate.api.auth.AuthenticationModule

clearCache

public void clearCache()

Specified by:

clearCache in interface de.innovationgate.webgate.api.auth.AuthenticationModule

getAuthenticationSource

public java.lang.String getAuthenticationSource()

Specified by:

getAuthenticationSource in interface de.innovationgate.webgate.api.auth.AuthenticationModule

setCore

public void setCore(WGACore core)

Specified by:

setCore in interface CoreAwareAuthModule

contentStoreConnected

public void contentStoreConnected(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called after a content store has been connected

Specified by:

contentStoreConnected in interface WGACoreEventListener

contentStoreDisconnected

public void contentStoreDisconnected(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called after a content store has been disconnected

Specified by:

contentStoreDisconnected in interface WGACoreEventListener

isTemporary

public boolean isTemporary()

contentCreated

public void contentCreated(de.innovationgate.webgate.api.WGContentEvent contentEvent)

Specified by:

contentCreated in interface de.innovationgate.webgate.api.WGContentEventListener

contentSaved

public boolean contentSaved(de.innovationgate.webgate.api.WGContentEvent contentEvent)

Specified by:

contentSaved in interface de.innovationgate.webgate.api.WGContentEventListener

contentHasBeenSaved

public void contentHasBeenSaved(de.innovationgate.webgate.api.WGContentEvent event)

Specified by:

contentHasBeenSaved in interface de.innovationgate.webgate.api.WGContentEventListener

contentHasBeenDeleted

public void contentHasBeenDeleted(de.innovationgate.webgate.api.WGContentEvent event)

Specified by:

contentHasBeenDeleted in interface de.innovationgate.webgate.api.WGContentEventListener

runAuthCollectorByEvent

public void runAuthCollectorByEvent(de.innovationgate.webgate.api.WGContentEvent event)

isPoolable

public boolean isPoolable()

addAuthenticationSourceListener

public void addAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)

Specified by:

addAuthenticationSourceListener in interface de.innovationgate.webgate.api.auth.AuthenticationModule

removeAuthenticationSourceListener

public void removeAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)

Specified by:

removeAuthenticationSourceListener in interface de.innovationgate.webgate.api.auth.AuthenticationModule

getAllowedCredentialClasses

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

Specified by:

getAllowedCredentialClasses in interface de.innovationgate.webgate.api.auth.AuthenticationModule

isQueryable

public boolean isQueryable(java.lang.String queryType)

Specified by:

isQueryable in interface de.innovationgate.webgate.api.auth.AuthenticationModule

query

public java.lang.Object query(java.lang.Object query,
                     java.lang.String queryType)
                       throws de.innovationgate.webgate.api.WGQueryException

Specified by:

query in interface de.innovationgate.webgate.api.auth.AuthenticationModule

Throws:

de.innovationgate.webgate.api.WGQueryException

getStatus

public int getStatus()

Returns:

Returns the status.

shutdownPostDisconnect

public void shutdownPostDisconnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA shutdown after databases haved been disconnected

Specified by:

shutdownPostDisconnect in interface WGACoreEventListener

shutdownPreDisconnect

public void shutdownPreDisconnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA shutdown before databases are disconnected

Specified by:

shutdownPreDisconnect in interface WGACoreEventListener

startupPostConnect

public void startupPostConnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA startup after databases have been connected

Specified by:

startupPostConnect in interface WGACoreEventListener

startupPreConnect

public void startupPreConnect(WGACoreEvent event)

Description copied from interface: WGACoreEventListener

Called on WGA startup before databases are connected

Specified by:

startupPreConnect in interface WGACoreEventListener

destroy

public void destroy()

Specified by:

destroy in interface de.innovationgate.webgate.api.auth.AuthenticationModule

closeLazyCollectResources

public void closeLazyCollectResources()

isGeneratesSessionToken

public boolean isGeneratesSessionToken()

Specified by:

isGeneratesSessionToken in interface de.innovationgate.webgate.api.auth.AuthenticationModule

getUserRootDoc

public java.lang.String getUserRootDoc()

returns the unique name of the root document for users

Returns:

getGroupsRootDoc

public java.lang.String getGroupsRootDoc()

returns the unique name of the root document for groups

Returns:

getDbkey

public java.lang.String getDbkey()

returns the dbkey of the authentication source

Returns:

getScriptCollect

public java.lang.String getScriptCollect()

returns the script code for custom collection

Returns:

getUsernameItem

public java.lang.String getUsernameItem()

returns the username item

Returns:

getPasswordItem

public java.lang.String getPasswordItem()

returns the password item name

Returns:

getAliasesItem

public java.lang.String getAliasesItem()

returns the alias item name

Returns:

getEmailItem

public java.lang.String getEmailItem()

returns the email item name

Returns:

getEnabledItem

public java.lang.String getEnabledItem()

returns the enabled item name

Returns:

getMembersItem

public java.lang.String getMembersItem()

returns the members item name

Returns:

getGroupnameItem

public java.lang.String getGroupnameItem()

returns the groupname item

Returns:

getCollectCondition

public java.lang.String getCollectCondition()

returns the collect condition

Returns:

getCurrentCollectorThread

public java.lang.Thread getCurrentCollectorThread()

contentHasBeenMoved

public void contentHasBeenMoved(de.innovationgate.webgate.api.WGContentEvent event)

Specified by:

contentHasBeenMoved in interface de.innovationgate.webgate.api.WGContentEventListener

getCA

public java.security.cert.X509Certificate getCA()
                                         throws de.innovationgate.webgate.api.auth.AuthenticationException

Returns the certificate authority for certificate authentication

Specified by:

getCA in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule

Throws:

de.innovationgate.webgate.api.auth.AuthenticationException

getCRL

public java.security.cert.X509CRL getCRL()
                                  throws de.innovationgate.webgate.api.auth.AuthenticationException

Returns the certificate revoke list for certificate authentication

Specified by:

getCRL in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule

Throws:

de.innovationgate.webgate.api.auth.AuthenticationException

isCertAuthEnabled

public boolean isCertAuthEnabled()

Specified by:

isCertAuthEnabled in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule

contentStatusChanged

public void contentStatusChanged(de.innovationgate.webgate.api.WGContentEvent event)

Specified by:

contentStatusChanged in interface de.innovationgate.webgate.api.WGContentEventListener

getGroupStructEntries

public de.innovationgate.webgate.api.WGStructEntryList getGroupStructEntries(de.innovationgate.webgate.api.WGDatabase db,
                                                                    de.innovationgate.webgate.api.WGContent rootContent)
                                                                      throws de.innovationgate.webgate.api.WGAPIException

Throws:

de.innovationgate.webgate.api.WGAPIException

migrateMembershipsToRelations

public void migrateMembershipsToRelations(org.apache.log4j.Logger log)
                                   throws de.innovationgate.webgate.api.WGException

Throws:

de.innovationgate.webgate.api.WGException