Package org.flowable.eventregistry.impl.model

Class EventModelBuilderImpl

java.lang.Object

org.flowable.eventregistry.impl.model.EventModelBuilderImpl

All Implemented Interfaces:

EventModelBuilder

public class EventModelBuilderImpl
extends Object
implements EventModelBuilder

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected String	category
protected String	deploymentName
protected String	deploymentTenantId
protected EventJsonConverter	eventJsonConverter
protected Map<String,EventPayload>	eventPayloadDefinitions
protected EventRepositoryServiceImpl	eventRepository
protected String	key
protected String	parentDeploymentId
protected String	resourceName

Constructor Summary

Constructors

Constructor	Description
EventModelBuilderImpl(EventRepositoryServiceImpl eventRepository, EventJsonConverter eventJsonConverter)

Method Summary

Modifier and Type	Method	Description
protected EventModel	buildEventModel()
EventModelBuilder	category(String category)	Set the category for the event deployment.
EventModelBuilder	correlationParameter(String name, String type)	Defines one parameters for correlation that can be used in models to map onto.
EventModel	createEventModel()	Creates a new event model, but does not deploy it to the Event registry engine.
EventDeployment	deploy()	Deploys a new event definition for this event model.
EventModelBuilder	deploymentName(String deploymentName)	Set the name for the event deployment.
EventModelBuilder	deploymentTenantId(String deploymentTenantId)	Set the tenant id for the event deployment.
EventModelBuilder	fullPayload(String name)	Defines the property name for the full payload.
EventModelBuilder	header(String name, String type)	Defines one header element of an event definition.
EventModelBuilder	headerWithCorrelation(String name, String type)	Defines one header element with correlation for an event definition.
EventModelBuilder	key(String key)	Each event type will uniquely be identified with a key (similar to the key of a process/case/decision/...
EventModelBuilder	metaParameter(String name, String type)	Defines one meta parameter that can be used in models.
EventModelBuilder	parentDeploymentId(String parentDeploymentId)	Set the parent deployment id for the event deployment.
EventModelBuilder	payload(String name, String type)	Defines one payload element of an event definition.
EventModelBuilder	resourceName(String resourceName)	Set the resource name for the event model.

Methods inherited from class java.lang.Object

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

Field Details

eventRepository

protected EventRepositoryServiceImpl eventRepository

eventJsonConverter

protected EventJsonConverter eventJsonConverter

deploymentName

protected String deploymentName

resourceName

protected String resourceName

category

protected String category

parentDeploymentId

protected String parentDeploymentId

deploymentTenantId

protected String deploymentTenantId

key

protected String key

eventPayloadDefinitions

protected Map<String,EventPayload> eventPayloadDefinitions

Constructor Details

EventModelBuilderImpl

public EventModelBuilderImpl(EventRepositoryServiceImpl eventRepository,
 EventJsonConverter eventJsonConverter)

Method Details

key

public EventModelBuilder key(String key)

Description copied from interface: EventModelBuilder

Each event type will uniquely be identified with a key (similar to the key of a process/case/decision/... definition), which is typically referenced in process/case/... models.

Specified by:

key in interface EventModelBuilder

deploymentName

public EventModelBuilder deploymentName(String deploymentName)

Description copied from interface: EventModelBuilder

Set the name for the event deployment.

Specified by:

deploymentName in interface EventModelBuilder

resourceName

public EventModelBuilder resourceName(String resourceName)

Description copied from interface: EventModelBuilder

Set the resource name for the event model.

Specified by:

resourceName in interface EventModelBuilder

category

public EventModelBuilder category(String category)

Description copied from interface: EventModelBuilder

Set the category for the event deployment.

Specified by:

category in interface EventModelBuilder

parentDeploymentId

public EventModelBuilder parentDeploymentId(String parentDeploymentId)

Description copied from interface: EventModelBuilder

Set the parent deployment id for the event deployment.

Specified by:

parentDeploymentId in interface EventModelBuilder

deploymentTenantId

public EventModelBuilder deploymentTenantId(String deploymentTenantId)

Description copied from interface: EventModelBuilder

Set the tenant id for the event deployment.

Specified by:

deploymentTenantId in interface EventModelBuilder

header

public EventModelBuilder header(String name,
 String type)

Description copied from interface: EventModelBuilder

Defines one header element of an event definition. An header elements is data that can be used for example as metadata for an event.

Specified by:

header in interface EventModelBuilder

headerWithCorrelation

public EventModelBuilder headerWithCorrelation(String name,
 String type)

Description copied from interface: EventModelBuilder

Defines one header element with correlation for an event definition. An header elements is data that can be used for example as metadata for an event.

Specified by:

headerWithCorrelation in interface EventModelBuilder

correlationParameter

public EventModelBuilder correlationParameter(String name,
 String type)

Description copied from interface: EventModelBuilder

Defines one parameters for correlation that can be used in models to map onto. Each correlation parameter is automatically a EventModelBuilder.payload(String, String) element. Will create a correlation EventPayload behind the scenes.

Specified by:

correlationParameter in interface EventModelBuilder

payload

public EventModelBuilder payload(String name,
 String type)

Description copied from interface: EventModelBuilder

Defines one payload element of an event definition. Such payload elements are data that is contained within an event. If certain payload needs to be used to correlate runtime instances, use the EventModelBuilder.correlationParameter(String, String) method. One EventModel typically has multiple such elements.

Specified by:

payload in interface EventModelBuilder

metaParameter

public EventModelBuilder metaParameter(String name,
 String type)

Description copied from interface: EventModelBuilder

Defines one meta parameter that can be used in models. Each meta parameter is automatically a EventModelBuilder.payload(String, String) element.

Specified by:

metaParameter in interface EventModelBuilder

fullPayload

public EventModelBuilder fullPayload(String name)

Description copied from interface: EventModelBuilder

Defines the property name for the full payload.

Specified by:

fullPayload in interface EventModelBuilder

createEventModel

public EventModel createEventModel()

Description copied from interface: EventModelBuilder

Creates a new event model, but does not deploy it to the Event registry engine.

Specified by:

createEventModel in interface EventModelBuilder

deploy

public EventDeployment deploy()

Description copied from interface: EventModelBuilder

Deploys a new event definition for this event model.

Specified by:

deploy in interface EventModelBuilder

buildEventModel

protected EventModel buildEventModel()