AuditLog ("The CQ5 Quickstart and Web Application.")

```
public interface AuditLog
```
The AuditLog defines an interface to retrieve audit event information from the respective audit log. The audit log is path based: the content path in the repository is used as a unique identifier to group all entries.
The audit framework is still subject to change and will be improved. Adding entries to the audit log can be done by sending a job event with the job topic AuditLogEvent.JOB_TOPIC and the AuditLogEvent stored in the property AuditLogEvent.AUDIT_EVENT_PROPERTY or by directly calling add(AuditLogEntry) or add(List).

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(AuditLogEntry entry)` Add a new audit log entry.
`void`	`add(List<AuditLogEntry> entries)` Add new audit log entries
`String[]`	`getCategories()` Return an array containing all audit log categories (that have entries)
`AuditLogEntry`	`getLatestEvent(String category, String path)` Returns the latest event for the path and category.
`AuditLogEntry`	`getLatestEvent(String category, String path, String type)` Returns the latest event for the path, type and category.
`AuditLogEntry[]`	`getLatestEvents(String[] categories, String path, int max)` Returns the latest events for the path and category.
`AuditLogEntry[]`	`getLatestEvents(String category, String path, int max)` Returns the latest events for the path and category.
`AuditLogEntry[]`	`getLatestEventsFromTree(String[] categories, String pathPrefix, int max)` Returns the latest events for all paths which will start with the `prefix`.
`void`	`move(String srcPath, String destPath)` Move audit log entries from one place to another.

- Method Detail
  - getLatestEvent
```
AuditLogEntry getLatestEvent(String category,
                           String path)
```
    Returns the latest event for the path and category.
    
    Parameters:
    category - the event category
    path - the path of the event
    
    Returns:
    the latest event with the given path or null. throws IllegalArgumentException If category or path are null.
  - getLatestEvent
```
AuditLogEntry getLatestEvent(String category,
                           String path,
                           String type)
```
    Returns the latest event for the path, type and category.
    
    Parameters:
    category - the event category
    path - the path of the event
    type - the type of the event
    
    Returns:
    the latest event with the given path or null. throws IllegalArgumentException If category, type or path are null.
  - getLatestEvents
```
AuditLogEntry[] getLatestEvents(String category,
                              String path,
                              int max)
```
    Returns the latest events for the path and category.
    
    Parameters:
    category - the event category
    path - the path of the events
    max - the maximum number of events to return or -1 for all.
    
    Returns:
    an array of AuditEvents throws IllegalArgumentException If category or path are null.
  - getLatestEvents
```
AuditLogEntry[] getLatestEvents(String[] categories,
                              String path,
                              int max)
```
    Returns the latest events for the path and category.
    
    Parameters:
    categories - the event categories
    path - the path of the events
    max - the maximum number of events to return or -1 for all.
    
    Returns:
    an array of AuditEvents throws IllegalArgumentException If category or path are null.
  - getCategories
```
String[] getCategories()
```
    Return an array containing all audit log categories (that have entries)
    
    Returns:
    An array with the categories or null
  - getLatestEventsFromTree
```
AuditLogEntry[] getLatestEventsFromTree(String[] categories,
                                      String pathPrefix,
                                      int max)
```
    Returns the latest events for all paths which will start with the prefix.
    
    Parameters:
    categories - the event categories
    pathPrefix - the pattern to match
    max - the maximum number of events per path to return or -1 for all.
    
    Returns:
    an array of AuditEvents throws IllegalArgumentException If category or pathPrefix are null.
  - add
```
void add(AuditLogEntry entry)
```
    Add a new audit log entry.
    
    Parameters:
    entry - The audit log entry.
  - add
```
void add(List<AuditLogEntry> entries)
```
    Add new audit log entries
    
    Parameters:
    entries - The audit log entries.
  - move
```
void move(String srcPath,
        String destPath)
```
    Move audit log entries from one place to another.

Interface AuditLog

Method Summary

Method Detail

getLatestEvent

getLatestEvent

getLatestEvents

getLatestEvents

getCategories

getLatestEventsFromTree

add

add

move