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

Interface NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder, NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Enclosing interface:

NettyEndpointBuilderFactory

public static interface NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder
extends NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder, NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Advanced builder for endpoint for the Netty component.

Method Summary

Modifier and Type	Method	Description
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	allowSerializedHeaders(boolean allowSerializedHeaders)	Only used for TCP when transferExchange is true.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	allowSerializedHeaders(String allowSerializedHeaders)	Only used for TCP when transferExchange is true.
default NettyEndpointBuilderFactory.NettyEndpointBuilder	basic()
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	channelGroup(io.netty.channel.group.ChannelGroup channelGroup)	To use a explicit ChannelGroup.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	channelGroup(String channelGroup)	To use a explicit ChannelGroup.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	nativeTransport(boolean nativeTransport)	Whether to use native transport instead of NIO.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	nativeTransport(String nativeTransport)	Whether to use native transport instead of NIO.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	options(String key, Object value)	Allows to configure additional netty options using option.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	options(Map values)	Allows to configure additional netty options using option.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	receiveBufferSize(int receiveBufferSize)	The TCP/UDP buffer sizes to be used during inbound communication.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	receiveBufferSize(String receiveBufferSize)	The TCP/UDP buffer sizes to be used during inbound communication.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	receiveBufferSizePredictor(int receiveBufferSizePredictor)	Configures the buffer size predictor.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	receiveBufferSizePredictor(String receiveBufferSizePredictor)	Configures the buffer size predictor.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	sendBufferSize(int sendBufferSize)	The TCP/UDP buffer sizes to be used during outbound communication.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	sendBufferSize(String sendBufferSize)	The TCP/UDP buffer sizes to be used during outbound communication.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	synchronous(boolean synchronous)	Sets whether synchronous processing should be strictly used.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	synchronous(String synchronous)	Sets whether synchronous processing should be strictly used.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	transferExchange(boolean transferExchange)	Only used for TCP.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	transferExchange(String transferExchange)	Only used for TCP.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	udpByteArrayCodec(boolean udpByteArrayCodec)	For UDP only.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	udpByteArrayCodec(String udpByteArrayCodec)	For UDP only.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	workerCount(int workerCount)	When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2).
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	workerCount(String workerCount)	When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2).
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	workerGroup(io.netty.channel.EventLoopGroup workerGroup)	To use a explicit EventLoopGroup as the boss thread pool.
default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder	workerGroup(String workerGroup)	To use a explicit EventLoopGroup as the boss thread pool.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

backlog, backlog, bossCount, bossCount, bossGroup, bossGroup, bridgeErrorHandler, bridgeErrorHandler, disconnectOnNoReply, disconnectOnNoReply, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, nettyServerBootstrapFactory, nettyServerBootstrapFactory, networkInterface, noReplyLogLevel, noReplyLogLevel, serverClosedChannelExceptionCaughtLogLevel, serverClosedChannelExceptionCaughtLogLevel, serverExceptionCaughtLogLevel, serverExceptionCaughtLogLevel, serverInitializerFactory, serverInitializerFactory, usingExecutorService, usingExecutorService

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

clientInitializerFactory, clientInitializerFactory, correlationManager, correlationManager, lazyChannelCreation, lazyChannelCreation, lazyStartProducer, lazyStartProducer, producerPoolEnabled, producerPoolEnabled, producerPoolMaxIdle, producerPoolMaxIdle, producerPoolMaxTotal, producerPoolMaxTotal, producerPoolMinEvictableIdle, producerPoolMinEvictableIdle, producerPoolMinIdle, producerPoolMinIdle, udpConnectionlessSending, udpConnectionlessSending, useByteBuf, useByteBuf

Method Detail

basic

default NettyEndpointBuilderFactory.NettyEndpointBuilder basic()

Specified by:

basic in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

basic in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

allowSerializedHeaders

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder allowSerializedHeaders(boolean allowSerializedHeaders)

Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

allowSerializedHeaders in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

allowSerializedHeaders in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

allowSerializedHeaders

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder allowSerializedHeaders(String allowSerializedHeaders)

Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

allowSerializedHeaders in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

allowSerializedHeaders in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

channelGroup

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder channelGroup(io.netty.channel.group.ChannelGroup channelGroup)

To use a explicit ChannelGroup. The option is a: <code>io.netty.channel.group.ChannelGroup</code> type. Group: advanced

Specified by:

channelGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

channelGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

channelGroup - the value to set

Returns:

the dsl builder

channelGroup

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder channelGroup(String channelGroup)

To use a explicit ChannelGroup. The option will be converted to a <code>io.netty.channel.group.ChannelGroup</code> type. Group: advanced

