Package org.nuxeo.ecm.platform.audit.api

Interface LogEntry

All Superinterfaces:
Serializable
All Known Subinterfaces:
LogEntry
All Known Implementing Classes:
LogEntryBuilder.LogEntryImpl, LogEntryImpl
@Deprecated(since="2025.0", forRemoval=true) public interface LogEntry extends Serializable
Deprecated, for removal: This API element is subject to removal in a future version.
since 2025.0, use LogEntry instead
Log entry.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCategory()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the category for this log entry.
    String
    getComment()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the associated comment for this log entry.
    String
    getDocLifeCycle()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the life cycle if the document related to the log entry.
    String
    getDocPath()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the doc path related to the log entry.
    String
    getDocType()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the doc type related to the log entry.
    String
    getDocUUID()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the doc UUID related to the log entry.
    Date
    getEventDate()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the date of the event that originated the log entry.
    String
    getEventId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the identifier of the event that originated the log entry.
    Map<String,Object>
    getExtended()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the extended information attached to this log entry.
    default Map<String,ExtendedInfo>
    getExtendedInfos()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, ExtendedInfo doesn't need a Java type anymore, use getExtended() instead
    default <R> R
    getExtendedValue(String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    long
    getId()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Date
    getLogDate()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default UIAuditComment
    getPreprocessedComment()
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, unused
    String
    getPrincipalName()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the name of the principal who originated the log entry.
    String
    getRepositoryId()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the repository id related to the log entry.
    default void
    setCategory(String category)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setComment(String comment)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setDocLifeCycle(String docLifeCycle)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setDocPath(String docPath)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setDocType(String docType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setDocUUID(String docUUID)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setDocUUID(DocumentRef docRef)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setEventDate(Date eventDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setEventId(String eventId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setExtendedInfos(Map<String,ExtendedInfo> infos)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setId(long id)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setLogDate(Date logDate)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setPreprocessedComment(UIAuditComment uiComment)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setPrincipalName(String principalName)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable
    default void
    setRepositoryId(String repositoryId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 2025.0, LogEntry built by Nuxeo Platform are now immutable

  • Method Details

    • getId

      long getId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      the log identifier

    • setId

      @Deprecated(since="2025.0", forRemoval=true) default void setId(long id)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getPrincipalName

      String getPrincipalName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the name of the principal who originated the log entry.
      Returns:
      the name of the principal who originated the log entry

    • setPrincipalName

      @Deprecated(since="2025.0", forRemoval=true) default void setPrincipalName(String principalName)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getEventId

      String getEventId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the identifier of the event that originated the log entry.
      Returns:
      the identifier of the event that originated the log entry

    • setEventId

      @Deprecated(since="2025.0", forRemoval=true) default void setEventId(String eventId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getLogDate

      Date getLogDate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • setLogDate

      @Deprecated(since="2025.0", forRemoval=true) default void setLogDate(Date logDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getEventDate

      Date getEventDate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the date of the event that originated the log entry.
      Returns:
      the date of the event that originated the log entry

    • setEventDate

      @Deprecated(since="2025.0", forRemoval=true) default void setEventDate(Date eventDate)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getDocUUID

      String getDocUUID()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Returns:
      the doc UUID related to the log entry.

    • setDocUUID

      @Deprecated(since="2025.0", forRemoval=true) default void setDocUUID(String docUUID)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • setDocUUID

      @Deprecated(since="2025.0", forRemoval=true) default void setDocUUID(DocumentRef docRef)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getDocPath

      String getDocPath()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Returns:
      the doc path related to the log entry.

    • setDocPath

      @Deprecated(since="2025.0", forRemoval=true) default void setDocPath(String docPath)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getDocType

      String getDocType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Returns:
      the doc type related to the log entry.

    • setDocType

      @Deprecated(since="2025.0", forRemoval=true) default void setDocType(String docType)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getCategory

      String getCategory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the category for this log entry.

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

      Returns:
      the category for this log entry.

    • setCategory

      @Deprecated(since="2025.0", forRemoval=true) default void setCategory(String category)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getComment

      String getComment()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the associated comment for this log entry.
      Returns:
      the associated comment for this log entry

    • setComment

      @Deprecated(since="2025.0", forRemoval=true) default void setComment(String comment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getDocLifeCycle

      String getDocLifeCycle()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

      Returns:
      the life cycle if the document related to the log entry.

    • setDocLifeCycle

      @Deprecated(since="2025.0", forRemoval=true) default void setDocLifeCycle(String docLifeCycle)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getRepositoryId

      String getRepositoryId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the repository id related to the log entry.
      Returns:
      the repository id

    • setRepositoryId

      @Deprecated(since="2025.0", forRemoval=true) default void setRepositoryId(String repositoryId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getExtended

      Map<String,Object> getExtended()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the extended information attached to this log entry.
      Since:
      2025.0

    • getExtendedValue

      default <R> R getExtendedValue(String key)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Since:
      2025.0

    • getExtendedInfos

      @Deprecated(since="2025.0", forRemoval=true) default Map<String,ExtendedInfo> getExtendedInfos()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, ExtendedInfo doesn't need a Java type anymore, use getExtended() instead

    • setExtendedInfos

      @Deprecated(since="2025.0", forRemoval=true) default void setExtendedInfos(Map<String,ExtendedInfo> infos)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable

    • getPreprocessedComment

      @Deprecated(since="2025.0", forRemoval=true) default UIAuditComment getPreprocessedComment()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, unused
      Returns the comment preprocessed to be ready for display (extract info about linked documents).

    • setPreprocessedComment

      @Deprecated(since="2025.0", forRemoval=true) default void setPreprocessedComment(UIAuditComment uiComment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 2025.0, LogEntry built by Nuxeo Platform are now immutable