Package org.nuxeo.ecm.platform.audit.service

Class DefaultAuditBackend

java.lang.Object
org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend<LogEntry>
org.nuxeo.ecm.platform.audit.service.DefaultAuditBackend
All Implemented Interfaces:
AuditAdmin, AuditLogger<LogEntry>, AuditReader<LogEntry>, AuditStorage, Logs<LogEntry>, AuditBackend<LogEntry>
@Deprecated(since="2025.0", forRemoval=true) public class DefaultAuditBackend extends AbstractAuditBackend<LogEntry>
Deprecated, for removal: This API element is subject to removal in a future version.
since 2025.0, use org.nuxeo.sql.audit.SQLAuditBackend instead
Contains the Hibernate based (legacy) implementation
Author:
tiry

  • Field Details

    • OBJECT_MAPPER

      protected static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER
      Deprecated, for removal: This API element is subject to removal in a future version.

    • persistenceProvider

      protected PersistenceProvider persistenceProvider
      Deprecated, for removal: This API element is subject to removal in a future version.

    • cursorService

      protected CursorService<Iterator<LogEntry>,LogEntry,String> cursorService
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • DefaultAuditBackend

      public DefaultAuditBackend(NXAuditEventsService component, AuditBackendDescriptor config)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • DefaultAuditBackend

      public DefaultAuditBackend()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since:
      9.3

  • Method Details

    • getApplicationStartedOrder

      public int getApplicationStartedOrder()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • onApplicationStarted

      public void onApplicationStarted()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • onApplicationStopped

      public void onApplicationStopped()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getOrCreatePersistenceProvider

      public PersistenceProvider getOrCreatePersistenceProvider()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • activatePersistenceProvider

      protected void activatePersistenceProvider()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • apply

      protected <T> T apply(boolean needActivateSession, Function<LogEntryProvider,T> function)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • accept

      protected void accept(boolean needActivateSession, Consumer<LogEntryProvider> consumer)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addLogEntries

      public void addLogEntries(List<LogEntry> entries)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditLogger
      Adds given log entries.
      Parameters:
      entries - the list of log entries.

    • getLogEntriesFor

      public List<LogEntry> getLogEntriesFor(String uuid, String repositoryId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      Returns the logs given a doc uuid and a repository id.
      Parameters:
      uuid - the document uuid
      repositoryId - the repository id
      Returns:
      a list of log entries

    • getLogEntryByID

      public LogEntry getLogEntryByID(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      Returns a given log entry given its id.
      Parameters:
      id - the log entry identifier
      Returns:
      a LogEntry instance

    • nativeQueryLogs

      public List<LogEntry> nativeQueryLogs(String whereClause, int pageNb, int pageSize)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      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

      public List<?> nativeQuery(String query, int pageNb, int pageSize)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      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

      public List<?> nativeQuery(String query, Map<String,Object> params, int pageNb, int pageSize)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      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

    • queryLogs

      public List<LogEntry> queryLogs(QueryBuilder builder)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      Returns the logs given a collection of predicates and a default sort.
      Parameters:
      builder - the query builder to fetch log entries
      Returns:
      a list of log entries

    • queryLogs

      public List<LogEntry> queryLogs(String[] eventIds, String dateRange)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      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:

    • queryLogsByPage

      public List<LogEntry> queryLogsByPage(String[] eventIds, Date limit, String[] category, String path, int pageNb, int pageSize)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • syncLogCreationEntries

      @Deprecated(since="2025.0", forRemoval=true) public long syncLogCreationEntries(String repoId, String path, Boolean recurs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, seems unused
      Description copied from interface: AuditAdmin
      Forces log Synchronisation for a branch of the repository. This can be useful to add the create entries if DB was initialized from a bulk import.

    • getEventsCount

      public Long getEventsCount(String eventId)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getLoggedEventIds

      public List<String> getLoggedEventIds()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • newExtendedInfo

      public ExtendedInfo newExtendedInfo(Serializable value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditLogger
      Create a new ExtendedInfo instance
      Specified by:
      newExtendedInfo in interface AuditLogger<LogEntry>
      Specified by:
      newExtendedInfo in class AbstractAuditBackend<LogEntry>

    • getLatestLogId

      public long getLatestLogId(String repositoryId, String... eventIds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      Returns the latest log id matching events and repository or 0 when no match found.

    • getLogEntriesAfter

      public List<LogEntry> getLogEntriesAfter(long logIdOffset, int limit, String repositoryId, String... eventIds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditReader
      Returns up to limit log entries matching events and repository with log id greater or equal to logIdOffset.

    • getParamNames

      protected String getParamNames(String[] eventId)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getParams

      protected Map<String,Object> getParams(String[] eventId)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • append

      public void append(List<String> jsonEntries)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • scroll

      public ScrollResult<String> scroll(QueryBuilder builder, int batchSize, int keepAliveSeconds)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • scroll

      public ScrollResult<String> scroll(String scrollId)
      Deprecated, for removal: This API element is subject to removal in a future version.