Package org.nuxeo.audit.api

Interface LogEntry

All Superinterfaces:
LogEntry, Serializable
All Known Implementing Classes:
LogEntryBuilder.LogEntryImpl
public interface LogEntry extends LogEntry
Since:
2025.0

  • Method Details

    • getId

      long getId()
      Specified by:
      getId in interface LogEntry
      Returns:
      the log identifier

    • getPrincipalName

      String getPrincipalName()
      Returns the name of the principal who originated the log entry.
      Specified by:
      getPrincipalName in interface LogEntry
      Returns:
      the name of the principal who originated the log entry

    • getEventId

      String getEventId()
      Returns the identifier of the event that originated the log entry.
      Specified by:
      getEventId in interface LogEntry
      Returns:
      the identifier of the event that originated the log entry

    • getLogDate

      Date getLogDate()
      Specified by:
      getLogDate in interface LogEntry
      Returns:
      the date of the log insertion: this up to max transaction timeout later than eventDate. This date is useful for services such as Nuxeo Drive that need fine grained incremental near-monotonic access to the audit log.
      Since:
      5.7, 5.6-HF16

    • getEventDate

      Date getEventDate()
      Returns the date of the event that originated the log entry.
      Specified by:
      getEventDate in interface LogEntry
      Returns:
      the date of the event that originated the log entry

    • getDocUUID

      String getDocUUID()
      Returns the doc UUID related to the log entry.

      It might be null if the event that originated the event is noe bound to any document.

      Specified by:
      getDocUUID in interface LogEntry
      Returns:
      the doc UUID related to the log entry.

    • getDocPath

      String getDocPath()
      Returns the doc path related to the log entry.

      It might be null if the event that originated the event is noe bound to any document.

      Specified by:
      getDocPath in interface LogEntry
      Returns:
      the doc path related to the log entry.

    • getDocType

      String getDocType()
      Returns the doc type related to the log entry.

      It might be null if the event that originated the event is not bound to any document.

      Specified by:
      getDocType in interface LogEntry
      Returns:
      the doc type related to the log entry.

    • getCategory

      String getCategory()
      Returns the category for this log entry.

      This is defined at client level. Categories are not restricted in any ways.

      Specified by:
      getCategory in interface LogEntry
      Returns:
      the category for this log entry.

    • getComment

      String getComment()
      Returns the associated comment for this log entry.
      Specified by:
      getComment in interface LogEntry
      Returns:
      the associated comment for this log entry

    • getDocLifeCycle

      String getDocLifeCycle()
      Return the life cycle if the document related to the log entry.

      It might be null if the event that originated the event is noe bound to any document.

      Specified by:
      getDocLifeCycle in interface LogEntry
      Returns:
      the life cycle if the document related to the log entry.

    • getRepositoryId

      String getRepositoryId()
      Returns the repository id related to the log entry.
      Specified by:
      getRepositoryId in interface LogEntry
      Returns:
      the repository id

    • getExtended

      Map<String,Object> getExtended()
      Returns the extended information attached to this log entry.
      Specified by:
      getExtended in interface LogEntry
      Since:
      2025.0

    • getExtendedValue

      default <R> R getExtendedValue(String key)
      Specified by:
      getExtendedValue in interface LogEntry
      Since:
      2025.0

    • builder

      default LogEntryBuilder builder()
      Since:
      2025.0

    • builder

      static LogEntryBuilder builder(String eventId, Date eventDate)
      Returns a LogEntryBuilder to instantiate a LogEntry.
      Since:
      2025.0