Interface NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder

    • Method Detail

      • 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: org.apache.camel.component.netty.NettyConfiguration type. Group: common
      • disconnect

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder disconnect​(boolean 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: boolean type. Default: false Group: common
      • 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: boolean type. Default: false Group: common
      • 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: boolean type. Default: false Group: consumer
      • 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: int type. Default: 10000 Group: consumer
      • backlog

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder backlog​(int 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: int type. Group: consumer (advanced)
      • bossCount

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder bossCount​(int 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: int type. Default: 1 Group: consumer (advanced)
      • 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: io.netty.channel.EventLoopGroup type. Group: consumer (advanced)
      • 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: boolean type. Default: true Group: consumer (advanced)
      • executorService

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder executorService​(io.netty.util.concurrent.EventExecutorGroup executorService)
        To use the given EventExecutorGroup. The option is a: io.netty.util.concurrent.EventExecutorGroup type. Group: consumer (advanced)
      • 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: int type. Group: consumer (advanced)
      • nettyServerBootstrapFactory

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder nettyServerBootstrapFactory​(org.apache.camel.component.netty.NettyServerBootstrapFactory nettyServerBootstrapFactory)
        To use a custom NettyServerBootstrapFactory. The option is a: org.apache.camel.component.netty.NettyServerBootstrapFactory type. Group: consumer (advanced)
      • 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: java.lang.String type. Group: consumer (advanced)
      • 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: org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)
      • 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: org.apache.camel.LoggingLevel type. Default: DEBUG Group: consumer (advanced)
      • 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: org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)
      • serverInitializerFactory

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder serverInitializerFactory​(org.apache.camel.component.netty.ServerInitializerFactory serverInitializerFactory)
        To use a custom ServerInitializerFactory. The option is a: org.apache.camel.component.netty.ServerInitializerFactory type. Group: consumer (advanced)
      • 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: boolean type. Default: true Group: consumer (advanced)
      • 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: boolean type. Default: false Group: producer
      • 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: long type. Group: producer
      • clientInitializerFactory

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder clientInitializerFactory​(org.apache.camel.component.netty.ClientInitializerFactory clientInitializerFactory)
        To use a custom ClientInitializerFactory. The option is a: org.apache.camel.component.netty.ClientInitializerFactory type. Group: producer (advanced)
      • 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: org.apache.camel.component.netty.NettyCamelStateCorrelationManager type. Group: producer (advanced)
      • 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: boolean type. Default: true Group: producer (advanced)
      • 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: boolean type. Default: true Group: producer (advanced)
      • producerPoolMaxActive

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder producerPoolMaxActive​(int producerPoolMaxActive)
        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: int type. Default: -1 Group: producer (advanced)
      • 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: long type. Default: 300000 Group: producer (advanced)
      • 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: int type. Group: producer (advanced)
      • 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: boolean type. Default: false Group: producer (advanced)
      • useByteBuf

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder useByteBuf​(boolean useByteBuf)
        If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out. The option is a: boolean type. Default: false Group: producer (advanced)
      • 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: boolean type. Default: false Group: advanced
      • 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: boolean type. Default: true Group: advanced
      • 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: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      • 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: boolean type. Default: false Group: advanced
      • 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: org.apache.camel.component.netty.http.NettyHttpBinding type. Group: advanced
      • 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: java.util.Map type. Group: advanced
      • 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: int type. Group: advanced
      • 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: boolean type. Default: false Group: advanced
      • 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: boolean type. Default: false Group: advanced
      • workerCount

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder 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: int type. Group: advanced
      • 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: io.netty.channel.EventLoopGroup type. Group: advanced
      • 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: boolean type. Default: true Group: codec
      • 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: boolean type. Default: true Group: codec
      • decoders

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder decoders​(List<io.netty.channel.ChannelHandler> 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: java.util.List type. Group: codec
      • 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: org.apache.camel.component.netty.TextLineDelimiter type. Default: LINE Group: codec
      • encoders

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder encoders​(List<io.netty.channel.ChannelHandler> 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: java.util.List type. Group: codec
      • textline

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder textline​(boolean 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: boolean type. Default: false Group: codec
      • 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: java.lang.String type. Group: security
      • 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: org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration type. Group: security
      • 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: boolean type. Default: false Group: security
      • sslContextParameters

        default NettyHttpComponentBuilderFactory.NettyHttpComponentBuilder sslContextParameters​(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
        To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      • 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: java.lang.String type. Group: security