com.ibm.itim.auditing

Class AuditLog

java.lang.Object

com.ibm.itim.auditing.AuditLog

public class AuditLog
extends java.lang.Object

This class provides an API to audit the events using the Identity Governance auditing framework. Auditing for a particular event category can be enabled or disabled in enroleAuditing.properties. Custom event categories should also be specified and enabled in enroleAuditing.properties.

Since:

IVIG 11.0.0

Method Summary

Modifier and Type	Method and Description
void	auditEvent(EventInfo eventInfo) Use this method to audit an event in Identity Governance audit log.
static AuditLog	getInstance() Returns an instance of AuditLog, creating a new one if necessary.
static boolean	isEventAuditable(java.lang.String eventType) Checks to see if this particular eventType is auditable per the configuration in enroleAuditing.properties
static boolean	isEventAuditable(java.lang.String eventType, java.lang.String operation) Checks if a particular event is auditable or not
static boolean	isEventAuditable(java.lang.String eventType, java.lang.String entityType, java.lang.String action) Checks if a particular event is auditable or not

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AuditLog getInstance()

Returns an instance of AuditLog, creating a new one if necessary.

Returns:

AuditLog singleton (unique) instance of AuditLog.

auditEvent

public void auditEvent(EventInfo eventInfo)
                throws com.ibm.itim.auditing.AuditingException

Use this method to audit an event in Identity Governance audit log.

Parameters:

eventInfo - Information of the event to be audited.

Throws:

AuditingException - if there was any issue auditing the event.

isEventAuditable

public static boolean isEventAuditable(java.lang.String eventType)

Checks to see if this particular eventType is auditable per the configuration in enroleAuditing.properties

Parameters:

eventType - Type of the event (eg. PersonManagement)

Returns:

true if the event type is enabled in the property file - false otherwise

isEventAuditable

public static boolean isEventAuditable(java.lang.String eventType,
                                       java.lang.String operation)

Checks if a particular event is auditable or not

Parameters:

eventType - Type of the event (eg. PersonManagement)

operation - Operation being performed: Authenticate or GetAuthenticationObject. May be null.

Returns:

true if the event type is enabled in the property file - false otherwise

isEventAuditable

public static boolean isEventAuditable(java.lang.String eventType,
                                       java.lang.String entityType,
                                       java.lang.String action)

Checks if a particular event is auditable or not

Parameters:

eventType - Type of the event (eg. PersonManagement)

entityType - Type of the entity. (eg. Host Policy for eventType = Policy Mgmt and action = Add) (NOT CURRENTLY USED)

action - Operation being performed (eg. ADD-Add Person, DELETE-Delete Person) (NOT CURRENTLY USED)

Returns:

true if the event type is enabled in the property file - false otherwise