Package org.forgerock.opendj.server.config.server

Interface HTTPOauth2FileAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg, HTTPOauth2AuthorizationMechanismCfg

public interface HTTPOauth2FileAuthorizationMechanismCfg
extends HTTPOauth2AuthorizationMechanismCfg

A server-side interface for querying HTTP Oauth2 File Authorization Mechanism settings.

The HTTP Oauth2 File 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

Modifier and Type	Method	Description
void	addHTTPOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2FileAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Oauth2 File Authorization Mechanism is changed.
Class<? extends HTTPOauth2FileAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class associated with this HTTP Oauth2 File 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 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, getIdentityMapperDN, getRequiredScope, isAccessTokenCacheEnabled, removeHTTPOauth2AuthorizationMechanismChangeListener

Method Detail

configurationClass

Class<? extends HTTPOauth2FileAuthorizationMechanismCfg> configurationClass()

Gets the configuration class associated with this HTTP Oauth2 File Authorization Mechanism.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPAuthorizationMechanismCfg

Specified by:

configurationClass in interface HTTPOauth2AuthorizationMechanismCfg

Returns:

Returns the configuration class associated with this HTTP Oauth2 File Authorization Mechanism.

addHTTPOauth2FileAuthorizationMechanismChangeListener

void addHTTPOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2FileAuthorizationMechanismCfg> listener)

Register to be notified when this HTTP Oauth2 File Authorization Mechanism is changed.

Parameters:

listener - The HTTP Oauth2 File Authorization Mechanism configuration change listener.

removeHTTPOauth2FileAuthorizationMechanismChangeListener

void removeHTTPOauth2FileAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2FileAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Oauth2 File Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Oauth2 File 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.

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 Authorization Mechanism implementation.

Specified by:

getJavaClass in interface HTTPAuthorizationMechanismCfg

Returns:

Returns the value of the "java-class" property.