Package org.forgerock.openig.tools.notifications

Class AuditUtils

java.lang.Object

org.forgerock.openig.tools.notifications.AuditUtils

public final class AuditUtils
extends Object

Utility class.

Method Summary

Modifier and Type	Method	Description
static NotificationAuditor	notificationAuditor(AuditService auditService, boolean auditIgnoredNotifications, Clock clock, org.forgerock.openig.tracing.TracingProvider tracingProvider)	Create an implementation of the NotificationAuditor to use to audit notifications.
static Map<String,JsonValue>	notificationsAuditSchema()	Return a Map that represents the JSON schema for the notifications audit event.

Methods inherited from class java.lang.Object

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

Method Details

notificationAuditor

public static NotificationAuditor notificationAuditor(AuditService auditService,
 boolean auditIgnoredNotifications,
 Clock clock,
 org.forgerock.openig.tracing.TracingProvider tracingProvider)

Create an implementation of the NotificationAuditor to use to audit notifications. If the audit service is not running or is not auditing notifications, the result will be a no-op implementation.

Parameters:

auditService - the AuditService to use

auditIgnoredNotifications - when true (and auditing is enabled), all notifications will be audited, even if they do not trigger a change in state.

clock - the Clock to use when generating audit events

tracingProvider - the TracingProvider to use to create a tracing context for the audit event

Returns:

an implementation of the NotificationAuditor to use to audit notifications

notificationsAuditSchema

public static Map<String,JsonValue> notificationsAuditSchema()

Return a Map that represents the JSON schema for the notifications audit event.

Returns:

a Map that represents the JSON schema for the notifications audit event