com.day.cq.audit
Class AuditLogEntry

java.lang.Object
  com.day.cq.audit.AuditLogEntry

All Implemented Interfaces:

Serializable

public class AuditLogEntry
extends Object
implements Serializable

The AuditEvent class represents the class for an audit event.

See Also:

Serialized Form

Field Summary

protected String	category category
protected String	path path
protected Map<String,Object>	properties properties (optional)
protected Date	time time of event
protected String	type the event type
protected String	userid userid

Constructor Summary

AuditLogEntry(String category, Date time, String userid, String path, String type, Map<String,Object> properties)
Create a new AuditLogEntry.

Method Summary

String	getCategory() Return the category for this log entry.
String	getPath() The path.
Map<String,Object>	getProperties() This is an application specific property map.
Date	getTime() Return the date of the audit log entry.
String	getType() Returns the type of this audit log entry (this depends on the category)
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 Date time

time of event

userid

protected final String userid

userid

path

protected final String path

path

type

protected final String type

the event type

category

protected final String category

category

properties

protected final Map<String,Object> properties

properties (optional)

Constructor Detail

AuditLogEntry

public AuditLogEntry(String category,
                     Date time,
                     String userid,
                     String path,
                     String type,
                     Map<String,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 Date getTime()

Return the date of the audit log entry.

getUserId

public String getUserId()

Returns the user id.

getPath

public String getPath()

The path.

Returns:

The path.

getType

public String getType()

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

getCategory

public String getCategory()

Return the category for this log entry.

getProperties

public Map<String,Object> getProperties()

This is an application specific property map.

Returns:

The map or null if not specified.