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

Class AbstractAuditBackend<L extends LogEntry>

java.lang.Object
org.nuxeo.ecm.platform.audit.service.AbstractAuditBackend<L>
Type Parameters:
L - to give the log entry type for the new AuditBackend interface that defines a new entry type.
All Implemented Interfaces:
AuditAdmin, AuditLogger<L>, AuditReader<L>, AuditStorage, Logs<L>, AuditBackend<L>
Direct Known Subclasses:
AbstractAuditBackend, DefaultAuditBackend
@Deprecated(since="2025.0", forRemoval=true) public abstract class AbstractAuditBackend<L extends LogEntry> extends Object implements AuditBackend<L>, AuditStorage
Deprecated, for removal: This API element is subject to removal in a future version.
since 2025.0, use AbstractAuditBackend instead
Abstract class to share code between AuditBackend implementations
Author:
tiry

  • Field Details

    • log

      protected static final org.apache.logging.log4j.Logger log
      Deprecated, for removal: This API element is subject to removal in a future version.

    • FORCE_AUDIT_FACET

      public static final String FORCE_AUDIT_FACET
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • component

      protected final NXAuditEventsService component
      Deprecated, for removal: This API element is subject to removal in a future version.

    • config

      protected final AuditBackendDescriptor config
      Deprecated, for removal: This API element is subject to removal in a future version.

    • expressionEvaluator

      protected final ExpressionEvaluator expressionEvaluator
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • AbstractAuditBackend

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

    • AbstractAuditBackend

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

  • Method Details

    • guardedDocument

      protected DocumentModel guardedDocument(CoreSession session, DocumentRef reference)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • guardedDocumentChildren

      protected DocumentModelList guardedDocumentChildren(CoreSession session, DocumentRef reference)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • doCreateAndFillEntryFromDocument

      protected LogEntry doCreateAndFillEntryFromDocument(DocumentModel doc, Principal principal)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • doPutExtendedInfos

      protected void doPutExtendedInfos(LogEntry entry, EventContext eventContext, DocumentModel source, Principal principal)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • populateExtendedInfo

      protected void populateExtendedInfo(LogEntry entry, DocumentModel source, ExpressionContext context, Collection<ExtendedInfoDescriptor> extInfos)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since:
      7.4

    • getAuditableEventNames

      public Set<String> getAuditableEventNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditLogger
      Returns the list of auditable event names.
      Specified by:
      getAuditableEventNames in interface AuditLogger<L extends LogEntry>
      Returns:
      a set of String representing event names.

    • buildEntryFromEvent

      public L buildEntryFromEvent(Event event)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditLogger
      Returns a log entry representation of an event.
      Specified by:
      buildEntryFromEvent in interface AuditLogger<L extends LogEntry>

    • newLogEntry

      public L newLogEntry()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditLogger
      Create a new LogEntry instance.
      Specified by:
      newLogEntry in interface AuditLogger<L extends LogEntry>

    • newExtendedInfo

      public abstract 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<L extends LogEntry>

    • syncLogCreationEntries

      protected long syncLogCreationEntries(BaseLogEntryProvider provider, String repoId, String path, Boolean recurs)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • doSyncNode

      protected long doSyncNode(BaseLogEntryProvider provider, CoreSession session, DocumentModel node, boolean recurs)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isAuditable

      protected boolean isAuditable(EventBundle eventBundle)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • await

      public boolean await(long time, TimeUnit unit) throws InterruptedException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      await in interface AuditLogger<L extends LogEntry>
      Throws:
      InterruptedException

    • restore

      public void restore(AuditStorage auditStorage, int batchSize, int keepAlive)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AuditBackend
      Restore the backend from the given AuditStorage
      Specified by:
      restore in interface AuditBackend<L extends LogEntry>
      Parameters:
      auditStorage - the audit storage
      batchSize - the batch size
      keepAlive - the keep alive duration