|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ldap.server.authn.AbstractAuthenticator
Base class for all Authenticators.
Field Summary | |
AuthenticatorConfig |
authenticatorConfig
authenticator config |
java.lang.String |
authenticatorType
authenticator type |
Constructor Summary | |
AbstractAuthenticator(java.lang.String type)
Create a new AuthenticationService. |
Method Summary | |
abstract LdapPrincipal |
authenticate(ServerContext ctx)
Perform the authentication operation and return the authorization id if successfull. |
protected LdapPrincipal |
createLdapPrincipal(java.lang.String dn)
Allows a means to create an LDAP principal without exposing LdapPrincipal creation to the rest of the world. |
AuthenticatorConfig |
getAuthenticatorConfig()
Return this authenticator's AuthenticatorConfig object. |
AuthenticatorContext |
getAuthenticatorContext()
Returns a reference to the AuthenticatorContext in which this authenticator is running. |
java.lang.String |
getAuthenticatorName()
Returns the name of this authenticator instance. |
java.lang.String |
getAuthenticatorType()
Returns this authenticator's type. |
java.lang.String |
getInitParameter(java.lang.String name)
Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist. |
java.util.Enumeration |
getInitParameterNames()
Returns the names of the servlet's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the servlet has no initialization parameters. |
void |
init()
A convenience method which can be overridden so that there's no need to call super.init( authenticatorConfig ). |
void |
init(AuthenticatorConfig authenticatorConfig)
Called by the server to indicate to an authenticator that the authenticator is being placed into service. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public AuthenticatorConfig authenticatorConfig
public java.lang.String authenticatorType
Constructor Detail |
public AbstractAuthenticator(java.lang.String type)
type
- authenticator's typeMethod Detail |
public AuthenticatorContext getAuthenticatorContext()
getAuthenticatorContext
in interface AuthenticatorConfig
public java.lang.String getAuthenticatorType()
getAuthenticatorType
in interface Authenticator
public AuthenticatorConfig getAuthenticatorConfig()
getAuthenticatorConfig
in interface Authenticator
public void init(AuthenticatorConfig authenticatorConfig) throws javax.naming.NamingException
init
in interface Authenticator
authenticatorConfig
-
javax.naming.NamingException
public void init() throws javax.naming.NamingException
javax.naming.NamingException
public abstract LdapPrincipal authenticate(ServerContext ctx) throws javax.naming.NamingException
authenticate
in interface Authenticator
ctx
-
javax.naming.NamingException
public java.lang.String getAuthenticatorName()
getAuthenticatorName
in interface AuthenticatorConfig
public java.lang.String getInitParameter(java.lang.String name)
getInitParameter
in interface AuthenticatorConfig
public java.util.Enumeration getInitParameterNames()
getInitParameterNames
in interface AuthenticatorConfig
protected LdapPrincipal createLdapPrincipal(java.lang.String dn) throws javax.naming.NamingException
dn
- the distinguished name of the X.500 principal
javax.naming.NamingException
- if there is a problem parsing the dn
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |