Package org.graylog.events.processor

Class EventDefinitionDto

java.lang.Object

org.graylog2.database.entities.ScopedEntity

org.graylog.events.processor.EventDefinitionDto

All Implemented Interfaces:

EventDefinition, ContentPackable<EventDefinitionEntity>, MongoEntity

public abstract class EventDefinitionDto
extends ScopedEntity
implements EventDefinition, ContentPackable<EventDefinitionEntity>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventDefinitionDto.Builder

Nested classes/interfaces inherited from class org.graylog2.database.entities.ScopedEntity

ScopedEntity.AbstractBuilder<SELF extends ScopedEntity.AbstractBuilder<SELF>>

Nested classes/interfaces inherited from interface org.graylog.events.processor.EventDefinition

EventDefinition.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FIELD_CONFIG
static final String	FIELD_DESCRIPTION
static final String	FIELD_MATCHED_AT
static final String	FIELD_NOTIFICATIONS
static final String	FIELD_REMEDIATION_STEPS
static final String	FIELD_STATE
static final String	FIELD_TITLE
static final String	FIELD_UPDATED_AT

Fields inherited from class org.graylog2.database.entities.ScopedEntity

FIELD_ID, FIELD_SCOPE

Constructor Summary

Constructors

Constructor	Description
EventDefinitionDto()

Method Summary

Modifier and Type	Method	Description
abstract boolean	alert()
static EventDefinitionDto.Builder	builder()
abstract EventProcessorConfig	config()
abstract String	description()
abstract com.google.common.collect.ImmutableMap<String,EventFieldSpec>	fieldSpec()
abstract String	id()	ID of the entity.
abstract com.google.common.collect.ImmutableList<String>	keySpec()
abstract org.joda.time.DateTime	matchedAt()
abstract com.google.common.collect.ImmutableList<EventNotificationHandler.Config>	notifications()
abstract EventNotificationSettings	notificationSettings()
abstract int	priority()
abstract String	remediationSteps()
void	resolveNativeEntity(EntityDescriptor entityDescriptor, com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)
abstract EventDefinitionContextService.SchedulerCtx	schedulerCtx()
abstract EventDefinition.State	state()
abstract com.google.common.collect.ImmutableList<EventStorageHandler.Config>	storage()
abstract String	title()
abstract EventDefinitionDto.Builder	toBuilder()
EventDefinitionEntity	toContentPackEntity(EntityDescriptorIds entityDescriptorIds)
abstract org.joda.time.DateTime	updatedAt()
ValidationResult	validate(EventDefinitionDto oldEventDefinitionDto, EventDefinitionConfiguration eventDefinitionConfiguration)

Methods inherited from class org.graylog2.database.entities.ScopedEntity

scope

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.graylog2.contentpacks.ContentPackable

getContentPackPluginPackage

Methods inherited from interface org.graylog.events.processor.EventDefinition

requiredPermissions

Field Details

FIELD_TITLE

public static final String FIELD_TITLE

See Also:

• Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

• Constant Field Values

FIELD_REMEDIATION_STEPS

public static final String FIELD_REMEDIATION_STEPS

See Also:

• Constant Field Values

FIELD_NOTIFICATIONS

public static final String FIELD_NOTIFICATIONS

See Also:

• Constant Field Values

FIELD_STATE

public static final String FIELD_STATE

See Also:

• Constant Field Values

FIELD_UPDATED_AT

public static final String FIELD_UPDATED_AT

See Also:

• Constant Field Values

FIELD_MATCHED_AT

public static final String FIELD_MATCHED_AT

See Also:

• Constant Field Values

FIELD_CONFIG

public static final String FIELD_CONFIG

See Also:

• Constant Field Values

Constructor Details

EventDefinitionDto

public EventDefinitionDto()

Method Details

id

@Nullable
public abstract String id()

Description copied from interface: MongoEntity

ID of the entity. Will be stored as field "_id" with type ObjectId in MongoDB.

Specified by:

id in interface EventDefinition

Specified by:

id in interface MongoEntity

Returns:

Hex string representation of the entity's ID

title

public abstract String title()

Specified by:

title in interface EventDefinition

description

public abstract String description()

Specified by:

description in interface EventDefinition

remediationSteps

@Nullable
public abstract String remediationSteps()

Specified by:

remediationSteps in interface EventDefinition

updatedAt

@Nullable
public abstract org.joda.time.DateTime updatedAt()

Specified by:

updatedAt in interface EventDefinition

matchedAt

@Nullable
public abstract org.joda.time.DateTime matchedAt()

Specified by:

matchedAt in interface EventDefinition

priority

public abstract int priority()

Specified by:

priority in interface EventDefinition

alert

public abstract boolean alert()

Specified by:

alert in interface EventDefinition

config

public abstract EventProcessorConfig config()

Specified by:

config in interface EventDefinition

fieldSpec

public abstract com.google.common.collect.ImmutableMap<String,EventFieldSpec> fieldSpec()

Specified by:

fieldSpec in interface EventDefinition

keySpec

public abstract com.google.common.collect.ImmutableList<String> keySpec()

Specified by:

keySpec in interface EventDefinition

notificationSettings

public abstract EventNotificationSettings notificationSettings()

Specified by:

notificationSettings in interface EventDefinition

notifications

public abstract com.google.common.collect.ImmutableList<EventNotificationHandler.Config> notifications()

Specified by:

notifications in interface EventDefinition

storage

public abstract com.google.common.collect.ImmutableList<EventStorageHandler.Config> storage()

Specified by:

storage in interface EventDefinition

schedulerCtx

@Nullable
public abstract EventDefinitionContextService.SchedulerCtx schedulerCtx()

Specified by:

schedulerCtx in interface EventDefinition

state

public abstract EventDefinition.State state()

builder

public static EventDefinitionDto.Builder builder()

toBuilder

public abstract EventDefinitionDto.Builder toBuilder()

validate

public ValidationResult validate(@Nullable
 EventDefinitionDto oldEventDefinitionDto,
 EventDefinitionConfiguration eventDefinitionConfiguration)

toContentPackEntity

public EventDefinitionEntity toContentPackEntity(EntityDescriptorIds entityDescriptorIds)

Specified by:

toContentPackEntity in interface ContentPackable<EventDefinitionEntity>

resolveNativeEntity

public void resolveNativeEntity(EntityDescriptor entityDescriptor,
 com.google.common.graph.MutableGraph<EntityDescriptor> mutableGraph)

Specified by:

resolveNativeEntity in interface ContentPackable<EventDefinitionEntity>