|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.platform.security.authentication.BaseAuthenticationModule blackboard.platform.security.authentication.LDAPAuthModule
public class LDAPAuthModule
Implementation class for the LDAP authentication provider for Blackboard Learning system. Building Block Developers are able to subclass this in custom authentications. However, specific changes to the way that the provider connects to the LDAP server may not be made and will still be dictated by properties set in the authentication.properties file.
Subclasses must call the
authenticate(String, String, SessionStub, boolean)
and
init( ConfigurationService)
methods
in this class or the LDAP functionality will not work.
Developers that wish to substantially
change the behavior of the LDAP provider can use
BaseAuthenticationModule
to implement their own LDAP provider using
JNDI or another library.
HttpAuthModule
Field Summary | |
---|---|
static java.lang.String[] |
LDAP_PROP_KEYS
|
Fields inherited from class blackboard.platform.security.authentication.BaseAuthenticationModule |
---|
_authTypeDisplayStr, _config, _logger, IMPL_CLASS_KEY, USE_CHALLENGE_KEY |
Constructor Summary | |
---|---|
LDAPAuthModule()
Constructor for the LDAP authentication provider. |
Method Summary | |
---|---|
protected java.lang.String |
authenticate(java.lang.String userName,
java.lang.String password,
SessionStub sessionStub,
boolean useChallenge)
Method to support LDAP-based authentication. |
java.lang.String |
getAuthType()
Returns a String identifier for the authentication type for a given implementation of HttpAuthModule. |
boolean |
getErrorFallbackToBb()
Returns a true if the LDAP provider is configured to "fall back" to the default authentication if an error is encountered using LDAP. |
int |
getNumServers()
Returns the number of LDAP servers configured. |
java.lang.String[] |
getPropKeys()
Returns a String array of the keys to this authentication module's configuration properties file. |
java.lang.String |
getRemoteUser(javax.servlet.http.HttpServletRequest request)
Extracts the CGI variable REMOTE_USER from the incoming request. |
User |
getUserFromUsernamePassword(java.lang.String username,
java.lang.String password)
Returns the User object for a given username and password. |
boolean |
getUserNotFoundFallbackToBb()
Returns true of the LDAP provider is configured to "fall back" to the default authentication if the user is not found in LDAP. |
void |
init(ConfigurationService cfg)
Initializes authentication module. |
Methods inherited from class blackboard.platform.security.authentication.BaseAuthenticationModule |
---|
assertRequestAuthenticate, doAuthenticate, doAuthenticate, doLogout, getBundle, getConfigErrs, getCreateAccountAllowed, getDefaultAuthType, getDoAuthenticateParams, getRequestAuthenticateUri, getSecondaryDoAuthenticateParams, getSubConfigErrs, getUseChallenge, isAuthenticated, isExternalAuth, requestAuthenticate, setConfig, setGlobalKeys, validateConfig |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String[] LDAP_PROP_KEYS
Constructor Detail |
---|
public LDAPAuthModule()
Method Detail |
---|
public void init(ConfigurationService cfg)
init
in interface HttpAuthModule
init
in class BaseAuthenticationModule
cfg
- The ConfigurationService for this installation.public boolean getErrorFallbackToBb()
public boolean getUserNotFoundFallbackToBb()
protected java.lang.String authenticate(java.lang.String userName, java.lang.String password, SessionStub sessionStub, boolean useChallenge) throws BbAuthenticationFailedException, BbSecurityException
authenticate
in class BaseAuthenticationModule
userName
- User nameuserToken
- this should be the clear text password to use to perform the
bind.
blackboard.platform.security.BbAuthenticationFailedException
BbAuthenticationFailedException
BbSecurityException
public User getUserFromUsernamePassword(java.lang.String username, java.lang.String password) throws PersistenceException, BbAuthenticationFailedException, BbSecurityException
User
object for a given username and password.
PersistenceException
BbAuthenticationFailedException
BbSecurityException
public java.lang.String getRemoteUser(javax.servlet.http.HttpServletRequest request) throws BbSecurityException
HttpServletRequest
- request
BbSecurityException
public int getNumServers()
public java.lang.String getAuthType()
getAuthType
in interface HttpAuthModule
getAuthType
in class BaseAuthenticationModule
public java.lang.String[] getPropKeys()
getPropKeys
in interface HttpAuthModule
getPropKeys
in class BaseAuthenticationModule
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |