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

Interface HTTPOauth2OpenamAuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HTTPAuthorizationMechanismCfgClient, HTTPOauth2AuthorizationMechanismCfgClient

public interface HTTPOauth2OpenamAuthorizationMechanismCfgClient
extends HTTPOauth2AuthorizationMechanismCfgClient

A client-side interface for reading and modifying 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
ManagedObjectDefinition<? extends HTTPOauth2OpenamAuthorizationMechanismCfgClient,? extends HTTPOauth2OpenamAuthorizationMechanismCfg>	definition()	Get the configuration definition 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.
String	getTokenInfoUrl()	Gets the "token-info-url" property.
String	getTrustManagerProvider()	Gets the "trust-manager-provider" property.
void	setAuthzidJsonPointer(String value)	Sets the "authzid-json-pointer" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setKeyManagerProvider(String value)	Sets the "key-manager-provider" property.
void	setTokenInfoUrl(String value)	Sets the "token-info-url" property.
void	setTrustManagerProvider(String value)	Sets the "trust-manager-provider" 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 HTTPOauth2OpenamAuthorizationMechanismCfgClient,? extends HTTPOauth2OpenamAuthorizationMechanismCfg> definition()

Get the configuration definition associated with this HTTP Oauth2 Openam 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 Openam 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.

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 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 Openam 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.

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.

setKeyManagerProvider

void setKeyManagerProvider(String value)
                    throws PropertyException

Sets the "key-manager-provider" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setTokenInfoUrl

void setTokenInfoUrl(String value)
              throws PropertyException

Sets the "token-info-url" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setTrustManagerProvider

void setTrustManagerProvider(String value)
                      throws PropertyException

Sets 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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.