Interface NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.netty.http.NettyHttpComponent>
- All Known Implementing Classes:
NettyHttpComponentBuilderFactory.NettyHttpComponentBuilderImpl
- Enclosing interface:
- NettyHttpComponentBuilderFactory
public static interface NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder
extends ComponentBuilder<org.apache.camel.component.netty.http.NettyHttpComponent>
Builder for the Netty HTTP component.
-
Method Summary
Modifier and TypeMethodDescriptionallowDefaultCodec
(boolean allowDefaultCodec) The netty component installs a default codec if both, encoder/decoder is null and textline is false.allowSerializedHeaders
(boolean allowSerializedHeaders) Only used for TCP when transferExchange is true.autoAppendDelimiter
(boolean autoAppendDelimiter) Whether or not to auto append missing end delimiter when sending using the textline codec.autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.backlog
(int backlog) Allows to configure a backlog for netty consumer (server).bossCount
(int bossCount) When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1.bossGroup
(io.netty.channel.EventLoopGroup bossGroup) Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint.bridgeErrorHandler
(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.broadcast
(boolean broadcast) Setting to choose Multicast over UDP.channelGroup
(io.netty.channel.group.ChannelGroup channelGroup) To use a explicit ChannelGroup.clientInitializerFactory
(org.apache.camel.component.netty.ClientInitializerFactory clientInitializerFactory) To use a custom ClientInitializerFactory.clientMode
(boolean clientMode) If the clientMode is true, netty consumer will connect the address as a TCP client.configuration
(org.apache.camel.component.netty.NettyConfiguration configuration) To use the NettyConfiguration as configuration when creating endpoints.connectTimeout
(int connectTimeout) Time to wait for a socket connection to be available.correlationManager
(org.apache.camel.component.netty.NettyCamelStateCorrelationManager correlationManager) To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer.decoderMaxLineLength
(int decoderMaxLineLength) The max line length to use for the textline codec.A list of decoders to be used.delimiter
(org.apache.camel.component.netty.TextLineDelimiter delimiter) The delimiter to use for the textline codec.disconnect
(boolean disconnect) Whether or not to disconnect(close) from Netty Channel right after use.disconnectOnNoReply
(boolean disconnectOnNoReply) If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.enabledProtocols
(String enabledProtocols) Which protocols to enable when using SSL.A list of encoders to be used.The encoding (a charset name) to use for the textline codec.executorService
(io.netty.util.concurrent.EventExecutorGroup executorService) To use the given EventExecutorGroup.headerFilterStrategy
(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.hostnameVerification
(boolean hostnameVerification) To enable/disable hostname verification on SSLEngine.keepAlive
(boolean keepAlive) Setting to ensure socket is not closed due to inactivity.keyStoreFile
(File keyStoreFile) Client side certificate keystore to be used for encryption.keyStoreFormat
(String keyStoreFormat) Keystore format to be used for payload encryption.keyStoreResource
(String keyStoreResource) Client side certificate keystore to be used for encryption.lazyChannelCreation
(boolean lazyChannelCreation) Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.lazyStartProducer
(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).maximumPoolSize
(int maximumPoolSize) Sets a maximum thread pool size for the netty consumer ordered thread pool.muteException
(boolean muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.nativeTransport
(boolean nativeTransport) Whether to use native transport instead of NIO.needClientAuth
(boolean needClientAuth) Configures whether the server needs client authentication when using SSL.nettyHttpBinding
(org.apache.camel.component.netty.http.NettyHttpBinding nettyHttpBinding) To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.nettyServerBootstrapFactory
(org.apache.camel.component.netty.NettyServerBootstrapFactory nettyServerBootstrapFactory) To use a custom NettyServerBootstrapFactory.networkInterface
(String networkInterface) When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group.noReplyLogLevel
(org.apache.camel.LoggingLevel noReplyLogLevel) If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.Allows to configure additional netty options using option.passphrase
(String passphrase) Password setting to use in order to encrypt/decrypt payloads sent using SSH.producerPoolBlockWhenExhausted
(boolean producerPoolBlockWhenExhausted) Sets the value for the blockWhenExhausted configuration attribute.producerPoolEnabled
(boolean producerPoolEnabled) Whether producer pool is enabled or not.producerPoolMaxIdle
(int producerPoolMaxIdle) Sets the cap on the number of idle instances in the pool.producerPoolMaxTotal
(int producerPoolMaxTotal) Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.producerPoolMaxWait
(long producerPoolMaxWait) Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true.producerPoolMinEvictableIdle
(long producerPoolMinEvictableIdle) Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.producerPoolMinIdle
(int producerPoolMinIdle) Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.receiveBufferSize
(int receiveBufferSize) The TCP/UDP buffer sizes to be used during inbound communication.receiveBufferSizePredictor
(int receiveBufferSizePredictor) Configures the buffer size predictor.reconnect
(boolean reconnect) Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled.reconnectInterval
(int reconnectInterval) Used if reconnect and clientMode is enabled.requestTimeout
(long requestTimeout) Allows to use a timeout for the Netty producer when calling a remote server.reuseAddress
(boolean reuseAddress) Setting to facilitate socket multiplexing.reuseChannel
(boolean reuseChannel) This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange.securityConfiguration
(org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration securityConfiguration) Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.securityProvider
(String securityProvider) Security provider to be used for payload encryption.sendBufferSize
(int sendBufferSize) The TCP/UDP buffer sizes to be used during outbound communication.serverClosedChannelExceptionCaughtLogLevel
(org.apache.camel.LoggingLevel serverClosedChannelExceptionCaughtLogLevel) If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level.serverExceptionCaughtLogLevel
(org.apache.camel.LoggingLevel serverExceptionCaughtLogLevel) If the server (NettyConsumer) catches an exception then its logged using this logging level.serverInitializerFactory
(org.apache.camel.component.netty.ServerInitializerFactory serverInitializerFactory) To use a custom ServerInitializerFactory.ssl
(boolean ssl) Setting to specify whether SSL encryption is applied to this endpoint.sslClientCertHeaders
(boolean sslClientCertHeaders) When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.sslHandler
(io.netty.handler.ssl.SslHandler sslHandler) Reference to a class that could be used to return an SSL Handler.sync
(boolean sync) Setting to set endpoint as one-way or request-response.tcpNoDelay
(boolean tcpNoDelay) Setting to improve TCP protocol performance.textline
(boolean textline) Only used for TCP.transferExchange
(boolean transferExchange) Only used for TCP.trustStoreFile
(File trustStoreFile) Server side certificate keystore to be used for encryption.trustStoreResource
(String trustStoreResource) Server side certificate keystore to be used for encryption.udpByteArrayCodec
(boolean udpByteArrayCodec) For UDP only.udpConnectionlessSending
(boolean udpConnectionlessSending) This option supports connection less udp sending which is a real fire and forget.useByteBuf
(boolean useByteBuf) If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out.useGlobalSslContextParameters
(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters.usingExecutorService
(boolean usingExecutorService) Whether to use ordered thread pool, to ensure events are processed orderly on the same channel.workerCount
(int workerCount) When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2).workerGroup
(io.netty.channel.EventLoopGroup workerGroup) To use a explicit EventLoopGroup as the boss thread pool.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
configuration
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder configuration(org.apache.camel.component.netty.NettyConfiguration configuration) To use the NettyConfiguration as configuration when creating endpoints. The option is a: <code>org.apache.camel.component.netty.NettyConfiguration</code> type. Group: common- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
disconnect
Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
disconnect
- the value to set- Returns:
- the dsl builder
-
keepAlive
Setting to ensure socket is not closed due to inactivity. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
keepAlive
- the value to set- Returns:
- the dsl builder
-
reuseAddress
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder reuseAddress(boolean reuseAddress) Setting to facilitate socket multiplexing. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
reuseAddress
- the value to set- Returns:
- the dsl builder
-
reuseChannel
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder reuseChannel(boolean reuseChannel) This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
reuseChannel
- the value to set- Returns:
- the dsl builder
-
sync
Setting to set endpoint as one-way or request-response. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
sync
- the value to set- Returns:
- the dsl builder
-
tcpNoDelay
Setting to improve TCP protocol performance. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
tcpNoDelay
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
broadcast
Setting to choose Multicast over UDP. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
broadcast
- the value to set- Returns:
- the dsl builder
-
clientMode
If the clientMode is true, netty consumer will connect the address as a TCP client. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
clientMode
- the value to set- Returns:
- the dsl builder
-
muteException
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder muteException(boolean muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
muteException
- the value to set- Returns:
- the dsl builder
-
reconnect
Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
reconnect
- the value to set- Returns:
- the dsl builder
-
reconnectInterval
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder reconnectInterval(int reconnectInterval) Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection. The option is a: <code>int</code> type. Default: 10000 Group: consumer- Parameters:
reconnectInterval
- the value to set- Returns:
- the dsl builder
-
backlog
Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting. The option is a: <code>int</code> type. Group: consumer (advanced)- Parameters:
backlog
- the value to set- Returns:
- the dsl builder
-
bossCount
When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty. The option is a: <code>int</code> type. Default: 1 Group: consumer (advanced)- Parameters:
bossCount
- the value to set- Returns:
- the dsl builder
-
bossGroup
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder bossGroup(io.netty.channel.EventLoopGroup bossGroup) Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint. The option is a: <code>io.netty.channel.EventLoopGroup</code> type. Group: consumer (advanced)- Parameters:
bossGroup
- the value to set- Returns:
- the dsl builder
-
disconnectOnNoReply
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder disconnectOnNoReply(boolean disconnectOnNoReply) If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)- Parameters:
disconnectOnNoReply
- the value to set- Returns:
- the dsl builder
-
executorService
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder executorService(io.netty.util.concurrent.EventExecutorGroup executorService) To use the given EventExecutorGroup. The option is a: <code>io.netty.util.concurrent.EventExecutorGroup</code> type. Group: consumer (advanced)- Parameters:
executorService
- the value to set- Returns:
- the dsl builder
-
maximumPoolSize
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder maximumPoolSize(int maximumPoolSize) Sets a maximum thread pool size for the netty consumer ordered thread pool. The default size is 2 x cpu_core plus 1. Setting this value to eg 10 will then use 10 threads unless 2 x cpu_core plus 1 is a higher value, which then will override and be used. For example if there are 8 cores, then the consumer thread pool will be 17. This thread pool is used to route messages received from Netty by Camel. We use a separate thread pool to ensure ordering of messages and also in case some messages will block, then nettys worker threads (event loop) wont be affected. The option is a: <code>int</code> type. Group: consumer (advanced)- Parameters:
maximumPoolSize
- the value to set- Returns:
- the dsl builder
-
nettyServerBootstrapFactory
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder nettyServerBootstrapFactory(org.apache.camel.component.netty.NettyServerBootstrapFactory nettyServerBootstrapFactory) To use a custom NettyServerBootstrapFactory. The option is a: <code>org.apache.camel.component.netty.NettyServerBootstrapFactory</code> type. Group: consumer (advanced)- Parameters:
nettyServerBootstrapFactory
- the value to set- Returns:
- the dsl builder
-
networkInterface
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder networkInterface(String networkInterface) When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)- Parameters:
networkInterface
- the value to set- Returns:
- the dsl builder
-
noReplyLogLevel
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder noReplyLogLevel(org.apache.camel.LoggingLevel noReplyLogLevel) If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: consumer (advanced)- Parameters:
noReplyLogLevel
- the value to set- Returns:
- the dsl builder
-
serverClosedChannelExceptionCaughtLogLevel
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder serverClosedChannelExceptionCaughtLogLevel(org.apache.camel.LoggingLevel serverClosedChannelExceptionCaughtLogLevel) If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: DEBUG Group: consumer (advanced)- Parameters:
serverClosedChannelExceptionCaughtLogLevel
- the value to set- Returns:
- the dsl builder
-
serverExceptionCaughtLogLevel
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder serverExceptionCaughtLogLevel(org.apache.camel.LoggingLevel serverExceptionCaughtLogLevel) If the server (NettyConsumer) catches an exception then its logged using this logging level. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: WARN Group: consumer (advanced)- Parameters:
serverExceptionCaughtLogLevel
- the value to set- Returns:
- the dsl builder
-
serverInitializerFactory
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder serverInitializerFactory(org.apache.camel.component.netty.ServerInitializerFactory serverInitializerFactory) To use a custom ServerInitializerFactory. The option is a: <code>org.apache.camel.component.netty.ServerInitializerFactory</code> type. Group: consumer (advanced)- Parameters:
serverInitializerFactory
- the value to set- Returns:
- the dsl builder
-
usingExecutorService
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder usingExecutorService(boolean usingExecutorService) Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)- Parameters:
usingExecutorService
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder connectTimeout(int connectTimeout) Time to wait for a socket connection to be available. Value is in milliseconds. The option is a: <code>int</code> type. Default: 10000 Group: producer- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
requestTimeout
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder requestTimeout(long requestTimeout) Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. The option is a: <code>long</code> type. Group: producer- Parameters:
requestTimeout
- the value to set- Returns:
- the dsl builder
-
clientInitializerFactory
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder clientInitializerFactory(org.apache.camel.component.netty.ClientInitializerFactory clientInitializerFactory) To use a custom ClientInitializerFactory. The option is a: <code>org.apache.camel.component.netty.ClientInitializerFactory</code> type. Group: producer (advanced)- Parameters:
clientInitializerFactory
- the value to set- Returns:
- the dsl builder
-
correlationManager
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder correlationManager(org.apache.camel.component.netty.NettyCamelStateCorrelationManager correlationManager) To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details. The option is a: <code>org.apache.camel.component.netty.NettyCamelStateCorrelationManager</code> type. Group: producer (advanced)- Parameters:
correlationManager
- the value to set- Returns:
- the dsl builder
-
lazyChannelCreation
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder lazyChannelCreation(boolean lazyChannelCreation) Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)- Parameters:
lazyChannelCreation
- the value to set- Returns:
- the dsl builder
-
producerPoolBlockWhenExhausted
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolBlockWhenExhausted(boolean producerPoolBlockWhenExhausted) Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached). The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)- Parameters:
producerPoolBlockWhenExhausted
- the value to set- Returns:
- the dsl builder
-
producerPoolEnabled
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolEnabled(boolean producerPoolEnabled) Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details. The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)- Parameters:
producerPoolEnabled
- the value to set- Returns:
- the dsl builder
-
producerPoolMaxIdle
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMaxIdle(int producerPoolMaxIdle) Sets the cap on the number of idle instances in the pool. The option is a: <code>int</code> type. Default: 100 Group: producer (advanced)- Parameters:
producerPoolMaxIdle
- the value to set- Returns:
- the dsl builder
-
producerPoolMaxTotal
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMaxTotal(int producerPoolMaxTotal) Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit. The option is a: <code>int</code> type. Default: -1 Group: producer (advanced)- Parameters:
producerPoolMaxTotal
- the value to set- Returns:
- the dsl builder
-
producerPoolMaxWait
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMaxWait(long producerPoolMaxWait) Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely. The option is a: <code>long</code> type. Default: -1 Group: producer (advanced)- Parameters:
producerPoolMaxWait
- the value to set- Returns:
- the dsl builder
-
producerPoolMinEvictableIdle
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMinEvictableIdle(long producerPoolMinEvictableIdle) Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. The option is a: <code>long</code> type. Default: 300000 Group: producer (advanced)- Parameters:
producerPoolMinEvictableIdle
- the value to set- Returns:
- the dsl builder
-
producerPoolMinIdle
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMinIdle(int producerPoolMinIdle) Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. The option is a: <code>int</code> type. Group: producer (advanced)- Parameters:
producerPoolMinIdle
- the value to set- Returns:
- the dsl builder
-
udpConnectionlessSending
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder udpConnectionlessSending(boolean udpConnectionlessSending) This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
udpConnectionlessSending
- the value to set- Returns:
- the dsl builder
-
useByteBuf
If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
useByteBuf
- the value to set- Returns:
- the dsl builder
-
hostnameVerification
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder hostnameVerification(boolean hostnameVerification) To enable/disable hostname verification on SSLEngine. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
hostnameVerification
- the value to set- Returns:
- the dsl builder
-
allowSerializedHeaders
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
allowSerializedHeaders
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
channelGroup
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
channelGroup
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
nativeTransport
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
nativeTransport
- the value to set- Returns:
- the dsl builder
-
nettyHttpBinding
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder nettyHttpBinding(org.apache.camel.component.netty.http.NettyHttpBinding nettyHttpBinding) To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option is a: <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> type. Group: advanced- Parameters:
nettyHttpBinding
- the value to set- Returns:
- the dsl builder
-
options
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder options(Map<String, Object> options) 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<java.lang.String, java.lang.Object></code> type. Group: advanced- Parameters:
options
- the value to set- Returns:
- the dsl builder
-
receiveBufferSize
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
receiveBufferSize
- the value to set- Returns:
- the dsl builder
-
receiveBufferSizePredictor
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
receiveBufferSizePredictor
- the value to set- Returns:
- the dsl builder
-
sendBufferSize
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
sendBufferSize
- the value to set- Returns:
- the dsl builder
-
transferExchange
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
transferExchange
- the value to set- Returns:
- the dsl builder
-
udpByteArrayCodec
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
udpByteArrayCodec
- the value to set- Returns:
- the dsl builder
-
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- Parameters:
workerCount
- the value to set- Returns:
- the dsl builder
-
workerGroup
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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- Parameters:
workerGroup
- the value to set- Returns:
- the dsl builder
-
allowDefaultCodec
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder allowDefaultCodec(boolean allowDefaultCodec) The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. The option is a: <code>boolean</code> type. Default: true Group: codec- Parameters:
allowDefaultCodec
- the value to set- Returns:
- the dsl builder
-
autoAppendDelimiter
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder autoAppendDelimiter(boolean autoAppendDelimiter) Whether or not to auto append missing end delimiter when sending using the textline codec. The option is a: <code>boolean</code> type. Default: true Group: codec- Parameters:
autoAppendDelimiter
- the value to set- Returns:
- the dsl builder
-
decoderMaxLineLength
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder decoderMaxLineLength(int decoderMaxLineLength) The max line length to use for the textline codec. The option is a: <code>int</code> type. Default: 1024 Group: codec- Parameters:
decoderMaxLineLength
- the value to set- Returns:
- the dsl builder
-
decoders
A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option is a: <code>java.lang.String</code> type. Group: codec- Parameters:
decoders
- the value to set- Returns:
- the dsl builder
-
delimiter
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder delimiter(org.apache.camel.component.netty.TextLineDelimiter delimiter) The delimiter to use for the textline codec. Possible values are LINE and NULL. The option is a: <code>org.apache.camel.component.netty.TextLineDelimiter</code> type. Default: LINE Group: codec- Parameters:
delimiter
- the value to set- Returns:
- the dsl builder
-
encoders
A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. The option is a: <code>java.lang.String</code> type. Group: codec- Parameters:
encoders
- the value to set- Returns:
- the dsl builder
-
encoding
The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset. The option is a: <code>java.lang.String</code> type. Group: codec- Parameters:
encoding
- the value to set- Returns:
- the dsl builder
-
textline
Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default. The option is a: <code>boolean</code> type. Default: false Group: codec- Parameters:
textline
- the value to set- Returns:
- the dsl builder
-
enabledProtocols
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder enabledProtocols(String enabledProtocols) Which protocols to enable when using SSL. The option is a: <code>java.lang.String</code> type. Default: TLSv1.2,TLSv1.3 Group: security- Parameters:
enabledProtocols
- the value to set- Returns:
- the dsl builder
-
keyStoreFile
Client side certificate keystore to be used for encryption. The option is a: <code>java.io.File</code> type. Group: security- Parameters:
keyStoreFile
- the value to set- Returns:
- the dsl builder
-
keyStoreFormat
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder keyStoreFormat(String keyStoreFormat) Keystore format to be used for payload encryption. Defaults to JKS if not set. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
keyStoreFormat
- the value to set- Returns:
- the dsl builder
-
keyStoreResource
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder keyStoreResource(String keyStoreResource) Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
keyStoreResource
- the value to set- Returns:
- the dsl builder
-
needClientAuth
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder needClientAuth(boolean needClientAuth) Configures whether the server needs client authentication when using SSL. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
needClientAuth
- the value to set- Returns:
- the dsl builder
-
passphrase
Password setting to use in order to encrypt/decrypt payloads sent using SSH. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
passphrase
- the value to set- Returns:
- the dsl builder
-
securityConfiguration
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder securityConfiguration(org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration securityConfiguration) Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. The option is a: <code>org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration</code> type. Group: security- Parameters:
securityConfiguration
- the value to set- Returns:
- the dsl builder
-
securityProvider
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder securityProvider(String securityProvider) Security provider to be used for payload encryption. Defaults to SunX509 if not set. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
securityProvider
- the value to set- Returns:
- the dsl builder
-
ssl
Setting to specify whether SSL encryption is applied to this endpoint. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
ssl
- the value to set- Returns:
- the dsl builder
-
sslClientCertHeaders
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder sslClientCertHeaders(boolean sslClientCertHeaders) When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
sslClientCertHeaders
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslHandler
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder sslHandler(io.netty.handler.ssl.SslHandler sslHandler) Reference to a class that could be used to return an SSL Handler. The option is a: <code>io.netty.handler.ssl.SslHandler</code> type. Group: security- Parameters:
sslHandler
- the value to set- Returns:
- the dsl builder
-
trustStoreFile
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder trustStoreFile(File trustStoreFile) Server side certificate keystore to be used for encryption. The option is a: <code>java.io.File</code> type. Group: security- Parameters:
trustStoreFile
- the value to set- Returns:
- the dsl builder
-
trustStoreResource
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder trustStoreResource(String trustStoreResource) Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
trustStoreResource
- the value to set- Returns:
- the dsl builder
-
useGlobalSslContextParameters
default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters) Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security- Parameters:
useGlobalSslContextParameters
- the value to set- Returns:
- the dsl builder
-