org.axonframework.eventhandling.scheduling.quartz

Class QuartzEventScheduler.Builder

java.lang.Object

org.axonframework.eventhandling.scheduling.quartz.QuartzEventScheduler.Builder

Enclosing class:

QuartzEventScheduler

public static class QuartzEventScheduler.Builder
extends Object

Builder class to instantiate a QuartzEventScheduler.

The EventJobDataBinder is defaulted to a QuartzEventScheduler.DirectEventJobDataBinder using the configured Serializer, and the TransactionManager defaults to a NoTransactionManager. Note that if the Serializer is not set, the configuration expects the EventJobDataBinder to be set.

The Scheduler and EventBus are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
QuartzEventScheduler	build() Initializes a QuartzEventScheduler as specified through this Builder.
QuartzEventScheduler.Builder	eventBus(EventBus eventBus) Sets the EventBus used to publish events on once the schedule has been met.
QuartzEventScheduler.Builder	jobDataBinder(EventJobDataBinder jobDataBinder) Sets the EventJobDataBinder instance which reads / writes the event message to publish to the JobDataMap.
QuartzEventScheduler.Builder	scheduler(org.quartz.Scheduler scheduler) Sets the Scheduler used for scheduling and triggering purposes of the deadlines.
QuartzEventScheduler.Builder	serializer(Serializer serializer) Sets the Serializer used by the EventJobDataBinder.
QuartzEventScheduler.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to build transactions and ties them on event publication.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

scheduler

public QuartzEventScheduler.Builder scheduler(org.quartz.Scheduler scheduler)

Sets the Scheduler used for scheduling and triggering purposes of the deadlines.

Parameters:

scheduler - a Scheduler used for scheduling and triggering purposes of the deadlines

Returns:

the current Builder instance, for fluent interfacing

eventBus

public QuartzEventScheduler.Builder eventBus(EventBus eventBus)

Sets the EventBus used to publish events on once the schedule has been met.

Parameters:

eventBus - a EventBus used to publish events on once the schedule has been met

Returns:

the current Builder instance, for fluent interfacing

jobDataBinder

public QuartzEventScheduler.Builder jobDataBinder(EventJobDataBinder jobDataBinder)

Sets the EventJobDataBinder instance which reads / writes the event message to publish to the JobDataMap. Defaults to QuartzEventScheduler.DirectEventJobDataBinder.

Parameters:

jobDataBinder - a EventJobDataBinder instance which reads / writes the event message to publish to the JobDataMap

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public QuartzEventScheduler.Builder transactionManager(TransactionManager transactionManager)

Sets the TransactionManager used to build transactions and ties them on event publication. Defaults to a NoTransactionManager.

Parameters:

transactionManager - a TransactionManager used to build transactions and ties them on event publication

Returns:

the current Builder instance, for fluent interfacing

serializer

public QuartzEventScheduler.Builder serializer(Serializer serializer)

Sets the Serializer used by the EventJobDataBinder. The EventJobDataBinder uses the Serializer to de-/serialize the scheduled event.

Parameters:

serializer - a Serializer used by the EventJobDataBinder when serializing events

Returns:

the current Builder instance, for fluent interfacing

build

public QuartzEventScheduler build()

Initializes a QuartzEventScheduler as specified through this Builder.

Returns:

a QuartzEventScheduler as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications