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

Interface HTTPOauth2OpenamAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg, HTTPOauth2AuthorizationMechanismCfg

public interface HTTPOauth2OpenamAuthorizationMechanismCfg
extends HTTPOauth2AuthorizationMechanismCfg

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

The HTTP Oauth2 Openam Authorization Mechanism is used to define OAuth2 authorization using an OpenAM server as authorization server .

Method Summary

Modifier and Type	Method	Description
void	addHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener)	Register to be notified when this HTTP Oauth2 Openam Authorization Mechanism is changed.
Class<? extends HTTPOauth2OpenamAuthorizationMechanismCfg>	configurationClass()	Gets the configuration class associated with this HTTP Oauth2 Openam Authorization Mechanism.
String	getAuthzidJsonPointer()	Gets the "authzid-json-pointer" property.
String	getJavaClass()	Gets the "java-class" property.
String	getKeyManagerProvider()	Gets the "key-manager-provider" property.
org.forgerock.opendj.ldap.DN	getKeyManagerProviderDN()	Gets the "key-manager-provider" property as a DN.
String	getTokenInfoUrl()	Gets the "token-info-url" property.
String	getTrustManagerProvider()	Gets the "trust-manager-provider" property.
org.forgerock.opendj.ldap.DN	getTrustManagerProviderDN()	Gets the "trust-manager-provider" property as a DN.
void	removeHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener)	Deregister an existing HTTP Oauth2 Openam 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 HTTPOauth2OpenamAuthorizationMechanismCfg> configurationClass()

Gets the configuration class associated with this HTTP Oauth2 Openam 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 Openam Authorization Mechanism.

addHTTPOauth2OpenamAuthorizationMechanismChangeListener

void addHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener)

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

Parameters:

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

removeHTTPOauth2OpenamAuthorizationMechanismChangeListener

void removeHTTPOauth2OpenamAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2OpenamAuthorizationMechanismCfg> listener)

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

Parameters:

listener - The HTTP Oauth2 Openam 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.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Oauth2 Openam Authorization Mechanism implementation.

Specified by:

getJavaClass in interface HTTPAuthorizationMechanismCfg

Returns:

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

getKeyManagerProvider

String getKeyManagerProvider()

Gets the "key-manager-provider" property.

Specifies the name of the key manager that should be used with this HTTP Oauth2 Openam Authorization Mechanism .

Returns:

Returns the value of the "key-manager-provider" property.

getKeyManagerProviderDN

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

Gets the "key-manager-provider" property as a DN.

Specifies the name of the key manager that should be used with this HTTP Oauth2 Openam Authorization Mechanism .

Returns:

Returns the DN value of the "key-manager-provider" property.

getTokenInfoUrl

String getTokenInfoUrl()

Gets the "token-info-url" property.

Defines the OpenAM endpoint URL where the access-token resolution request should be sent.

Returns:

Returns the value of the "token-info-url" property.

getTrustManagerProvider

String getTrustManagerProvider()

Gets the "trust-manager-provider" property.

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

Returns:

Returns the value of the "trust-manager-provider" property.

getTrustManagerProviderDN

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

Gets the "trust-manager-provider" property as a DN.

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

Returns:

Returns the DN value of the "trust-manager-provider" property.