org.graylog.events.processor

Class EventDefinitionHandler

java.lang.Object

org.graylog.events.processor.EventDefinitionHandler

public class EventDefinitionHandler
extends Object

Handles event definitions and creates scheduler job definitions and job triggers. Caveat: These handlers modify different database documents without using any transactions. That means we can run into concurrency issues and partial operations. TODO: Make use of transactions once our database library supports it

Constructor Summary

Constructors

Constructor and Description
EventDefinitionHandler(DBEventDefinitionService eventDefinitionService, DBJobDefinitionService jobDefinitionService, DBJobTriggerService jobTriggerService, JobSchedulerClock clock)

Method Summary

Modifier and Type	Method and Description
EventDefinitionDto	create(EventDefinitionDto unsavedEventDefinition, Optional<User> user) Creates a new event definition and a corresponding scheduler job definition and trigger.
EventDefinitionDto	createWithoutSchedule(EventDefinitionDto unsavedEventDefinition, Optional<User> user) Creates a new event definition without scheduling it.
boolean	delete(String eventDefinitionId) Deletes an existing event definition and its corresponding scheduler job definition and trigger.
void	schedule(String eventDefinitionId) Creates a job definition and a trigger to schedule the given event definition.
void	unschedule(String eventDefinitionId) Removes job definition and trigger for the given event definition to disable it.
EventDefinitionDto	update(EventDefinitionDto updatedEventDefinition, boolean schedule) Updates an existing event definition and its corresponding scheduler job definition and trigger.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventDefinitionHandler

@Inject
public EventDefinitionHandler(DBEventDefinitionService eventDefinitionService,
                                      DBJobDefinitionService jobDefinitionService,
                                      DBJobTriggerService jobTriggerService,
                                      JobSchedulerClock clock)

Method Detail

create

public EventDefinitionDto create(EventDefinitionDto unsavedEventDefinition,
                                 Optional<User> user)

Creates a new event definition and a corresponding scheduler job definition and trigger.

Parameters:

unsavedEventDefinition - the event definition to save

user - the user who created this eventDefinition. If empty, no ownership will be registered.

Returns:

the created event definition

createWithoutSchedule

public EventDefinitionDto createWithoutSchedule(EventDefinitionDto unsavedEventDefinition,
                                                Optional<User> user)

Creates a new event definition without scheduling it. Normally the #create(EventDefinitionDto, Optional) method should be used to ensure proper scheduling of the event definition. In some cases new event definitions must be created without a schedule, though. (e.g. content packs)

Parameters:

unsavedEventDefinition - the event definition to save

Returns:

the created event definition

update

public EventDefinitionDto update(EventDefinitionDto updatedEventDefinition,
                                 boolean schedule)

Updates an existing event definition and its corresponding scheduler job definition and trigger.

Parameters:

updatedEventDefinition - the event definition to update

Returns:

the updated event definition

delete

public boolean delete(String eventDefinitionId)

Deletes an existing event definition and its corresponding scheduler job definition and trigger.

Parameters:

eventDefinitionId - the event definition to delete

Returns:

true if the event definition got deleted, false otherwise

schedule

public void schedule(String eventDefinitionId)

Creates a job definition and a trigger to schedule the given event definition.

Parameters:

eventDefinitionId - the event definition to schedule

unschedule

public void unschedule(String eventDefinitionId)

Removes job definition and trigger for the given event definition to disable it.

Parameters:

eventDefinitionId - the event definition to unschedule