Interface HttpOauth2CtsAuthorizationMechanismCfg
-
- All Superinterfaces:
Configuration
,HttpAuthorizationMechanismCfg
,HttpOauth2AuthorizationMechanismCfg
public interface HttpOauth2CtsAuthorizationMechanismCfg extends HttpOauth2AuthorizationMechanismCfg
A server-side interface for querying HTTP OAuth2 CTS Authorization Mechanism settings.The HTTP OAuth2 CTS Authorization Mechanism is used to define OAuth2 authorization through a direct access to the CTS (Core Token Service).
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addHttpOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2CtsAuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 CTS Authorization Mechanism is changed.Class<? extends HttpOauth2CtsAuthorizationMechanismCfg>
configurationClass()
Gets the configuration class associated with this HTTP OAuth2 CTS Authorization Mechanism.String
getBaseDn()
Gets the "base-dn" property.String
getJavaClass()
Gets the "java-class" property.void
removeHttpOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2CtsAuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 CTS 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, isEnabled, removeChangeListener
-
Methods inherited from interface org.forgerock.opendj.server.config.server.HttpOauth2AuthorizationMechanismCfg
addHttpOauth2AuthorizationMechanismChangeListener, getAccessTokenCacheExpiration, getAuthzidJsonPointer, getIdentityMapper, getIdentityMapperDns, getRequiredScope, isAccessTokenCacheEnabled, removeHttpOauth2AuthorizationMechanismChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends HttpOauth2CtsAuthorizationMechanismCfg> configurationClass()
Gets the configuration class associated with this HTTP OAuth2 CTS Authorization Mechanism.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceHttpAuthorizationMechanismCfg
- Specified by:
configurationClass
in interfaceHttpOauth2AuthorizationMechanismCfg
- Returns:
- Returns the configuration class associated with this HTTP OAuth2 CTS Authorization Mechanism.
-
addHttpOauth2CtsAuthorizationMechanismChangeListener
void addHttpOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2CtsAuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 CTS Authorization Mechanism is changed.- Parameters:
listener
- The HTTP OAuth2 CTS Authorization Mechanism configuration change listener.
-
removeHttpOauth2CtsAuthorizationMechanismChangeListener
void removeHttpOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2CtsAuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 CTS Authorization Mechanism configuration change listener.- Parameters:
listener
- The HTTP OAuth2 CTS Authorization Mechanism configuration change listener.
-
getBaseDn
String getBaseDn()
Gets the "base-dn" property.The base DN of the Core Token Service where access token are stored. (example: ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com)
- Returns:
- Returns the value of the "base-dn" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the HTTP OAuth2 CTS Authorization Mechanism implementation.
Default value:
org.opends.server.protocols.http.authz.HttpOAuth2CtsAuthorizationMechanism
- Specified by:
getJavaClass
in interfaceHttpAuthorizationMechanismCfg
- Returns:
- Returns the value of the "java-class" property.
-
-