Interface HttpOauth2AuthorizationMechanismCfg
-
- All Superinterfaces:
Configuration
,HttpAuthorizationMechanismCfg
- All Known Subinterfaces:
HttpOauth2CtsAuthorizationMechanismCfg
,HttpOauth2FileAuthorizationMechanismCfg
,HttpOauth2OpenamAuthorizationMechanismCfg
,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg
public interface HttpOauth2AuthorizationMechanismCfg extends HttpAuthorizationMechanismCfg
A server-side interface for querying HTTP OAuth2 Authorization Mechanism settings.The HTTP OAuth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.SortedSet<String>
getIdentityMapper()
Gets the "identity-mapper" property.SortedSet<Dn>
getIdentityMapperDns()
Gets the "identity-mapper" property as a set of DNs.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.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.HttpAuthorizationMechanismCfg
addChangeListener, getJavaClass, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends HttpOauth2AuthorizationMechanismCfg> configurationClass()
Gets the configuration class associated with this HTTP OAuth2 Authorization Mechanism.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceHttpAuthorizationMechanismCfg
- Returns:
- Returns the configuration class associated with this HTTP OAuth2 Authorization Mechanism.
-
addHttpOauth2AuthorizationMechanismChangeListener
void addHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 Authorization Mechanism is changed.- Parameters:
listener
- The HTTP OAuth2 Authorization Mechanism configuration change listener.
-
removeHttpOauth2AuthorizationMechanismChangeListener
void removeHttpOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2AuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 Authorization Mechanism configuration change listener.- Parameters:
listener
- The HTTP OAuth2 Authorization Mechanism configuration change listener.
-
isAccessTokenCacheEnabled
boolean isAccessTokenCacheEnabled()
Gets the "access-token-cache-enabled" property.Indicates whether the HTTP OAuth2 Authorization Mechanism is enabled for use.
Default value:
false
- Returns:
- Returns the value of the "access-token-cache-enabled" property.
-
getAccessTokenCacheExpiration
Long getAccessTokenCacheExpiration()
Gets the "access-token-cache-expiration" property.Token cache expiration
Default value is undefined
- Returns:
- Returns the value of the "access-token-cache-expiration" property.
-
getAuthzidJsonPointer
String getAuthzidJsonPointer()
Gets the "authzid-json-pointer" property.Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document.
- Returns:
- Returns the value of the "authzid-json-pointer" property.
-
getIdentityMapper
SortedSet<String> getIdentityMapper()
Gets the "identity-mapper" property.Specifies the name of the identity mapper(s) to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.
- Returns:
- Returns an unmodifiable set containing the values of the "identity-mapper" property.
-
getIdentityMapperDns
SortedSet<Dn> getIdentityMapperDns()
Gets the "identity-mapper" property as a set of DNs.Specifies the name of the identity mapper(s) to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.
- Returns:
- Returns the DN values of the "identity-mapper" property.
-
-