Interface MessagingChannelConfig

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

MessagingIncomingConfig, MessagingOutgoingConfig

All Known Implementing Classes:

MessagingChannelConfig.BuilderBase.MessagingChannelConfigImpl, MessagingIncomingConfig.BuilderBase.MessagingIncomingConfigImpl, MessagingOutgoingConfig.BuilderBase.MessagingOutgoingConfigImpl

public interface MessagingChannelConfig
extends Prototype.Api

Common configuration of an incoming or outgoing messaging channel connection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MessagingChannelConfig.Builder	Fluent API builder for MessagingChannelConfig.
static class	MessagingChannelConfig.BuilderBase<BUILDER extends MessagingChannelConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends MessagingChannelConfig>	Fluent API builder base for MessagingChannelConfig.

Method Summary

Modifier and Type	Method	Description
static MessagingChannelConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static MessagingChannelConfig.Builder	builder(MessagingChannelConfig instance)	Create a new fluent API builder from an existing instance.
String	channelName()	Logical messaging channel name.
Optional<Config>	config()	Original channel configuration node, including connector-specific options.
String	connector()	Name of the configured connector instance used by this channel connection.
static MessagingChannelConfig	create(Config config)	Create a new instance from configuration.
MessagingExecutionConfig	execution()	Execution overrides for this channel.

Method Details

builder

static MessagingChannelConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static MessagingChannelConfig.Builder builder(MessagingChannelConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static MessagingChannelConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

connector

String connector()

Name of the configured connector instance used by this channel connection.

Returns:

connector instance name

channelName

String channelName()

Logical messaging channel name. Configuration-based channels derive this name from their map entry. Programmatic channel configurations supply the name explicitly.

Returns:

logical channel name

execution

MessagingExecutionConfig execution()

Execution overrides for this channel. Values not configured inherit the messaging defaults.

Returns:

channel execution overrides

config

Optional<Config> config()

Original channel configuration node, including connector-specific options.

Returns:

original configuration, if configured