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

Class HttpOauth2AuthorizationMechanismCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<HttpOauth2AuthorizationMechanismCfgClient,HttpOauth2AuthorizationMechanismCfg>

org.forgerock.opendj.server.config.meta.HttpOauth2AuthorizationMechanismCfgDefn

public final class HttpOauth2AuthorizationMechanismCfgDefn
extends AbstractManagedObjectDefinition<HttpOauth2AuthorizationMechanismCfgClient,HttpOauth2AuthorizationMechanismCfg>

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

The HTTP OAuth2 Authorization Mechanism is used to define HTTP OAuth2 authorization mechanism.

Method Summary

Modifier and Type	Method	Description
BooleanPropertyDefinition	getAccessTokenCacheEnabledPropertyDefinition()	Get the "access-token-cache-enabled" property definition.
DurationPropertyDefinition	getAccessTokenCacheExpirationPropertyDefinition()	Get the "access-token-cache-expiration" 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 HttpOauth2AuthorizationMechanismCfgDefn	getInstance()	Get the HTTP OAuth2 Authorization Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getRequiredScopePropertyDefinition()	Get the "required-scope" property 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 HttpOauth2AuthorizationMechanismCfgDefn getInstance()

Get the HTTP OAuth2 Authorization Mechanism configuration definition singleton.

Returns:

Returns the HTTP OAuth2 Authorization Mechanism configuration definition singleton.

getAccessTokenCacheEnabledPropertyDefinition

public BooleanPropertyDefinition getAccessTokenCacheEnabledPropertyDefinition()

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

Indicates whether the HTTP OAuth2 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.

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