org.forgerock.caf.authn.test.configuration

Class AuditResource

java.lang.Object

org.forgerock.caf.authn.test.configuration.AuditResource

All Implemented Interfaces:

SingletonResourceProvider

public class AuditResource
extends Object
implements SingletonResourceProvider

CREST resource responsible for exposing the audit records created by the JASPI runtime.

The resource offers only two operations, read and an action of "readAndClear". Performing a read will simply read the audit records and performing a "readAndClear" action will read and clear the audit records.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
AuditResource(TestAuditApi auditApi) Constructs a new AuditResource instance.

Method Summary

Modifier and Type	Method and Description
Promise<ActionResponse,ResourceException>	actionInstance(Context context, ActionRequest request) Only the "readAndClear" action is supported, which will read the audit records and then subsequently clear them.
Promise<ResourceResponse,ResourceException>	patchInstance(Context context, PatchRequest request) Unsupported operation.
Promise<ResourceResponse,ResourceException>	readInstance(Context context, ReadRequest request) Will perform a read of the audit records.
Promise<ResourceResponse,ResourceException>	updateInstance(Context context, UpdateRequest request) Unsupported operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditResource

@Inject
public AuditResource(TestAuditApi auditApi)

Constructs a new AuditResource instance.

Parameters:

auditApi - An instance of the TestAuditApi, which stores the audit records made by the JASPI runtime.

Method Detail

actionInstance

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

Only the "readAndClear" action is supported, which will read the audit records and then subsequently clear them.

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 audit records.

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)

Unsupported operation.

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)