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

Interface HTTPOauth2AuthorizationMechanismCfgClient

All Superinterfaces:

ConfigurationClient, HTTPAuthorizationMechanismCfgClient

All Known Subinterfaces:

HTTPOauth2CtsAuthorizationMechanismCfgClient, HTTPOauth2FileAuthorizationMechanismCfgClient, HTTPOauth2OpenamAuthorizationMechanismCfgClient, HTTPOauth2TokenIntrospectionAuthorizationMechanismCfgClient

public interface HTTPOauth2AuthorizationMechanismCfgClient
extends HTTPAuthorizationMechanismCfgClient

A client-side interface for reading and modifying 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
ManagedObjectDefinition<? extends HTTPOauth2AuthorizationMechanismCfgClient,? extends HTTPOauth2AuthorizationMechanismCfg>	definition()	Get the configuration definition 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.
SortedSet<String>	getRequiredScope()	Gets the "required-scope" property.
boolean	isAccessTokenCacheEnabled()	Gets the "access-token-cache-enabled" property.
void	setAccessTokenCacheEnabled(boolean value)	Sets the "access-token-cache-enabled" property.
void	setAccessTokenCacheExpiration(Long value)	Sets the "access-token-cache-expiration" property.
void	setAuthzidJsonPointer(String value)	Sets the "authzid-json-pointer" property.
void	setIdentityMapper(String value)	Sets the "identity-mapper" property.
void	setRequiredScope(Collection<String> values)	Sets the "required-scope" property.

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

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.HTTPAuthorizationMechanismCfgClient

getJavaClass, isEnabled, setEnabled, setJavaClass

Method Detail

definition

ManagedObjectDefinition<? extends HTTPOauth2AuthorizationMechanismCfgClient,? extends HTTPOauth2AuthorizationMechanismCfg> definition()

Get the configuration definition associated with this HTTP Oauth2 Authorization Mechanism.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface HTTPAuthorizationMechanismCfgClient

Returns:

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

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.

setAccessTokenCacheEnabled

void setAccessTokenCacheEnabled(boolean value)
                         throws PropertyException

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

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getAccessTokenCacheExpiration

Long getAccessTokenCacheExpiration()

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

Token cache expiration

Returns:

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

setAccessTokenCacheExpiration

void setAccessTokenCacheExpiration(Long value)
                            throws PropertyException

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

Token cache expiration

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

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)

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

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.

setIdentityMapper

void setIdentityMapper(String value)
                throws PropertyException

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getRequiredScope

SortedSet<String> getRequiredScope()

Gets the "required-scope" property.

Scopes required to grant access to the service.

Returns:

Returns the values of the "required-scope" property.

setRequiredScope

void setRequiredScope(Collection<String> values)
               throws PropertyException

Sets the "required-scope" property.

Scopes required to grant access to the service.

Parameters:

values - The values of the "required-scope" property.

Throws:

PropertyException - If one or more of the new values are invalid.