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.
|
ValueOrExpression<String> |
getAltPasswordHeader()
Gets the "alt-password-header" property.
|
ValueOrExpression<String> |
getAltUsernameHeader()
Gets the "alt-username-header" property.
|
ValueOrExpression<String> |
getIdentityMapper()
Gets the "identity-mapper" property.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<Boolean> |
isAltAuthenticationEnabled()
Gets the "alt-authentication-enabled" property.
|
void |
setAltAuthenticationEnabled(ValueOrExpression<Boolean> value)
Sets the "alt-authentication-enabled" property.
|
void |
setAltPasswordHeader(ValueOrExpression<String> value)
Sets the "alt-password-header" property.
|
void |
setAltUsernameHeader(ValueOrExpression<String> value)
Sets the "alt-username-header" property.
|
void |
setIdentityMapper(ValueOrExpression<String> value)
Sets the "identity-mapper" property.
|
void |
setJavaClass(ValueOrExpression<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
ValueOrExpression<Boolean> isAltAuthenticationEnabled()
Specifies whether user credentials may be provided using alternative headers to the standard 'Authorize' header.
void setAltAuthenticationEnabled(ValueOrExpression<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.ValueOrExpression<String> getAltPasswordHeader()
Alternate HTTP headers to get the user's password from.
void setAltPasswordHeader(ValueOrExpression<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.ValueOrExpression<String> getAltUsernameHeader()
Alternate HTTP headers to get the user's name from.
void setAltUsernameHeader(ValueOrExpression<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.ValueOrExpression<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(ValueOrExpression<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.ValueOrExpression<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(ValueOrExpression<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-2018 ForgeRock AS.