public interface HttpOauth2AuthorizationMechanismCfg extends HttpAuthorizationMechanismCfg
The HTTP OAuth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.
Modifier and Type | Method and Description |
---|---|
void |
addHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 Authorization Mechanism is changed.
|
Class<? extends HttpOauth2AuthorizationMechanismCfg> |
configurationClass()
Gets the configuration class 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.
|
Dn |
getIdentityMapperDn()
Gets the "identity-mapper" property as a DN.
|
SortedSet<String> |
getRequiredScope()
Gets the "required-scope" property.
|
boolean |
isAccessTokenCacheEnabled()
Gets the "access-token-cache-enabled" property.
|
void |
removeHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 Authorization Mechanism configuration change listener.
|
addChangeListener, getJavaClass, isEnabled, removeChangeListener
dn, name
Class<? extends HttpOauth2AuthorizationMechanismCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface HttpAuthorizationMechanismCfg
void addHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
listener
- The HTTP OAuth2 Authorization Mechanism configuration change listener.void removeHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
listener
- The HTTP OAuth2 Authorization Mechanism configuration change listener.boolean isAccessTokenCacheEnabled()
Indicates whether the HTTP OAuth2 Authorization Mechanism is enabled for use.
Long getAccessTokenCacheExpiration()
Token cache expiration
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.
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.
Dn getIdentityMapperDn()
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.
Copyright 2010-2022 ForgeRock AS.