public interface HttpOauth2AuthorizationMechanismCfgClient extends HttpAuthorizationMechanismCfgClient
The HTTP OAuth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends HttpOauth2AuthorizationMechanismCfgClient,? extends HttpOauth2AuthorizationMechanismCfg> |
definition()
Get the configuration definition associated with this HTTP OAuth2 Authorization Mechanism.
|
Long |
getAccessTokenCacheExpiration()
Gets the "access-token-cache-expiration" property.
|
String |
getAuthzidJsonPointer()
Gets the "authzid-json-pointer" property.
|
String |
getIdentityMapper()
Gets the "identity-mapper" property.
|
SortedSet<String> |
getRequiredScope()
Gets the "required-scope" property.
|
boolean |
isAccessTokenCacheEnabled()
Gets the "access-token-cache-enabled" property.
|
void |
setAccessTokenCacheEnabled(boolean value)
Sets the "access-token-cache-enabled" property.
|
void |
setAccessTokenCacheExpiration(Long value)
Sets the "access-token-cache-expiration" property.
|
void |
setAuthzidJsonPointer(String value)
Sets the "authzid-json-pointer" property.
|
void |
setIdentityMapper(String value)
Sets the "identity-mapper" property.
|
void |
setRequiredScope(Collection<String> values)
Sets the "required-scope" property.
|
getJavaClass, isEnabled, setEnabled, setJavaClass
commit, properties
ManagedObjectDefinition<? extends HttpOauth2AuthorizationMechanismCfgClient,? extends HttpOauth2AuthorizationMechanismCfg> definition()
definition
in interface ConfigurationClient
definition
in interface HttpAuthorizationMechanismCfgClient
boolean isAccessTokenCacheEnabled()
Indicates whether the HTTP OAuth2 Authorization Mechanism is enabled for use.
void setAccessTokenCacheEnabled(boolean value) throws PropertyException
Indicates whether the HTTP OAuth2 Authorization Mechanism is enabled for use.
value
- The value of the "access-token-cache-enabled" property.PropertyException
- If the new value is invalid.Long getAccessTokenCacheExpiration()
Token cache expiration
void setAccessTokenCacheExpiration(Long value) throws PropertyException
Token cache expiration
value
- The value of the "access-token-cache-expiration" property.PropertyException
- If the new value is invalid.String getAuthzidJsonPointer()
Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document.
void setAuthzidJsonPointer(String value) throws PropertyException
Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document.
value
- The value of the "authzid-json-pointer" property.PropertyException
- If the new value is invalid.String getIdentityMapper()
> Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.
void setIdentityMapper(String value) throws PropertyException
> Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.
value
- The value of the "identity-mapper" property.PropertyException
- If the new value is invalid.SortedSet<String> getRequiredScope()
Scopes required to grant access to the service.
void setRequiredScope(Collection<String> values) throws PropertyException
Scopes required to grant access to the service.
values
- The values of the "required-scope" property.PropertyException
- If one or more of the new values are invalid.Copyright 2010-2020 ForgeRock AS.