public interface HttpBasicAuthorizationMechanismCfg extends HttpAuthorizationMechanismCfg
The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header.
Modifier and Type | Method and Description |
---|---|
void |
addHttpBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
Register to be notified when this HTTP Basic Authorization Mechanism is changed.
|
Class<? extends HttpBasicAuthorizationMechanismCfg> |
configurationClass()
Gets the configuration class associated with this HTTP Basic Authorization Mechanism.
|
String |
getAltPasswordHeader()
Gets the "alt-password-header" property.
|
String |
getAltUsernameHeader()
Gets the "alt-username-header" property.
|
String |
getIdentityMapper()
Gets the "identity-mapper" property.
|
Dn |
getIdentityMapperDn()
Gets the "identity-mapper" property as a DN.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isAltAuthenticationEnabled()
Gets the "alt-authentication-enabled" property.
|
void |
removeHttpBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
Deregister an existing HTTP Basic Authorization Mechanism configuration change listener.
|
addChangeListener, isEnabled, removeChangeListener
dn, name
Class<? extends HttpBasicAuthorizationMechanismCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface HttpAuthorizationMechanismCfg
void addHttpBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
listener
- The HTTP Basic Authorization Mechanism configuration change listener.void removeHttpBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpBasicAuthorizationMechanismCfg> listener)
listener
- The HTTP Basic Authorization Mechanism configuration change listener.boolean isAltAuthenticationEnabled()
Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
String getAltPasswordHeader()
Alternate HTTP headers to get the user's password from.
String getAltUsernameHeader()
Alternate HTTP headers to get the user's name from.
String getIdentityMapper()
Specifies the name of the identity mapper used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.
Dn getIdentityMapperDn()
Specifies the name of the identity mapper used to get the user's entry corresponding to the user-id provided in the HTTP authentication header.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.
getJavaClass
in interface HttpAuthorizationMechanismCfg
Copyright 2010-2018 ForgeRock AS.