org.forgerock.caf.authn.test.configuration

Class ConfigurationResource

java.lang.Object

org.forgerock.caf.authn.test.configuration.ConfigurationResource

All Implemented Interfaces:

SingletonResourceProvider

public class ConfigurationResource
extends Object
implements SingletonResourceProvider

CREST resource responsible for exposing the module configuration of the JASPI runtime.

The resource offers only two operations, read and update. Performing a read will simply read the JASPI runtime's current module configuration and performing an update will update the runtime's module configuration which will be used for every subsequent request.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
ConfigurationResource()

Method Summary

Modifier and Type	Method and Description
Promise<ActionResponse,ResourceException>	actionInstance(Context context, ActionRequest request) Unsupported operation.
Promise<ResourceResponse,ResourceException>	patchInstance(Context context, PatchRequest request) Unsupported operation.
Promise<ResourceResponse,ResourceException>	readInstance(Context context, ReadRequest request) Will perform a read of the runtime's module configuration.
Promise<ResourceResponse,ResourceException>	updateInstance(Context context, UpdateRequest request) Will perform an update of the runtime's module configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationResource

public ConfigurationResource()

Method Detail

actionInstance

public Promise<ActionResponse,ResourceException> actionInstance(Context context,
                                                                ActionRequest request)

Unsupported operation.

Specified by:

actionInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The action request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleAction(Context, ActionRequest)

patchInstance

public Promise<ResourceResponse,ResourceException> patchInstance(Context context,
                                                                 PatchRequest request)

Unsupported operation.

Specified by:

patchInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The patch request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handlePatch(Context, PatchRequest)

readInstance

public Promise<ResourceResponse,ResourceException> readInstance(Context context,
                                                                ReadRequest request)

Will perform a read of the runtime's module configuration.

Specified by:

readInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The read request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleRead(Context, ReadRequest)

updateInstance

public Promise<ResourceResponse,ResourceException> updateInstance(Context context,
                                                                  UpdateRequest request)

Will perform an update of the runtime's module configuration.

Specified by:

updateInstance in interface SingletonResourceProvider

Parameters:

context - The request server context.

request - The update request.

Returns:

A Promise containing the result of the operation.

See Also:

RequestHandler.handleUpdate(Context, UpdateRequest)