Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.common.notifications

Class AbstractAuditMessage

java.lang.Object

org.elasticsearch.xpack.core.common.notifications.AbstractAuditMessage

All Implemented Interfaces:

ToXContent, ToXContentObject

Direct Known Subclasses:

AnomalyDetectionAuditMessage, DataFrameAnalyticsAuditMessage, InferenceAuditMessage, SystemAuditMessage, TransformAuditMessage

public abstract class AbstractAuditMessage
extends Object
implements ToXContentObject

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	JOB_TYPE
static final ParseField	LEVEL
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.
static final ParseField	MESSAGE
static final ParseField	NODE_NAME
static final ParseField	TIMESTAMP

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> ConstructingObjectParser<T,Void>	createParser(String name, AbstractAuditMessageFactory<T> messageFactory, ParseField resourceField)
boolean	equals(Object obj)
abstract String	getJobType()
final Level	getLevel()
final String	getMessage()
final String	getNodeName()
protected abstract Optional<String>	getResourceField()
final String	getResourceId()
final Date	getTimestamp()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, 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 ParseField MESSAGE

LEVEL

public static final ParseField LEVEL

TIMESTAMP

public static final ParseField TIMESTAMP

NODE_NAME

public static final ParseField NODE_NAME

JOB_TYPE

public static final 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:

• Constant Field Values

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>
ConstructingObjectParser<T,Void> createParser(String name,
 AbstractAuditMessageFactory<T> messageFactory,
 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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface 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