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

Interface HTTPOauth2AuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg

All Known Subinterfaces:

HTTPOauth2CtsAuthorizationMechanismCfg, HTTPOauth2FileAuthorizationMechanismCfg, HTTPOauth2OpenamAuthorizationMechanismCfg, HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg

public interface HTTPOauth2AuthorizationMechanismCfg
extends HTTPAuthorizationMechanismCfg

A server-side interface for querying HTTP Oauth2 Authorization Mechanism settings.

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

Method Summary

Modifier and Type	Method	Description
void	addHTTPOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2AuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Oauth2 Authorization Mechanism is changed.
Class<? extends HTTPOauth2AuthorizationMechanismCfg>	configurationClass()	Gets the configuration class associated with this HTTP Oauth2 Authorization Mechanism.
Long	getAccessTokenCacheExpiration()	Gets the "access-token-cache-expiration" property.
String	getAuthzidJsonPointer()	Gets the "authzid-json-pointer" property.
String	getIdentityMapper()	Gets the "identity-mapper" property.
org.forgerock.opendj.ldap.DN	getIdentityMapperDN()	Gets the "identity-mapper" property as a DN.
SortedSet<String>	getRequiredScope()	Gets the "required-scope" property.
boolean	isAccessTokenCacheEnabled()	Gets the "access-token-cache-enabled" property.
void	removeHTTPOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2AuthorizationMechanismCfg> listener)	Deregister an existing HTTP Oauth2 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, getJavaClass, isEnabled, removeChangeListener

Method Detail

configurationClass

Class<? extends HTTPOauth2AuthorizationMechanismCfg> configurationClass()

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

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface HTTPAuthorizationMechanismCfg

Returns:

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

addHTTPOauth2AuthorizationMechanismChangeListener

void addHTTPOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2AuthorizationMechanismCfg> listener)

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

Parameters:

listener - The HTTP Oauth2 Authorization Mechanism configuration change listener.

removeHTTPOauth2AuthorizationMechanismChangeListener

void removeHTTPOauth2AuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2AuthorizationMechanismCfg> listener)

Deregister an existing HTTP Oauth2 Authorization Mechanism configuration change listener.

Parameters:

listener - The HTTP Oauth2 Authorization Mechanism configuration change listener.

isAccessTokenCacheEnabled

boolean isAccessTokenCacheEnabled()

Gets the "access-token-cache-enabled" property.

Indicates whether the HTTP Oauth2 Authorization Mechanism is enabled for use.

Returns:

Returns the value of the "access-token-cache-enabled" property.

getAccessTokenCacheExpiration

Long getAccessTokenCacheExpiration()

Gets the "access-token-cache-expiration" property.

Token cache expiration

Returns:

Returns the value of the "access-token-cache-expiration" property.

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)

Returns:

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

getIdentityMapper

String getIdentityMapper()

Gets the "identity-mapper" property.

> Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.

Returns:

Returns the value of the "identity-mapper" property.

getIdentityMapperDN

org.forgerock.opendj.ldap.DN getIdentityMapperDN()

Gets the "identity-mapper" property as a DN.

> Specifies the name of the identity mapper to use in conjunction with the authzid-json-pointer to get the user corresponding to the acccess-token.

Returns:

Returns the DN value of the "identity-mapper" property.

getRequiredScope

SortedSet<String> getRequiredScope()

Gets the "required-scope" property.

Scopes required to grant access to the service.

Returns:

Returns an unmodifiable set containing the values of the "required-scope" property.