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

Class HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>

org.forgerock.opendj.server.config.meta.HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn

public final class HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn
extends ManagedObjectDefinition<HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>

An interface for querying the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism managed object definition meta information.

The HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism is used to define OAuth2 authorization using an introspection (RFC7662) compliant authorization server.

Method Summary

Modifier and Type	Method	Description
HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient	createClientConfiguration(ManagedObject<? extends HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient> impl)	Creates a client configuration view of the provided managed object.
HttpOauth2TokenIntrospectionAuthorizationMechanismCfg	createServerConfiguration(ServerManagedObject<? extends HttpOauth2TokenIntrospectionAuthorizationMechanismCfg> 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	getAuthzidJsonPointerPropertyDefinition()	Get the "authzid-json-pointer" property definition.
StringPropertyDefinition	getClientIdPropertyDefinition()	Get the "client-id" property definition.
StringPropertyDefinition	getClientSecretPropertyDefinition()	Get the "client-secret" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
AggregationPropertyDefinition<IdentityMapperCfgClient,IdentityMapperCfg>	getIdentityMapperPropertyDefinition()	Get the "identity-mapper" property definition.
static HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn	getInstance()	Get the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg>	getKeyManagerProviderPropertyDefinition()	Get the "key-manager-provider" property definition.
StringPropertyDefinition	getRequiredScopePropertyDefinition()	Get the "required-scope" property definition.
Class<HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getSslCertNicknamePropertyDefinition()	Get the "ssl-cert-nickname" property definition.
StringPropertyDefinition	getSslCipherSuitePropertyDefinition()	Get the "ssl-cipher-suite" property definition.
StringPropertyDefinition	getSslProtocolPropertyDefinition()	Get the "ssl-protocol" property definition.
StringPropertyDefinition	getTokenIntrospectionUrlPropertyDefinition()	Get the "token-introspection-url" property definition.
AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg>	getTrustManagerProviderPropertyDefinition()	Get the "trust-manager-provider" 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 HttpOauth2TokenIntrospectionAuthorizationMechanismCfgDefn getInstance()

Get the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism configuration definition singleton.

Returns:

Returns the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism configuration definition singleton.

createClientConfiguration

public HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient createClientConfiguration(ManagedObject<? extends HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient> 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<HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<HttpOauth2TokenIntrospectionAuthorizationMechanismCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<HttpOauth2TokenIntrospectionAuthorizationMechanismCfgClient,HttpOauth2TokenIntrospectionAuthorizationMechanismCfg>

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 Token Introspection (RFC 7662) 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.

getClientIdPropertyDefinition

public StringPropertyDefinition getClientIdPropertyDefinition()

Get the "client-id" property definition.

Client's ID to use during the HTTP basic authentication against the authorization server.

Returns:

Returns the "client-id" property definition.

getClientSecretPropertyDefinition

public StringPropertyDefinition getClientSecretPropertyDefinition()

Get the "client-secret" property definition.

Client's secret to use during the HTTP basic authentication against the authorization server.

Returns:

Returns the "client-secret" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the HTTP OAuth2 Token Introspection (RFC 7662) 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 Token Introspection (RFC 7662) Authorization Mechanism implementation.

Returns:

Returns the "java-class" property definition.

getKeyManagerProviderPropertyDefinition

public AggregationPropertyDefinition<KeyManagerProviderCfgClient,KeyManagerProviderCfg> getKeyManagerProviderPropertyDefinition()

Get the "key-manager-provider" property definition.

Specifies the name of the key manager that should be used with this HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism .

Returns:

Returns the "key-manager-provider" 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.

getSslCertNicknamePropertyDefinition

public StringPropertyDefinition getSslCertNicknamePropertyDefinition()

Get the "ssl-cert-nickname" property definition.

Specifies the nicknames (also called the aliases) of the keys or key pairs that the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism should use when performing SSL communication.

The property can be used multiple times (referencing different nicknames) when server certificates with different public key algorithms are used in parallel (for example, RSA, DSA, and ECC-based algorithms). When a nickname refers to an asymmetric (public/private) key pair, the nickname for the public key certificate and associated private key entry must match exactly. A single nickname is used to retrieve both the public key and the private key. This is only applicable when the HTTP OAuth2 Token Introspection (RFC 7662) Authorization Mechanism is configured to use SSL.

Returns:

Returns the "ssl-cert-nickname" property definition.

getSslCipherSuitePropertyDefinition

public StringPropertyDefinition getSslCipherSuitePropertyDefinition()

Get the "ssl-cipher-suite" property definition.

Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS communication.

Returns:

Returns the "ssl-cipher-suite" property definition.

getSslProtocolPropertyDefinition

public StringPropertyDefinition getSslProtocolPropertyDefinition()

Get the "ssl-protocol" property definition.

Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.

Returns:

Returns the "ssl-protocol" property definition.

getTokenIntrospectionUrlPropertyDefinition

public StringPropertyDefinition getTokenIntrospectionUrlPropertyDefinition()

Get the "token-introspection-url" property definition.

Defines the token introspection endpoint URL where the access-token resolution request should be sent. (example: http://example.com/introspect)

Returns:

Returns the "token-introspection-url" property definition.

getTrustManagerProviderPropertyDefinition

public AggregationPropertyDefinition<TrustManagerProviderCfgClient,TrustManagerProviderCfg> getTrustManagerProviderPropertyDefinition()

Get the "trust-manager-provider" property definition.

Specifies the name of the trust manager that should be used when negotiating SSL connections with the remote authorization server.

Returns:

Returns the "trust-manager-provider" property definition.