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.
ValueOrExpression<Long>	getAccessTokenCacheExpiration()	Gets the "access-token-cache-expiration" property.
ValueOrExpression<String>	getAuthzidJsonPointer()	Gets the "authzid-json-pointer" property.
SortedSet<ValueOrExpression<String>>	getIdentityMapper()	Gets the "identity-mapper" property.
SortedSet<ValueOrExpression<String>>	getRequiredScope()	Gets the "required-scope" property.
ValueOrExpression<Boolean>	isAccessTokenCacheEnabled()	Gets the "access-token-cache-enabled" property.
void	setAccessTokenCacheEnabled(ValueOrExpression<Boolean> value)	Sets the "access-token-cache-enabled" property.
void	setAccessTokenCacheExpiration(ValueOrExpression<Long> value)	Sets the "access-token-cache-expiration" property.
void	setAuthzidJsonPointer(ValueOrExpression<String> value)	Sets the "authzid-json-pointer" property.
void	setIdentityMapper(Collection<ValueOrExpression<String>> values)	Sets the "identity-mapper" property.
void	setRequiredScope(Collection<ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<Boolean> isAccessTokenCacheEnabled()

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

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

Default value: false

Returns:

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

setAccessTokenCacheEnabled

@MandatoryProperty
void setAccessTokenCacheEnabled(ValueOrExpression<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

ValueOrExpression<Long> getAccessTokenCacheExpiration()

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

Token cache expiration

Default value is undefined

Returns:

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

setAccessTokenCacheExpiration

void setAccessTokenCacheExpiration(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<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.

Returns:

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

setAuthzidJsonPointer

@MandatoryProperty
void setAuthzidJsonPointer(ValueOrExpression<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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getIdentityMapper

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getIdentityMapper()

Gets the "identity-mapper" property.

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

Returns:

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

setIdentityMapper

@MandatoryProperty
void setIdentityMapper(Collection<ValueOrExpression<String>> values)
                throws PropertyException

Sets the "identity-mapper" property.

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

Parameters:

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

Throws:

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

getRequiredScope

@MandatoryProperty
SortedSet<ValueOrExpression<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

@MandatoryProperty
void setRequiredScope(Collection<ValueOrExpression<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.