Package org.forgerock.am.trees.api

Interface NodeEventAuditor

public interface NodeEventAuditor

Logger for node audit events.

Method Summary

Modifier and Type	Method	Description
void	logAuditEvent(Tree tree, Action action, String nodeType, int nodeTypeVersion, UUID nodeId, String displayName, JsonValue sharedState, JsonValue extraNodeLogEntry)	Adds a log entry in the audit logs under the authentication topic with the information about the node being processed.

Method Details

logAuditEvent

void logAuditEvent(Tree tree,
 Action action,
 String nodeType,
 int nodeTypeVersion,
 UUID nodeId,
 String displayName,
 JsonValue sharedState,
 JsonValue extraNodeLogEntry)

Adds a log entry in the audit logs under the authentication topic with the information about the node being processed.

Parameters:

tree - the tree object we are logging about.

action - the action object with the details of the node that is being processed.

nodeType - the type of the node that is being processed.

nodeTypeVersion - the version of the type of the node that is being processed.

nodeId - the UUID of the node that is being processed.

displayName - the display name of the node.

sharedState - the current shared state of the tree.

extraNodeLogEntry - any extra information specific to the node we are processing. It can be empty if no node specific information needs to be logged.