org.forgerock.openam.rest.audit

Class RestletBodyAuditor<T>

java.lang.Object

org.forgerock.openam.rest.audit.RestletBodyAuditor<T>

All Implemented Interfaces:

org.forgerock.util.Function<org.restlet.representation.Representation,org.forgerock.json.JsonValue,org.forgerock.audit.AuditException>

public abstract class RestletBodyAuditor<T>
extends Object
implements org.forgerock.util.Function<org.restlet.representation.Representation,org.forgerock.json.JsonValue,org.forgerock.audit.AuditException>

Base auditor for extracting relevant information from request and response bodies

Method Summary

Modifier and Type	Method and Description
static RestletBodyAuditor	formAuditor(String... fields) Create a body auditor for post request form bodies.
static RestletBodyAuditor	jacksonAuditor(String... fields) Create a body auditor for JSON bodies.
static RestletBodyAuditor	jsonAuditor(String... fields) Create a body auditor for JSON bodies.
static RestletBodyAuditor<?>	noBodyAuditor() The body auditor for when there is no auditing required.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.util.Function

apply

Method Detail

jsonAuditor

public static RestletBodyAuditor jsonAuditor(String... fields)

Create a body auditor for JSON bodies.

Parameters:

fields - The fields that should be captured if they exist.

Returns:

The auditor object.

jacksonAuditor

public static RestletBodyAuditor jacksonAuditor(String... fields)

Create a body auditor for JSON bodies.

Parameters:

fields - The fields that should be captured if they exist.

Returns:

The auditor object.

formAuditor

public static RestletBodyAuditor formAuditor(String... fields)

Create a body auditor for post request form bodies.

Parameters:

fields - The fields that should be captured if they exist.

Returns:

The auditor object.

noBodyAuditor

public static RestletBodyAuditor<?> noBodyAuditor()

The body auditor for when there is no auditing required.

Returns:

null.