public class AuthenticatorConfig extends LdapConfig
AuthenticatorConfig
contains all the configuration data that the
Authenticator
needs to control authentication.LdapConfig.SearchScope
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTIES_DOMAIN
Domain to look for ldap properties in, value is "edu.vt.middleware.ldap.auth.".
|
logger
Constructor and Description |
---|
AuthenticatorConfig()
Default constructor.
|
AuthenticatorConfig(String ldapUrl,
String baseDn)
This will create a new
AuthenticatorConfig with the supplied
ldap url and base Strings. |
Modifier and Type | Method and Description |
---|---|
static AuthenticatorConfig |
createFromProperties(InputStream is)
Create an instance of this class initialized with properties from the input
stream.
|
boolean |
getAllowMultipleDns()
This returns the allowMultipleDns of the
Authenticator . |
AuthenticationHandler |
getAuthenticationHandler()
This returns the authentication handler.
|
AuthenticationResultHandler[] |
getAuthenticationResultHandlers()
This returns the handlers to use for processing authentications.
|
String |
getAuthorizationFilter()
This returns the filter used to authorize users.
|
Object[] |
getAuthorizationFilterArgs()
This returns the filter arguments used to authorize users.
|
AuthorizationHandler[] |
getAuthorizationHandlers()
This returns the handlers to use for processing authorization.
|
boolean |
getConstructDn()
This returns the constructDn of the
Authenticator . |
Object |
getCredential()
This returns the credential of the
Authenticator . |
DnResolver |
getDnResolver()
This returns the DN resolver.
|
String |
getPropertiesDomain()
This returns the properties domain for this property config.
|
boolean |
getSubtreeSearch()
This returns the subtreeSearch of the
Authenticator . |
String |
getUser()
This returns the user of the
Authenticator . |
String[] |
getUserField()
This returns the user field(s) of the
Authenticator . |
String |
getUserFilter()
This returns the filter used to search for the user.
|
Object[] |
getUserFilterArgs()
This returns the filter arguments used to search for the user.
|
boolean |
hasEnvironmentProperty(String name)
This returns whether the supplied property exists.
|
void |
setAllowMultipleDns(boolean allowMultipleDns)
This sets the allowMultipleDns for the
Authentication . |
void |
setAuthenticationHandler(AuthenticationHandler handler)
This sets the authentication handler.
|
void |
setAuthenticationResultHandlers(AuthenticationResultHandler[] handlers)
This sets the handlers for processing authentications.
|
void |
setAuthorizationFilter(String authorizationFilter)
This sets the filter used to authorize users.
|
void |
setAuthorizationFilterArgs(Object[] authorizationFilterArgs)
This sets the filter arguments used to authorize users.
|
void |
setAuthorizationHandlers(AuthorizationHandler[] handlers)
This sets the handlers for processing authorization.
|
void |
setConstructDn(boolean constructDn)
This sets the constructDn for the
Authenticator . |
void |
setCredential(Object credential)
This sets the credential for the
Authenticator to use for
authentication. |
void |
setDnResolver(DnResolver resolver)
This sets the DN resolver.
|
void |
setEnvironmentProperties(String name,
String value)
This adds environment properties to this object.
|
void |
setSubtreeSearch(boolean subtreeSearch)
This sets the subtreeSearch for the
Authenticator . |
void |
setUser(String user)
This sets the username for the
Authenticator to use for
authentication. |
void |
setUserField(String[] userField)
This sets the user fields for the
Authenticator . |
void |
setUserFilter(String userFilter)
This sets the filter used to search for users.
|
void |
setUserFilterArgs(Object[] userFilterArgs)
This sets the filter arguments used to search for users.
|
getAuthoritative, getAuthtype, getBase, getBaseDn, getBatchSize, getBinaryAttributes, getBindCredential, getBindDn, getCompareSearchControls, getConnectionHandler, getContextFactory, getCountLimit, getDerefAliases, getDerefLinkFlag, getDnsUrl, getEnvironment, getEnvironmentProperties, getHandlerIgnoreExceptions, getHost, getHostnameVerifier, getLanguage, getLdapUrl, getLogCredentials, getOperationRetry, getOperationRetryBackoff, getOperationRetryExceptions, getOperationRetryWait, getPagedResultsSize, getPort, getReferral, getReturningObjFlag, getSaslAuthorizationId, getSaslRealm, getSearchControls, getSearchResultHandlers, getSearchScope, getServiceCredential, getServiceUser, getSsl, getSslSocketFactory, getTimeLimit, getTimeout, getTls, getTypesOnly, isAnonymousAuth, isAuthoritative, isCramMD5Auth, isDigestMD5Auth, isExternalAuth, isGSSAPIAuth, isObjectSearchScope, isOneLevelSearchScope, isSaslAuth, isSimpleAuth, isSslEnabled, isStrongAuth, isSubTreeSearchScope, isTlsEnabled, isTypesOnly, setAuthoritative, setAuthtype, setBase, setBaseDn, setBatchSize, setBinaryAttributes, setBindCredential, setBindDn, setConnectionHandler, setContextFactory, setCountLimit, setDerefAliases, setDerefLinkFlag, setDnsUrl, setHandlerIgnoreExceptions, setHost, setHostnameVerifier, setLanguage, setLdapUrl, setLogCredentials, setOperationRetry, setOperationRetryBackoff, setOperationRetryExceptions, setOperationRetryWait, setPagedResultsSize, setPort, setReferral, setReturningObjFlag, setSaslAuthorizationId, setSaslRealm, setSearchResultHandlers, setSearchScope, setService, setServiceCredential, setServiceUser, setSsl, setSslSocketFactory, setTimeLimit, setTimeout, setTls, setTracePackets, setTypesOnly, toString, useHostnameVerifier, useSslSocketFactory
checkImmutable, checkStringInput, makeImmutable, setEnvironmentProperties, setEnvironmentProperties
public static final String PROPERTIES_DOMAIN
public String[] getUserField()
Authenticator
.String[]
- user field name(s)public String getUserFilter()
String
- filterpublic Object[] getUserFilterArgs()
Object[]
- filter argumentspublic String getUser()
Authenticator
.String
- user namepublic Object getCredential()
Authenticator
.Object
- user credentialpublic String getAuthorizationFilter()
String
- filterpublic Object[] getAuthorizationFilterArgs()
Object[]
- filter argumentspublic boolean getConstructDn()
Authenticator
.boolean
- whether the DN will be constructedpublic boolean getAllowMultipleDns()
Authenticator
.boolean
- whether an exception will be thrown if
multiple DNs are foundpublic boolean getSubtreeSearch()
Authenticator
.boolean
- whether the DN will be searched for over
the entire basepublic DnResolver getDnResolver()
DnResolver
public AuthenticationHandler getAuthenticationHandler()
AuthenticationHandler
public AuthenticationResultHandler[] getAuthenticationResultHandlers()
AuthenticationResultHandler[]
public AuthorizationHandler[] getAuthorizationHandlers()
AuthorizationHandler[]
public void setUserField(String[] userField)
Authenticator
. The user
field is used to lookup a user's dn.userField
- String[]
usernamepublic void setUserFilter(String userFilter)
userFilter
- String
public void setUserFilterArgs(Object[] userFilterArgs)
userFilterArgs
- Object[]
public void setUser(String user)
Authenticator
to use for
authentication.user
- String
usernamepublic void setCredential(Object credential)
Authenticator
to use for
authentication.credential
- Object
public void setAuthorizationFilter(String authorizationFilter)
authorizationFilter
- String
public void setAuthorizationFilterArgs(Object[] authorizationFilterArgs)
authorizationFilterArgs
- Object[]
public void setConstructDn(boolean constructDn)
Authenticator
. If true, the
dnResolver
is set to ConstructDnResolver
. If false, the
dnResolver
is set to SearchDnResolver
.constructDn
- boolean
public void setAllowMultipleDns(boolean allowMultipleDns)
Authentication
. If
false an exception will be thrown if Authenticator.getDn(String)
finds more than one DN matching it's filter. Otherwise the first DN found
is returned.allowMultipleDns
- boolean
public void setSubtreeSearch(boolean subtreeSearch)
Authenticator
. If true,
the DN used for authenticating will be searched for over the entire LdapConfig.getBaseDn()
. Otherwise the DN will be search for in the LdapConfig.getBaseDn()
context.subtreeSearch
- boolean
public void setDnResolver(DnResolver resolver)
resolver
- DnResolver
public void setAuthenticationHandler(AuthenticationHandler handler)
handler
- AuthenticationHandler
public void setAuthenticationResultHandlers(AuthenticationResultHandler[] handlers)
handlers
- AuthenticationResultHandler[]
public void setAuthorizationHandlers(AuthorizationHandler[] handlers)
handlers
- AuthorizationHandler[]
public String getPropertiesDomain()
getPropertiesDomain
in interface PropertyConfig
getPropertiesDomain
in class LdapConfig
String
properties domainpublic void setEnvironmentProperties(String name, String value)
setEnvironmentProperties
in interface PropertyConfig
setEnvironmentProperties
in class LdapConfig
name
- String
property namevalue
- String
property valuepublic boolean hasEnvironmentProperty(String name)
hasEnvironmentProperty
in interface PropertyConfig
hasEnvironmentProperty
in class LdapConfig
name
- String
to checkboolean
whether the supplied property existspublic static AuthenticatorConfig createFromProperties(InputStream is)
is
- to load properties fromAuthenticatorConfig
initialized ldap pool configCopyright © 2019. All rights reserved.