Interface HttpOauth2FileAuthorizationMechanismCfg
-
- All Superinterfaces:
Configuration
,HttpAuthorizationMechanismCfg
,HttpOauth2AuthorizationMechanismCfg
public interface HttpOauth2FileAuthorizationMechanismCfg extends HttpOauth2AuthorizationMechanismCfg
A server-side interface for querying HTTP OAuth2 File Based Authorization Mechanism settings.The HTTP OAuth2 File Based Authorization Mechanism is used to define OAuth2 authorization through a file based access-token resolution. For test purpose only, this mechanism is looking up for JSON access-token files under the specified path.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addHttpOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2FileAuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 File Based Authorization Mechanism is changed.Class<? extends HttpOauth2FileAuthorizationMechanismCfg>
configurationClass()
Gets the configuration class associated with this HTTP OAuth2 File Based Authorization Mechanism.String
getAccessTokenDirectory()
Gets the "access-token-directory" property.String
getJavaClass()
Gets the "java-class" property.void
removeHttpOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2FileAuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 File Based 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 HttpOauth2FileAuthorizationMechanismCfg> configurationClass()
Gets the configuration class associated with this HTTP OAuth2 File Based 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 File Based Authorization Mechanism.
-
addHttpOauth2FileAuthorizationMechanismChangeListener
void addHttpOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2FileAuthorizationMechanismCfg> listener)
Register to be notified when this HTTP OAuth2 File Based Authorization Mechanism is changed.- Parameters:
listener
- The HTTP OAuth2 File Based Authorization Mechanism configuration change listener.
-
removeHttpOauth2FileAuthorizationMechanismChangeListener
void removeHttpOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HttpOauth2FileAuthorizationMechanismCfg> listener)
Deregister an existing HTTP OAuth2 File Based Authorization Mechanism configuration change listener.- Parameters:
listener
- The HTTP OAuth2 File Based Authorization Mechanism configuration change listener.
-
getAccessTokenDirectory
String getAccessTokenDirectory()
Gets the "access-token-directory" property.Directory containing token files. File names must be equal to the token strings. The file content must a JSON object with the following attributes: 'scope', 'expireTime' and all the field(s) needed to resolve the authzIdTemplate.
Default value:
oauth2-demo/
- Returns:
- Returns the value of the "access-token-directory" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the HTTP OAuth2 File Based Authorization Mechanism implementation.
Default value:
org.opends.server.protocols.http.authz.HttpOAuth2FileAuthorizationMechanism
- Specified by:
getJavaClass
in interfaceHttpAuthorizationMechanismCfg
- Returns:
- Returns the value of the "java-class" property.
-
-