org.nuxeo.ecm.platform.audit.api

Interface AuditReader

All Known Subinterfaces:

AuditBackend, Logs, LogsRemote

All Known Implementing Classes:

AbstractAuditBackend, DefaultAuditBackend, ESAuditBackend

public interface AuditReader

Interface for reading data from the Audit service.

Author:

tiry

Method Summary

Modifier and Type	Method and Description
List<LogEntry>	getLogEntriesFor(String uuid) Returns the logs given a doc uuid.
List<LogEntry>	getLogEntriesFor(String uuid, Map<String,FilterMapEntry> filterMap, boolean doDefaultSort)
LogEntry	getLogEntryByID(long id) Returns a given log entry given its id.
List<?>	nativeQuery(String query, int pageNb, int pageSize) Returns a batched list of entries.
List<?>	nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize) Returns a batched list of entries.
List<LogEntry>	nativeQueryLogs(String whereClause, int pageNb, int pageSize) Returns a batched list of log entries.
List<LogEntry>	queryLogs(String[] eventIds, String dateRange) Returns the list of log entries.
List<LogEntry>	queryLogsByPage(String[] eventIds, Date limit, String[] category, String path, int pageNb, int pageSize)
List<LogEntry>	queryLogsByPage(String[] eventIds, Date limit, String category, String path, int pageNb, int pageSize) Returns the batched list of log entries.
List<LogEntry>	queryLogsByPage(String[] eventIds, String dateRange, String[] category, String path, int pageNb, int pageSize)
List<LogEntry>	queryLogsByPage(String[] eventIds, String dateRange, String category, String path, int pageNb, int pageSize) Returns the batched list of log entries.

Method Detail

getLogEntriesFor

List<LogEntry> getLogEntriesFor(String uuid)

Returns the logs given a doc uuid.

Parameters:

uuid - the document uuid

Returns:

a list of log entries

getLogEntriesFor

List<LogEntry> getLogEntriesFor(String uuid,
                                Map<String,FilterMapEntry> filterMap,
                                boolean doDefaultSort)

getLogEntryByID

LogEntry getLogEntryByID(long id)

Returns a given log entry given its id.

Parameters:

id - the log entry identifier

Returns:

a LogEntry instance

queryLogs

List<LogEntry> queryLogs(String[] eventIds,
                         String dateRange)

Returns the list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Parameters:

eventIds - the event ids.

dateRange - a preset date range.

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

queryLogsByPage

List<LogEntry> queryLogsByPage(String[] eventIds,
                               String dateRange,
                               String category,
                               String path,
                               int pageNb,
                               int pageSize)

Returns the batched list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Parameters:

eventIds - the event ids.

dateRange - a preset date range.

category - add filter on events category

path - add filter on document path

pageNb - page number (ignore if <=1)

pageSize - number of results per page

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

queryLogsByPage

List<LogEntry> queryLogsByPage(String[] eventIds,
                               String dateRange,
                               String[] category,
                               String path,
                               int pageNb,
                               int pageSize)

queryLogsByPage

List<LogEntry> queryLogsByPage(String[] eventIds,
                               Date limit,
                               String category,
                               String path,
                               int pageNb,
                               int pageSize)

Returns the batched list of log entries.

Note we will use NXQL in the future when the search engine will index history.

Parameters:

eventIds - the event ids.

limit - filter events by date from limit to now

category - add filter on events category

path - add filter on document path

pageNb - page number (ignore if <=1)

pageSize - number of results per page

Returns:

a list of log entries.

See Also:

DateRangeQueryConstants

queryLogsByPage

List<LogEntry> queryLogsByPage(String[] eventIds,
                               Date limit,
                               String[] category,
                               String path,
                               int pageNb,
                               int pageSize)

nativeQueryLogs

List<LogEntry> nativeQueryLogs(String whereClause,
                               int pageNb,
                               int pageSize)

Returns a batched list of log entries. WhereClause is a native where clause for the backend: here EJBQL 3.0 must be used if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch.

nativeQuery

List<?> nativeQuery(String query,
                    int pageNb,
                    int pageSize)

Returns a batched list of entries. query string is a native query clause for the backend : here EJBQL 3.0 must be used if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch.

nativeQuery

List<?> nativeQuery(String query,
                    Map<String,Object> params,
                    int pageNb,
                    int pageSize)

Returns a batched list of entries.

Parameters:

query - a JPA query language query if implementation of audit backend is JPA (< 7.3 or audit.elasticsearch.enabled=false) and JSON if implementation is Elasticsearch

params - parameters for the query

pageNb - the page number (starts at 1)

pageSize - the number of results per page