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

Interface HttpOauth2FileAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HttpAuthorizationMechanismCfgClient, HttpOauth2AuthorizationMechanismCfgClient

public interface HttpOauth2FileAuthorizationMechanismCfgClient
extends HttpOauth2AuthorizationMechanismCfgClient

A client-side interface for reading and modifying 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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends HttpOauth2FileAuthorizationMechanismCfgClient,? extends HttpOauth2FileAuthorizationMechanismCfg>	definition()	Get the configuration definition associated with this HTTP OAuth2 File Based Authorization Mechanism.
ValueOrExpression<String>	getAccessTokenDirectory()	Gets the "access-token-directory" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setAccessTokenDirectory(ValueOrExpression<String> value)	Sets the "access-token-directory" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.HttpAuthorizationMechanismCfgClient

isEnabled, setEnabled

Methods inherited from interface org.forgerock.opendj.server.config.client.HttpOauth2AuthorizationMechanismCfgClient

getAccessTokenCacheExpiration, getAuthzidJsonPointer, getIdentityMapper, getRequiredScope, isAccessTokenCacheEnabled, setAccessTokenCacheEnabled, setAccessTokenCacheExpiration, setAuthzidJsonPointer, setIdentityMapper, setRequiredScope

Method Detail

definition

ManagedObjectDefinition<? extends HttpOauth2FileAuthorizationMechanismCfgClient,? extends HttpOauth2FileAuthorizationMechanismCfg> definition()

Get the configuration definition associated with this HTTP OAuth2 File Based Authorization Mechanism.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HttpAuthorizationMechanismCfgClient

Specified by:

definition in interface HttpOauth2AuthorizationMechanismCfgClient

Returns:

Returns the configuration definition associated with this HTTP OAuth2 File Based Authorization Mechanism.

getAccessTokenDirectory

@MandatoryProperty
ValueOrExpression<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.

setAccessTokenDirectory

@MandatoryProperty
void setAccessTokenDirectory(ValueOrExpression<String> value)
                      throws PropertyException

Sets 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.

Parameters:

value - The value of the "access-token-directory" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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 interface HttpAuthorizationMechanismCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP OAuth2 File Based Authorization Mechanism implementation.

Specified by:

setJavaClass in interface HttpAuthorizationMechanismCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.