org.forgerock.opendj.server.config.server

Interface HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg

All Superinterfaces:

Configuration, HTTPAuthorizationMechanismCfg, HTTPOauth2AuthorizationMechanismCfg

public interface HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg
extends HTTPOauth2AuthorizationMechanismCfg

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

The HTTP Oauth2 Token Introspection Authorization Mechanism is used to define OAuth2 authorization using an introspection (RFC7662) compliant authorization server.

Method Summary

Modifier and Type	Method and Description
void	addHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> listener) Register to be notified when this HTTP Oauth2 Token Introspection Authorization Mechanism is changed.
Class<? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg>	configurationClass() Gets the configuration class associated with this HTTP Oauth2 Token Introspection Authorization Mechanism.
String	getAuthzidJsonPointer() Gets the "authzid-json-pointer" property.
String	getClientId() Gets the "client-id" property.
String	getClientSecret() Gets the "client-secret" 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	getTokenIntrospectionUrl() Gets the "token-introspection-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	removeHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> listener) Deregister an existing HTTP Oauth2 Token Introspection Authorization Mechanism configuration change listener.

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

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

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

addChangeListener, isEnabled, removeChangeListener

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

dn, name

Method Detail

configurationClass

Class<? extends HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> configurationClass()

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

addHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener

void addHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> listener)

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

Parameters:

listener - The HTTP Oauth2 Token Introspection Authorization Mechanism configuration change listener.

removeHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener

void removeHTTPOauth2TokenIntrospectionAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPOauth2TokenIntrospectionAuthorizationMechanismCfg> listener)

Deregister an existing HTTP Oauth2 Token Introspection Authorization Mechanism configuration change listener.

Parameters:

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

getClientId

String getClientId()

Gets the "client-id" property.

Client's ID to use during the HTTP basic authentication against the authorization server.

Returns:

Returns the value of the "client-id" property.

getClientSecret

String getClientSecret()

Gets the "client-secret" property.

Client's secret to use during the HTTP basic authentication against the authorization server.

Returns:

Returns the value of the "client-secret" property.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the HTTP Oauth2 Token Introspection 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 Token Introspection 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 Token Introspection Authorization Mechanism .

Returns:

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

getTokenIntrospectionUrl

String getTokenIntrospectionUrl()

Gets the "token-introspection-url" property.

Defines the token introspection endpoint URL where the access-token resolution request should be sent. (example: http://example.com/introspect)

Returns:

Returns the value of the "token-introspection-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.