Package org.apache.camel.builder.endpoint.dsl

Interface NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder, NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Enclosing interface:

NatsEndpointBuilderFactory

public static interface NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder
extends NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder, NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Advanced builder for endpoint for the Nats component.

Method Summary

Modifier and Type	Method	Description
default NatsEndpointBuilderFactory.NatsEndpointBuilder	basic()
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	connection(io.nats.client.Connection connection)	Reference an already instantiated connection to Nats server.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	connection(String connection)	Reference an already instantiated connection to Nats server.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	consumerConfiguration(io.nats.client.api.ConsumerConfiguration consumerConfiguration)	Sets a custom ConsumerConfiguration object for the JetStream consumer.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	consumerConfiguration(String consumerConfiguration)	Sets a custom ConsumerConfiguration object for the JetStream consumer.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	durableName(String durableName)	Sets the name to assign to the JetStream durable consumer.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom header filter strategy.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom header filter strategy.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	jetstreamAsync(boolean jetstreamAsync)	Sets whether to operate JetStream requests asynchronously.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	jetstreamAsync(String jetstreamAsync)	Sets whether to operate JetStream requests asynchronously.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	pullSubscription(boolean pullSubscription)	Sets the consumer subscription type for JetStream.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	pullSubscription(String pullSubscription)	Sets the consumer subscription type for JetStream.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	traceConnection(boolean traceConnection)	Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues.
default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder	traceConnection(String traceConnection)	Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

lazyStartProducer, lazyStartProducer

Method Details

basic

default NatsEndpointBuilderFactory.NatsEndpointBuilder basic()

Specified by:

basic in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

basic in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

connection

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder connection(io.nats.client.Connection connection)

Reference an already instantiated connection to Nats server. The option is a: io.nats.client.Connection type. Group: advanced

Specified by:

connection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

connection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

connection - the value to set

Returns:

the dsl builder

connection

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder connection(String connection)

Reference an already instantiated connection to Nats server. The option will be converted to a io.nats.client.Connection type. Group: advanced

Specified by:

connection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

connection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

connection - the value to set

Returns:

the dsl builder

consumerConfiguration

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder consumerConfiguration(io.nats.client.api.ConsumerConfiguration consumerConfiguration)

Sets a custom ConsumerConfiguration object for the JetStream consumer. This is an advanced option typically used when you need to configure properties not exposed as simple Camel URI parameters. When set, this object will be used to build the final consumer subscription options. The option is a: io.nats.client.api.ConsumerConfiguration type. Group: advanced

Specified by:

consumerConfiguration in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

consumerConfiguration in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

consumerConfiguration - the value to set

Returns:

the dsl builder

consumerConfiguration

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder consumerConfiguration(String consumerConfiguration)

Sets a custom ConsumerConfiguration object for the JetStream consumer. This is an advanced option typically used when you need to configure properties not exposed as simple Camel URI parameters. When set, this object will be used to build the final consumer subscription options. The option will be converted to a io.nats.client.api.ConsumerConfiguration type. Group: advanced

Specified by:

consumerConfiguration in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

consumerConfiguration in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

consumerConfiguration - the value to set

Returns:

the dsl builder

durableName

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder durableName(String durableName)

Sets the name to assign to the JetStream durable consumer. Setting this value makes the consumer durable. The value is used to set the durable() field in the underlying NATS ConsumerConfiguration.Builder. The option is a: java.lang.String type. Group: advanced

Specified by:

durableName in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

durableName in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

durableName - the value to set

Returns:

the dsl builder

headerFilterStrategy

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom header filter strategy. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced

Specified by:

headerFilterStrategy in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom header filter strategy. The option will be converted to a org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced

Specified by:

headerFilterStrategy in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

jetstreamAsync

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder jetstreamAsync(boolean jetstreamAsync)

Sets whether to operate JetStream requests asynchronously. The option is a: boolean type. Default: true Group: advanced

Specified by:

jetstreamAsync in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

jetstreamAsync in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

jetstreamAsync - the value to set

Returns:

the dsl builder

jetstreamAsync

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder jetstreamAsync(String jetstreamAsync)

Sets whether to operate JetStream requests asynchronously. The option will be converted to a boolean type. Default: true Group: advanced

Specified by:

jetstreamAsync in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

jetstreamAsync in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

jetstreamAsync - the value to set

Returns:

the dsl builder

pullSubscription

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder pullSubscription(boolean pullSubscription)

Sets the consumer subscription type for JetStream. Set to true to use a Pull Subscription (consumer explicitly requests messages). Set to false to use a Push Subscription (messages are automatically delivered). The option is a: boolean type. Default: true Group: advanced

Specified by:

pullSubscription in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

pullSubscription in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

pullSubscription - the value to set

Returns:

the dsl builder

pullSubscription

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder pullSubscription(String pullSubscription)

Sets the consumer subscription type for JetStream. Set to true to use a Pull Subscription (consumer explicitly requests messages). Set to false to use a Push Subscription (messages are automatically delivered). The option will be converted to a boolean type. Default: true Group: advanced

Specified by:

pullSubscription in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

pullSubscription in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

pullSubscription - the value to set

Returns:

the dsl builder

traceConnection

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder traceConnection(boolean traceConnection)

Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues. The option is a: boolean type. Default: false Group: advanced

Specified by:

traceConnection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

traceConnection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

traceConnection - the value to set

Returns:

the dsl builder

traceConnection

default NatsEndpointBuilderFactory.AdvancedNatsEndpointBuilder traceConnection(String traceConnection)

Whether or not connection trace messages should be printed to standard out for fine grained debugging of connection issues. The option will be converted to a boolean type. Default: false Group: advanced

Specified by:

traceConnection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointConsumerBuilder

Specified by:

traceConnection in interface NatsEndpointBuilderFactory.AdvancedNatsEndpointProducerBuilder

Parameters:

traceConnection - the value to set

Returns:

the dsl builder