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

Class HttpOauth2FileAuthorizationMechanismCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<HttpOauth2FileAuthorizationMechanismCfgClient,HttpOauth2FileAuthorizationMechanismCfg>

org.forgerock.opendj.server.config.meta.HttpOauth2FileAuthorizationMechanismCfgDefn

public final class HttpOauth2FileAuthorizationMechanismCfgDefn
extends ManagedObjectDefinition<HttpOauth2FileAuthorizationMechanismCfgClient,HttpOauth2FileAuthorizationMechanismCfg>

An interface for querying the HTTP OAuth2 File Based Authorization Mechanism managed object definition meta information.

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
HttpOauth2FileAuthorizationMechanismCfgClient	createClientConfiguration(ManagedObject<? extends HttpOauth2FileAuthorizationMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
HttpOauth2FileAuthorizationMechanismCfg	createServerConfiguration(ServerManagedObject<? extends HttpOauth2FileAuthorizationMechanismCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getAccessTokenCacheEnabledPropertyDefinition()	Get the "access-token-cache-enabled" property definition.
DurationPropertyDefinition	getAccessTokenCacheExpirationPropertyDefinition()	Get the "access-token-cache-expiration" property definition.
StringPropertyDefinition	getAccessTokenDirectoryPropertyDefinition()	Get the "access-token-directory" property definition.
StringPropertyDefinition	getAuthzidJsonPointerPropertyDefinition()	Get the "authzid-json-pointer" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg>	getIdentityMapperPropertyDefinition()	Get the "identity-mapper" property definition.
static HttpOauth2FileAuthorizationMechanismCfgDefn	getInstance()	Get the HTTP OAuth2 File Based Authorization Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getRequiredScopePropertyDefinition()	Get the "required-scope" property definition.
Class<HttpOauth2FileAuthorizationMechanismCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static HttpOauth2FileAuthorizationMechanismCfgDefn getInstance()

Get the HTTP OAuth2 File Based Authorization Mechanism configuration definition singleton.

Returns:

Returns the HTTP OAuth2 File Based Authorization Mechanism configuration definition singleton.

createClientConfiguration

public HttpOauth2FileAuthorizationMechanismCfgClient createClientConfiguration(ManagedObject<? extends HttpOauth2FileAuthorizationMechanismCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<HttpOauth2FileAuthorizationMechanismCfgClient,HttpOauth2FileAuthorizationMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public HttpOauth2FileAuthorizationMechanismCfg createServerConfiguration(ServerManagedObject<? extends HttpOauth2FileAuthorizationMechanismCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HttpOauth2FileAuthorizationMechanismCfgClient,HttpOauth2FileAuthorizationMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<HttpOauth2FileAuthorizationMechanismCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HttpOauth2FileAuthorizationMechanismCfgClient,HttpOauth2FileAuthorizationMechanismCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAccessTokenCacheEnabledPropertyDefinition

public BooleanPropertyDefinition getAccessTokenCacheEnabledPropertyDefinition()

Get the "access-token-cache-enabled" property definition.

Indicates whether the HTTP OAuth2 File Based Authorization Mechanism is enabled for use.

Returns:

Returns the "access-token-cache-enabled" property definition.

getAccessTokenCacheExpirationPropertyDefinition

public DurationPropertyDefinition getAccessTokenCacheExpirationPropertyDefinition()

Get the "access-token-cache-expiration" property definition.

Token cache expiration

Returns:

Returns the "access-token-cache-expiration" property definition.

getAccessTokenDirectoryPropertyDefinition

public StringPropertyDefinition getAccessTokenDirectoryPropertyDefinition()

Get the "access-token-directory" property definition.

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 "access-token-directory" property definition.

getAuthzidJsonPointerPropertyDefinition

public StringPropertyDefinition getAuthzidJsonPointerPropertyDefinition()

Get the "authzid-json-pointer" property definition.

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 "authzid-json-pointer" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the HTTP OAuth2 File Based Authorization Mechanism is enabled.

Returns:

Returns the "enabled" property definition.

getIdentityMapperPropertyDefinition

public AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg> getIdentityMapperPropertyDefinition()

Get the "identity-mapper" property definition.

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 "identity-mapper" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getRequiredScopePropertyDefinition

public StringPropertyDefinition getRequiredScopePropertyDefinition()

Get the "required-scope" property definition.

Scopes required to grant access to the service.

Returns:

Returns the "required-scope" property definition.