com.day.cq.audit

Class AuditLogEntry

java.lang.Object

com.day.cq.audit.AuditLogEntry

All Implemented Interfaces:

java.io.Serializable

public class AuditLogEntry
extends java.lang.Object
implements java.io.Serializable

The AuditEvent class represents the class for an audit event.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	category category
protected java.lang.String	path path
protected java.util.Map<java.lang.String,java.lang.Object>	properties properties (optional)
protected java.util.Date	time time of event
protected java.lang.String	type the event type
protected java.lang.String	userid userid

Constructor Summary

Constructors

Constructor and Description
AuditLogEntry(java.lang.String category, java.util.Date time, java.lang.String userid, java.lang.String path, java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> properties) Create a new AuditLogEntry.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCategory() Return the category for this log entry.
java.lang.String	getPath() The path.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() This is an application specific property map.
java.util.Date	getTime() Return the date of the audit log entry.
java.lang.String	getType() Returns the type of this audit log entry (this depends on the category)
java.lang.String	getUserId() Returns the user id.

Methods inherited from class java.lang.Object

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

Field Detail

time

protected final java.util.Date time

time of event

userid

protected final java.lang.String userid

userid

path

protected final java.lang.String path

path

type

protected final java.lang.String type

the event type

category

protected final java.lang.String category

category

properties

protected final java.util.Map<java.lang.String,java.lang.Object> properties

properties (optional)

Constructor Detail

AuditLogEntry

public AuditLogEntry(java.lang.String category,
             java.util.Date time,
             java.lang.String userid,
             java.lang.String path,
             java.lang.String type,
             java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new AuditLogEntry.

Parameters:

category - The category of the entry (required)

time - The date of the action (required)

userid - The userid (required)

path - The path of the action (required)

type - The action type (required)

properties - A map of key value pairs (optional). All objects in the map must be serializable.

Method Detail

getTime

public java.util.Date getTime()

Return the date of the audit log entry.

getUserId

public java.lang.String getUserId()

Returns the user id.

getPath

public java.lang.String getPath()

The path.

Returns:

The path.

getType

public java.lang.String getType()

Returns the type of this audit log entry (this depends on the category)

getCategory

public java.lang.String getCategory()

Return the category for this log entry.

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

This is an application specific property map.

Returns:

The map or null if not specified.