org.forgerock.caf.authn.test.runtime

Class TestAuditApi

java.lang.Object

org.forgerock.caf.authn.test.runtime.TestAuditApi

All Implemented Interfaces:

AuditApi

public class TestAuditApi
extends Object
implements AuditApi

Test implementation of the JASPI runtime's AuditApi interface.

Stores each of the audit records locally and provides methods for reading and clearing the stored audit records.

Since:

1.5.0

Constructor Summary

Constructors

Constructor and Description
TestAuditApi()

Method Summary

Modifier and Type	Method and Description
void	audit(JsonValue auditMessage) Audits the authentication request, using the audit information from the given audit message.
void	clear() Clears the stored audit records.
static AuditApi	getAuditApi() Factory method called by the Jaspi runtime to get the instance of the AuditApi to use when auditing authentication requests.
List<JsonValue>	getAuditRecords() Gets the audit records.

Methods inherited from class java.lang.Object

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

Constructor Detail

TestAuditApi

public TestAuditApi()

Method Detail

getAuditApi

public static AuditApi getAuditApi()

Factory method called by the Jaspi runtime to get the instance of the AuditApi to use when auditing authentication requests.

Returns:

An instance of the TestAuditApi.

audit

public void audit(JsonValue auditMessage)

Audits the authentication request, using the audit information from the given audit message.

For successful authentications:

{ "result": "SUCCESSFUL", "requestId": "...", "principal": [ "demo" ], "context": { ... }, "sessionId": "...", "entries": [ { "moduleId": "Session-JwtSessionModule", "result": "SUCCESSFUL", "info": { "principal": "alice", "...": "...", ... } }, ... ], "transactionId" : "..." }

For failed authentications:

{ "result": "FAILED", "requestId": "...", "principal": [ "demo", ... //Multiple auth modules could identify different principals ], "context": { ... }, "entries": [ { "moduleId": "Session-JwtSessionModule", "result": "FAILED", "reason": "...", "info": { "principal": "bob", "...": "...", ... } }, ... ], "transactionId" : "..." }

Specified by:

audit in interface AuditApi

Parameters:

auditMessage - The audit message.

getAuditRecords

public List<JsonValue> getAuditRecords()

Gets the audit records.

Returns:

The audit records.

clear

public void clear()

Clears the stored audit records.