Specified by:

channelGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

channelGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

channelGroup - the value to set

Returns:

the dsl builder

nativeTransport

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder nativeTransport(boolean nativeTransport)

Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

nativeTransport in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

nativeTransport in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

nativeTransport - the value to set

Returns:

the dsl builder

nativeTransport

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder nativeTransport(String nativeTransport)

Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

nativeTransport in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

nativeTransport in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

nativeTransport - the value to set

Returns:

the dsl builder

options

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder options(String key,
                                                                         Object value)

Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

options in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

options in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

key - the option key

value - the option value

Returns:

the dsl builder

options

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder options(Map values)

Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced

Specified by:

options in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

options in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

values - the values

Returns:

the dsl builder

receiveBufferSize

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder receiveBufferSize(int receiveBufferSize)

The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. The option is a: <code>int</code> type. Default: 65536 Group: advanced

Specified by:

receiveBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

receiveBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

receiveBufferSize - the value to set

Returns:

the dsl builder

receiveBufferSize

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder receiveBufferSize(String receiveBufferSize)

The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. The option will be converted to a <code>int</code> type. Default: 65536 Group: advanced

Specified by:

receiveBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

receiveBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

receiveBufferSize - the value to set

Returns:

the dsl builder

receiveBufferSizePredictor

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder receiveBufferSizePredictor(int receiveBufferSizePredictor)

Configures the buffer size predictor. See details at Jetty documentation and this mail thread. The option is a: <code>int</code> type. Group: advanced

Specified by:

receiveBufferSizePredictor in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

receiveBufferSizePredictor in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

receiveBufferSizePredictor - the value to set

Returns:

the dsl builder

receiveBufferSizePredictor

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder receiveBufferSizePredictor(String receiveBufferSizePredictor)

Configures the buffer size predictor. See details at Jetty documentation and this mail thread. The option will be converted to a <code>int</code> type. Group: advanced

Specified by:

receiveBufferSizePredictor in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

receiveBufferSizePredictor in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

receiveBufferSizePredictor - the value to set

Returns:

the dsl builder

sendBufferSize

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder sendBufferSize(int sendBufferSize)

The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. The option is a: <code>int</code> type. Default: 65536 Group: advanced

Specified by:

sendBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

sendBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

sendBufferSize - the value to set

Returns:

the dsl builder

sendBufferSize

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder sendBufferSize(String sendBufferSize)

The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. The option will be converted to a <code>int</code> type. Default: 65536 Group: advanced

Specified by:

sendBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

sendBufferSize in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

sendBufferSize - the value to set

Returns:

the dsl builder

synchronous

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

synchronous in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

synchronous in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

synchronous in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

transferExchange

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder transferExchange(boolean transferExchange)

Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

transferExchange in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

transferExchange in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

transferExchange

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder transferExchange(String transferExchange)

Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

transferExchange in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

transferExchange in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

udpByteArrayCodec

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder udpByteArrayCodec(boolean udpByteArrayCodec)

For UDP only. If enabled the using byte array codec instead of Java serialization protocol. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

udpByteArrayCodec in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

udpByteArrayCodec in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

udpByteArrayCodec - the value to set

Returns:

the dsl builder

udpByteArrayCodec

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder udpByteArrayCodec(String udpByteArrayCodec)

For UDP only. If enabled the using byte array codec instead of Java serialization protocol. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

udpByteArrayCodec in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

udpByteArrayCodec in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

udpByteArrayCodec - the value to set

Returns:

the dsl builder

workerCount

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder workerCount(int workerCount)

When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty. The option is a: <code>int</code> type. Group: advanced

Specified by:

workerCount in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

workerCount in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

workerCount - the value to set

Returns:

the dsl builder

workerCount

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder workerCount(String workerCount)

When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty. The option will be converted to a <code>int</code> type. Group: advanced

Specified by:

workerCount in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

workerCount in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

workerCount - the value to set

Returns:

the dsl builder

workerGroup

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder workerGroup(io.netty.channel.EventLoopGroup workerGroup)

To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. The option is a: <code>io.netty.channel.EventLoopGroup</code> type. Group: advanced

Specified by:

workerGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

workerGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

workerGroup - the value to set

Returns:

the dsl builder

workerGroup

default NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder workerGroup(String workerGroup)

To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. The option will be converted to a <code>io.netty.channel.EventLoopGroup</code> type. Group: advanced

Specified by:

workerGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

Specified by:

workerGroup in interface NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder

Parameters:

workerGroup - the value to set

Returns:

the dsl builder