public interface HttpBasicAuthorizationMechanismCfgClient extends HttpAuthorizationMechanismCfgClient
The HTTP Basic Authorization Mechanism authenticates the end-user using credentials extracted from the HTTP Basic 'Authorization' header.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends HttpBasicAuthorizationMechanismCfgClient,? extends HttpBasicAuthorizationMechanismCfg> |
definition()
Get the configuration definition 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.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isAltAuthenticationEnabled()
Gets the "alt-authentication-enabled" property.
|
void |
setAltAuthenticationEnabled(boolean value)
Sets the "alt-authentication-enabled" property.
|
void |
setAltPasswordHeader(String value)
Sets the "alt-password-header" property.
|
void |
setAltUsernameHeader(String value)
Sets the "alt-username-header" property.
|
void |
setIdentityMapper(String value)
Sets the "identity-mapper" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
isEnabled, setEnabled
commit, properties
ManagedObjectDefinition<? extends HttpBasicAuthorizationMechanismCfgClient,? extends HttpBasicAuthorizationMechanismCfg> definition()
definition
in interface ConfigurationClient
definition
in interface HttpAuthorizationMechanismCfgClient
boolean isAltAuthenticationEnabled()
Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
void setAltAuthenticationEnabled(boolean value) throws PropertyException
Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
value
- The value of the "alt-authentication-enabled" property.PropertyException
- If the new value is invalid.String getAltPasswordHeader()
Alternate HTTP headers to get the user's password from.
void setAltPasswordHeader(String value) throws PropertyException
Alternate HTTP headers to get the user's password from.
value
- The value of the "alt-password-header" property.PropertyException
- If the new value is invalid.String getAltUsernameHeader()
Alternate HTTP headers to get the user's name from.
void setAltUsernameHeader(String value) throws PropertyException
Alternate HTTP headers to get the user's name from.
value
- The value of the "alt-username-header" property.PropertyException
- If the new value is invalid.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.
void setIdentityMapper(String value) throws PropertyException
> 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.
value
- The value of the "identity-mapper" property.PropertyException
- If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.
getJavaClass
in interface HttpAuthorizationMechanismCfgClient
void setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the HTTP Basic Authorization Mechanism implementation.
setJavaClass
in interface HttpAuthorizationMechanismCfgClient
value
- The value of the "java-class" property.PropertyException
- If the new value is invalid.Copyright 2010-2020 ForgeRock AS.