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

Interface HTTPOauth2CtsAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg, HTTPOauth2AuthorizationMechanismCfg

public interface HTTPOauth2CtsAuthorizationMechanismCfg
extends HTTPOauth2AuthorizationMechanismCfg

A server-side interface for querying 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
void	addHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Oauth2 Cts Authorization Mechanism is changed.
Class<? extends HTTPOauth2CtsAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class 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	removeHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener)	Deregister an existing HTTP Oauth2 Cts Authorization Mechanism configuration change listener.

Methods inherited from interface org.forgerock.opendj.config.Configuration

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.HTTPAuthorizationMechanismCfg

addChangeListener, isEnabled, removeChangeListener

Methods inherited from interface org.forgerock.opendj.server.config.server.HTTPOauth2AuthorizationMechanismCfg

addHTTPOauth2AuthorizationMechanismChangeListener, getAccessTokenCacheExpiration, getIdentityMapper, getIdentityMapperDN, getRequiredScope, isAccessTokenCacheEnabled, removeHTTPOauth2AuthorizationMechanismChangeListener

Method Detail

configurationClass

Class<? extends HTTPOauth2CtsAuthorizationMechanismCfg> configurationClass()

Gets the configuration class associated with this HTTP Oauth2 Cts Authorization Mechanism.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPAuthorizationMechanismCfg

Specified by:

configurationClass in interface HTTPOauth2AuthorizationMechanismCfg

Returns:

Returns the configuration class associated with this HTTP Oauth2 Cts Authorization Mechanism.

addHTTPOauth2CtsAuthorizationMechanismChangeListener

void addHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener)

Register to be notified when this HTTP Oauth2 Cts Authorization Mechanism is changed.

Parameters:

listener - The HTTP Oauth2 Cts Authorization Mechanism configuration change listener.

removeHTTPOauth2CtsAuthorizationMechanismChangeListener

void removeHTTPOauth2CtsAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2CtsAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Oauth2 Cts Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Oauth2 Cts Authorization Mechanism configuration change listener.

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 HTTPOauth2AuthorizationMechanismCfg

Returns:

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

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.

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 HTTPAuthorizationMechanismCfg

Returns:

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