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.
String	getAuthzidJsonPointer()	Gets the "authzid-json-pointer" property.
String	getBaseDN()	Gets the "base-dn" property.
String	getJavaClass()	Gets the "java-class" property.
void	setAuthzidJsonPointer(String value)	Sets the "authzid-json-pointer" property.
void	setBaseDN(String value)	Sets the "base-dn" property.
void	setJavaClass(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, getIdentityMapper, getRequiredScope, isAccessTokenCacheEnabled, setAccessTokenCacheEnabled, setAccessTokenCacheExpiration, 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.

getAuthzidJsonPointer

String getAuthzidJsonPointer()

Gets the "authzid-json-pointer" property.

Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document. (example: /uid)

Specified by:

getAuthzidJsonPointer in interface HTTPOauth2AuthorizationMechanismCfgClient

Returns:

Returns the value of the "authzid-json-pointer" property.

setAuthzidJsonPointer

void setAuthzidJsonPointer(String value)
                    throws PropertyException

Sets the "authzid-json-pointer" property.

Specifies the JSON pointer to the value to use as Authorization ID. The JSON pointer is applied to the resolved access token JSON document. (example: /uid)

Specified by:

setAuthzidJsonPointer in interface HTTPOauth2AuthorizationMechanismCfgClient

Parameters:

value - The value of the "authzid-json-pointer" property.

Throws:

PropertyException - If the new value is invalid.

getBaseDN

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

void setBaseDN(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

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.

Specified by:

getJavaClass in interface HTTPAuthorizationMechanismCfgClient

Returns:

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

setJavaClass

void setJavaClass(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.