public class CSAuthModule extends java.lang.Object implements CoreAwareAuthModule, de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule, WGACoreEventListener, de.innovationgate.webgate.api.WGContentEventListener
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 |
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
|
Constructor and Description |
---|
CSAuthModule() |
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
|
public static final int COLLECT_LAZY_CACHESIZE_DEFAULT
public static final org.apache.log4j.Logger LOG
public static final java.lang.String DEFAULT_GROUPSROOT
public static final java.lang.String DEFAULT_USERSROOT
public static final int STATUS_AUTHDB_UNKNOWN
public static final int STATUS_AUTHDB_PREPARED
public static final int STATUS_READY
public java.util.Map<java.lang.String,Group> _groupInformation
public static final java.lang.String COPTION_DBKEY
public static final java.lang.String COPTION_ROOTDOC_USERS
public static final java.lang.String COPTION_ROOTDOC_GROUPS
public static final java.lang.String COPTION_COLLECT_MODE
public static final java.lang.String COPTION_COLLECT_LAZY_CACHESIZE
public static final java.lang.String COPTION_SCRIPT_COLLECT
public static final java.lang.String COPTION_ITEM_USERNAME
public static final java.lang.String COPTION_ITEM_GROUPNAME
public static final java.lang.String COPTION_ITEM_GROUPMEMBERS
public static final java.lang.String COPTION_ITEM_PASSWORD
public static final java.lang.String COPTION_ITEM_ALIASES
public static final java.lang.String COPTION_ALIAS_ITEMS
public static final java.lang.String COPTION_ITEM_EMAIL
public static final java.lang.String COPTION_ITEM_ENABLED
public static final java.lang.String COPTION_LABELED_NAMES
public static final java.lang.String COPTION_COLLECT_CONDITION
public static final java.lang.String COPTION_LOGIN_CONTENTCLASS
public static final java.lang.String COPTION_GROUP_CONTENTCLASS
public static final java.lang.String DEFAULTITEM_EMAIL
public static final java.lang.String DEFAULTITEM_USERALIASES
public static final java.lang.String DEFAULTITEM_PASSWORD
public static final java.lang.String DEFAULTITEM_USERNAME
public static final java.lang.String DEFAULTITEM_GROUPNAME
public static final java.lang.String DEFAULTITEM_MEMBERS
public static final java.lang.String DEFAULTITEM_ENABLED
public static final java.lang.String COLLECTMODE_PRELOAD
public static final java.lang.String COLLECTMODE_LAZY
public static final java.lang.String CSAUTH_PROPERTIES_FILE
public static final java.lang.String COPTION_CERTAUTH
public static final java.lang.String COPTION_CA
public static final java.lang.String COPTION_CRL
public static final java.lang.String COPTION_COMMONNAME_EXPRESSION
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
init
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
de.innovationgate.webgate.api.auth.ConfigurationException
public de.innovationgate.webgate.api.auth.AuthenticationSession login(java.security.cert.X509Certificate cert) throws de.innovationgate.webgate.api.auth.AuthenticationException
login
in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule
de.innovationgate.webgate.api.auth.AuthenticationException
public de.innovationgate.webgate.api.auth.AuthenticationSession login(java.lang.String user, java.lang.Object credentials) throws de.innovationgate.webgate.api.auth.AuthenticationException
login
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
de.innovationgate.webgate.api.auth.AuthenticationException
public java.lang.String getEMailAddress(java.lang.String user)
getEMailAddress
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public void clearCache()
clearCache
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public java.lang.String getAuthenticationSource()
getAuthenticationSource
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public void setCore(WGACore core)
setCore
in interface CoreAwareAuthModule
public void contentStoreConnected(WGACoreEvent event)
WGACoreEventListener
contentStoreConnected
in interface WGACoreEventListener
public void contentStoreDisconnected(WGACoreEvent event)
WGACoreEventListener
contentStoreDisconnected
in interface WGACoreEventListener
public boolean isTemporary()
public void contentCreated(de.innovationgate.webgate.api.WGContentEvent contentEvent)
contentCreated
in interface de.innovationgate.webgate.api.WGContentEventListener
public boolean contentSaved(de.innovationgate.webgate.api.WGContentEvent contentEvent)
contentSaved
in interface de.innovationgate.webgate.api.WGContentEventListener
public void contentHasBeenSaved(de.innovationgate.webgate.api.WGContentEvent event)
contentHasBeenSaved
in interface de.innovationgate.webgate.api.WGContentEventListener
public void contentHasBeenDeleted(de.innovationgate.webgate.api.WGContentEvent event)
contentHasBeenDeleted
in interface de.innovationgate.webgate.api.WGContentEventListener
public void runAuthCollectorByEvent(de.innovationgate.webgate.api.WGContentEvent event)
public boolean isPoolable()
public void addAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)
addAuthenticationSourceListener
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public void removeAuthenticationSourceListener(de.innovationgate.webgate.api.auth.AuthenticationSourceListener listener)
removeAuthenticationSourceListener
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public java.lang.Class<?>[] getAllowedCredentialClasses()
getAllowedCredentialClasses
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public boolean isQueryable(java.lang.String queryType)
isQueryable
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public java.lang.Object query(java.lang.Object query, java.lang.String queryType) throws de.innovationgate.webgate.api.WGQueryException
query
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
de.innovationgate.webgate.api.WGQueryException
public int getStatus()
public void shutdownPostDisconnect(WGACoreEvent event)
WGACoreEventListener
shutdownPostDisconnect
in interface WGACoreEventListener
public void shutdownPreDisconnect(WGACoreEvent event)
WGACoreEventListener
shutdownPreDisconnect
in interface WGACoreEventListener
public void startupPostConnect(WGACoreEvent event)
WGACoreEventListener
startupPostConnect
in interface WGACoreEventListener
public void startupPreConnect(WGACoreEvent event)
WGACoreEventListener
startupPreConnect
in interface WGACoreEventListener
public void destroy()
destroy
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public void closeLazyCollectResources()
public boolean isGeneratesSessionToken()
isGeneratesSessionToken
in interface de.innovationgate.webgate.api.auth.AuthenticationModule
public java.lang.String getUserRootDoc()
public java.lang.String getGroupsRootDoc()
public java.lang.String getDbkey()
public java.lang.String getScriptCollect()
public java.lang.String getUsernameItem()
public java.lang.String getPasswordItem()
public java.lang.String getAliasesItem()
public java.lang.String getEmailItem()
public java.lang.String getEnabledItem()
public java.lang.String getMembersItem()
public java.lang.String getGroupnameItem()
public java.lang.String getCollectCondition()
public java.lang.Thread getCurrentCollectorThread()
public void contentHasBeenMoved(de.innovationgate.webgate.api.WGContentEvent event)
contentHasBeenMoved
in interface de.innovationgate.webgate.api.WGContentEventListener
public java.security.cert.X509Certificate getCA() throws de.innovationgate.webgate.api.auth.AuthenticationException
getCA
in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule
de.innovationgate.webgate.api.auth.AuthenticationException
public java.security.cert.X509CRL getCRL() throws de.innovationgate.webgate.api.auth.AuthenticationException
getCRL
in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule
de.innovationgate.webgate.api.auth.AuthenticationException
public boolean isCertAuthEnabled()
isCertAuthEnabled
in interface de.innovationgate.webgate.api.auth.CertAuthCapableAuthModule
public void contentStatusChanged(de.innovationgate.webgate.api.WGContentEvent event)
contentStatusChanged
in interface de.innovationgate.webgate.api.WGContentEventListener
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
de.innovationgate.webgate.api.WGAPIException
public void migrateMembershipsToRelations(org.apache.log4j.Logger log) throws de.innovationgate.webgate.api.WGException
de.innovationgate.webgate.api.WGException