java.lang.Object
org.elasticsearch.xpack.core.common.notifications.AbstractAuditMessage
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
Direct Known Subclasses:
AnomalyDetectionAuditMessage, DataFrameAnalyticsAuditMessage, InferenceAuditMessage, SystemAuditMessage, TransformAuditMessage

public abstract class AbstractAuditMessage extends Object implements org.elasticsearch.xcontent.ToXContentObject
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.elasticsearch.xcontent.ParseField
     
    static final org.elasticsearch.xcontent.ParseField
     
    static final int
    The max length of an audit message in characters is 32766 / 4 = 8191 where 32766 is the limit in bytes Lucene sets for a term field and 4 is the max number of bytes required to represent a UTF8 character.
    static final org.elasticsearch.xcontent.ParseField
     
    static final org.elasticsearch.xcontent.ParseField
     
    static final org.elasticsearch.xcontent.ParseField
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractAuditMessage(String resourceId, String message, Level level, Date timestamp, String nodeName)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected static final <T extends AbstractAuditMessage>
    org.elasticsearch.xcontent.ConstructingObjectParser<T,Void>
    createParser(String name, AbstractAuditMessageFactory<T> messageFactory, org.elasticsearch.xcontent.ParseField resourceField)
     
    boolean
     
    abstract String
     
    final Level
     
    final String
     
    final String
     
    protected abstract Optional<String>
     
    final String
     
    final Date
     
    int
     
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment
  • Field Details

    • MESSAGE

      public static final org.elasticsearch.xcontent.ParseField MESSAGE
    • LEVEL

      public static final org.elasticsearch.xcontent.ParseField LEVEL
    • TIMESTAMP

      public static final org.elasticsearch.xcontent.ParseField TIMESTAMP
    • NODE_NAME

      public static final org.elasticsearch.xcontent.ParseField NODE_NAME
    • JOB_TYPE

      public static final org.elasticsearch.xcontent.ParseField JOB_TYPE
    • MAX_AUDIT_MESSAGE_CHARS

      public static final int MAX_AUDIT_MESSAGE_CHARS
      The max length of an audit message in characters is 32766 / 4 = 8191 where 32766 is the limit in bytes Lucene sets for a term field and 4 is the max number of bytes required to represent a UTF8 character.
      See Also:
  • Constructor Details

    • AbstractAuditMessage

      protected AbstractAuditMessage(@Nullable String resourceId, String message, Level level, Date timestamp, String nodeName)
  • Method Details

    • createParser

      protected static final <T extends AbstractAuditMessage> org.elasticsearch.xcontent.ConstructingObjectParser<T,Void> createParser(String name, AbstractAuditMessageFactory<T> messageFactory, org.elasticsearch.xcontent.ParseField resourceField)
    • getResourceId

      @Nullable public final String getResourceId()
    • getMessage

      public final String getMessage()
    • getLevel

      public final Level getLevel()
    • getTimestamp

      public final Date getTimestamp()
    • getNodeName

      public final String getNodeName()
    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • getJobType

      public abstract String getJobType()
      Returns:
      job type string used to tell apart jobs of different types stored in the same index
    • getResourceField

      protected abstract Optional<String> getResourceField()
      Returns:
      resource id field name used when storing a new message