com.tsgrp.opencontent.core.audit

Class AuditUtil

java.lang.Object

com.tsgrp.opencontent.core.audit.AuditUtil

public class AuditUtil
extends java.lang.Object

Util class for common audit functionality.

Constructor Summary

Constructors

Constructor and Description
AuditUtil()

Method Summary

Modifier and Type	Method and Description
static OCAuditEvent	buildAuditEventObject(java.lang.String objectId, java.lang.String userName, java.lang.String displayName, java.lang.String eventName, java.lang.String eventDescription, java.util.Map<java.lang.String,java.lang.String> extrasMap) This method is used to build up an audit object.
static void	createAuditEvent(java.lang.String ticket, java.lang.String objectId, java.lang.String eventDescription, java.lang.String eventName) Helper-method that starts an audit event.
static java.lang.String	mapToString(java.util.Map<java.lang.String,java.lang.String> extras) Converts a map of extras to an string to be stored in AuditEventObject's attribute list.
static java.lang.String[]	mapToStringList(java.util.Map<java.lang.String,java.lang.String> extras) Converts a map of extras to an string to be stored in AuditEventObject's attribute list.
static java.util.Map<java.lang.String,java.lang.String>	stringListToMap(java.lang.String[] stringList) Splits a String array into a map.
static java.util.Map<java.lang.String,java.lang.String>	stringToMap(java.lang.String attrList) Splits a String on a pipe delimiter and separates each resulting pair into a map.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditUtil

public AuditUtil()

Method Detail

stringToMap

public static java.util.Map<java.lang.String,java.lang.String> stringToMap(java.lang.String attrList)

Splits a String on a pipe delimiter and separates each resulting pair into a map. A pair is defined as being a key=value string. For example, a provided string "attr1=val1|attr2=val2" will result in a map with two entries (attr1, val1) and (attr2, val2). "attr1=|attr2=val2" would result in a map with two entries (attr1, "") and (attr2, val2).

Parameters:

attrList - the string representation of the list to separate into our map.

Returns:

a map of the different pairs contained in the provided string.

stringListToMap

public static java.util.Map<java.lang.String,java.lang.String> stringListToMap(java.lang.String[] stringList)

Splits a String array into a map. A pair is defined as being a key=value string. For example, a provided string array with two entries ["attr1=val1", "attr2=val2"] will result in a map with two entries (attr1, val1) and (attr2, val2). ["attr1=", "attr2=val2"] would result in a map with two entries (attr1, "") and (attr2, val2).

Parameters:

stringList - the string array with paris to separate into our map.

Returns:

a map of the different pairs contained in the provided string.

mapToString

public static java.lang.String mapToString(java.util.Map<java.lang.String,java.lang.String> extras)

Converts a map of extras to an string to be stored in AuditEventObject's attribute list. The returned string will have each entry in the map separated by a pipe and each entry will be a key=value substring.

Parameters:

extras - the map of extras to convert into a string.

Returns:

a string with each entry in the map separated by a pipe and each entry being a key=value substring.

mapToStringList

public static java.lang.String[] mapToStringList(java.util.Map<java.lang.String,java.lang.String> extras)

Converts a map of extras to an string to be stored in AuditEventObject's attribute list. The returned string will have each entry in the map separated by a pipe and each entry will be a key=value substring.

Parameters:

extras - the map of extras to convert into a string.

Returns:

a string with each entry in the map separated by a pipe and each entry being a key=value substring.

buildAuditEventObject

public static OCAuditEvent buildAuditEventObject(java.lang.String objectId,
                                                 java.lang.String userName,
                                                 java.lang.String displayName,
                                                 java.lang.String eventName,
                                                 java.lang.String eventDescription,
                                                 java.util.Map<java.lang.String,java.lang.String> extrasMap)

This method is used to build up an audit object.

Parameters:

objectId - The objectId of the object we are auditing

userName - The user name of the user involved with the audit

displayName - The Display name of the user involved with the audit

extrasMap - The map of extra properties

eventName - The name of the audit event

eventDescription - The description of the audit event

extrasMap - The map of extra properties. Now you have the option to set the audit event date from the source by passing the value under the key auditDate in the extras map.

createAuditEvent

public static void createAuditEvent(java.lang.String ticket,
                                    java.lang.String objectId,
                                    java.lang.String eventDescription,
                                    java.lang.String eventName)

Helper-method that starts an audit event.

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the redacted document.

eventDescription - the event description

eventName - the event name