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

Interface HttpOauth2CtsAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HttpAuthorizationMechanismCfgClient, HttpOauth2AuthorizationMechanismCfgClient

public interface HttpOauth2CtsAuthorizationMechanismCfgClient
extends HttpOauth2AuthorizationMechanismCfgClient

A client-side interface for reading and modifying HTTP OAuth2 CTS Authorization Mechanism settings.

The HTTP OAuth2 CTS Authorization Mechanism is used to define OAuth2 authorization through a direct access to the CTS (Core Token Service).

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends HttpOauth2CtsAuthorizationMechanismCfgClient,? extends HttpOauth2CtsAuthorizationMechanismCfg>	definition()	Get the configuration definition associated with this HTTP OAuth2 CTS Authorization Mechanism.
ValueOrExpression<String>	getBaseDn()	Gets the "base-dn" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setBaseDn(ValueOrExpression<String> value)	Sets the "base-dn" 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 HttpOauth2CtsAuthorizationMechanismCfgClient,? extends HttpOauth2CtsAuthorizationMechanismCfg> definition()

Get the configuration definition associated with this HTTP OAuth2 CTS 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 CTS Authorization Mechanism.

getBaseDn

@MandatoryProperty
ValueOrExpression<String> getBaseDn()

Gets the "base-dn" property.

The base DN of the Core Token Service where access token are stored. (example: ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com)

Returns:

Returns the value of the "base-dn" property.

setBaseDn

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

Sets the "base-dn" property.

The base DN of the Core Token Service where access token are stored. (example: ou=famrecords,ou=openam-session,ou=tokens,dc=example,dc=com)

Parameters:

value - The value of the "base-dn" 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 CTS Authorization Mechanism implementation.

Default value: org.opends.server.protocols.http.authz.HttpOAuth2CtsAuthorizationMechanism

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