Interface InboundChannelModelBuilder
-
public interface InboundChannelModelBuilder
A builder to create aInboundChannelModel
instance, which represents a channel from the 'outside world' to receive events. An inbound channel consists of the following parts: - An adapter that defines how/where the events are received, each with specific configurations. - An event processing pipeline, which transforms the incoming event and extracts data and metadata: - deserialization (from the 'raw' event to something else) - event key detection: detects the 'key' which will define theEventModel
to be used. - tenant detection (only relevant when using multi-tenant): detects a 'tenantId' which is used to determine the correctEventDefinition
. - payload extraction: with theEventModel
determined, the definition is used to extract the payload from the event data. - transformation: transforms the event to an internal representation, ready to be passed to theEventRegistry
. - (Optionally) custom steps (or override any of the above)- Author:
- Joram Barrez, Filip Hrisafov
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
InboundChannelModelBuilder.InboundEventKeyDetectorBuilder
Builder for the 'key detection' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventKeyJsonDetectorBuilder
Builder for the 'key detection' part of theInboundChannelModel
, specifically for JSON events.static interface
InboundChannelModelBuilder.InboundEventKeyXmlDetectorBuilder
Builder for the 'key detection' part of theInboundChannelModel
, specifically for XML events.static interface
InboundChannelModelBuilder.InboundEventPayloadExtractorBuilder
Builder for the 'payload extraction' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventPayloadJsonExtractorBuilder
Builder for the 'payload extraction' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventPayloadXmlExtractorBuilder
Builder for the 'payload extraction' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventProcessingPipelineBuilder
Builder for the 'processing pipeline' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventTenantDetectorBuilder
Builder for the 'tenant ID detection' part of theInboundChannelModel
.static interface
InboundChannelModelBuilder.InboundEventTenantJsonDetectorBuilder
Builder for the 'tenant ID detection' part of theInboundChannelModel
, specifically for JSON eventsstatic interface
InboundChannelModelBuilder.InboundEventTenantXmlDetectorBuilder
Builder for the 'tenant ID detection' part of theInboundChannelModel
, specifically for XML eventsstatic interface
InboundChannelModelBuilder.InboundEventTransformerBuilder
static interface
InboundChannelModelBuilder.InboundJmsChannelBuilder
Builder to create anInboundEventChannelAdapter
using JMS.static interface
InboundChannelModelBuilder.InboundKafkaChannelBuilder
Builder to create anInboundEventChannelAdapter
using Kafka.static interface
InboundChannelModelBuilder.InboundRabbitChannelBuilder
Builder to create anInboundEventChannelAdapter
using RabbitMQ.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InboundChannelModelBuilder
category(String category)
Set the category for the channel deployment.InboundChannelModelBuilder.InboundEventProcessingPipelineBuilder
channelAdapter(String delegateExpression)
Sets a customInboundEventChannelAdapter
via a delegate expression.EventDeployment
deploy()
Creates theInboundChannelModel
instance based on the configuration and registers it with theEventRepositoryService
.InboundChannelModelBuilder
deploymentName(String deploymentName)
Set the name for the channel deployment.InboundChannelModelBuilder
deploymentTenantId(String deploymentTenantId)
Set the tenant id for the channel deployment.InboundChannelModelBuilder.InboundJmsChannelBuilder
jmsChannelAdapter(String destinationName)
Configures an adapter which will receive events using JMS.InboundChannelModelBuilder.InboundKafkaChannelBuilder
kafkaChannelAdapter(String topic)
Configures an adapter which receives events using Kafka.InboundChannelModelBuilder
key(String key)
Each channel needs to have a unique key to identity it.InboundChannelModelBuilder
parentDeploymentId(String parentDeploymentId)
Set the parent deployment id for the channel deployment.InboundChannelModelBuilder.InboundRabbitChannelBuilder
rabbitChannelAdapter(String queue)
Configures an adapter which will receive events using a RabbitMQ.InboundChannelModelBuilder
resourceName(String resourceName)
Set the resource name for the channel model.
-
-
-
Method Detail
-
key
InboundChannelModelBuilder key(String key)
Each channel needs to have a unique key to identity it.
-
deploymentName
InboundChannelModelBuilder deploymentName(String deploymentName)
Set the name for the channel deployment.
-
resourceName
InboundChannelModelBuilder resourceName(String resourceName)
Set the resource name for the channel model.
-
category
InboundChannelModelBuilder category(String category)
Set the category for the channel deployment.
-
deploymentTenantId
InboundChannelModelBuilder deploymentTenantId(String deploymentTenantId)
Set the tenant id for the channel deployment.
-
parentDeploymentId
InboundChannelModelBuilder parentDeploymentId(String parentDeploymentId)
Set the parent deployment id for the channel deployment.
-
channelAdapter
InboundChannelModelBuilder.InboundEventProcessingPipelineBuilder channelAdapter(String delegateExpression)
Sets a customInboundEventChannelAdapter
via a delegate expression.
-
jmsChannelAdapter
InboundChannelModelBuilder.InboundJmsChannelBuilder jmsChannelAdapter(String destinationName)
Configures an adapter which will receive events using JMS.
-
rabbitChannelAdapter
InboundChannelModelBuilder.InboundRabbitChannelBuilder rabbitChannelAdapter(String queue)
Configures an adapter which will receive events using a RabbitMQ.
-
kafkaChannelAdapter
InboundChannelModelBuilder.InboundKafkaChannelBuilder kafkaChannelAdapter(String topic)
Configures an adapter which receives events using Kafka.
-
deploy
EventDeployment deploy()
Creates theInboundChannelModel
instance based on the configuration and registers it with theEventRepositoryService
.
-
-