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

Interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    NettyEndpointBuilderFactory.AdvancedNettyEndpointBuilder
    Enclosing interface:
    NettyEndpointBuilderFactory
    public static interface NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the Netty component.

    • Method Detail

      • backlog

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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: <code>int</code> type. Group: consumer (advanced)
        Parameters:
        backlog - the value to set
        Returns:
        the dsl builder

      • backlog

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder backlog​(String 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 will be converted to a <code>int</code> type. Group: consumer (advanced)
        Parameters:
        backlog - the value to set
        Returns:
        the dsl builder

      • bossCount

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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: <code>int</code> type. Default: 1 Group: consumer (advanced)
        Parameters:
        bossCount - the value to set
        Returns:
        the dsl builder

      • bossCount

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder bossCount​(String 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 will be converted to a <code>int</code> type. Default: 1 Group: consumer (advanced)
        Parameters:
        bossCount - the value to set
        Returns:
        the dsl builder

      • bossGroup

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder bossGroup​(Object 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

      • bossGroup

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder bossGroup​(String bossGroup)
        Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint. The option will be converted to a <code>io.netty.channel.EventLoopGroup</code> type. Group: consumer (advanced)
        Parameters:
        bossGroup - the value to set
        Returns:
        the dsl builder

      • disconnectOnNoReply

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • disconnectOnNoReply

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder disconnectOnNoReply​(String disconnectOnNoReply)
        If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        disconnectOnNoReply - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • nettyServerBootstrapFactory

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder nettyServerBootstrapFactory​(Object 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

      • nettyServerBootstrapFactory

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder nettyServerBootstrapFactory​(String nettyServerBootstrapFactory)
        To use a custom NettyServerBootstrapFactory. The option will be converted to 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • noReplyLogLevel

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder noReplyLogLevel​(String 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 will be converted to 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • serverClosedChannelExceptionCaughtLogLevel

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder serverClosedChannelExceptionCaughtLogLevel​(String 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 will be converted to 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • serverExceptionCaughtLogLevel

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder serverExceptionCaughtLogLevel​(String serverExceptionCaughtLogLevel)
        If the server (NettyConsumer) catches an exception then its logged using this logging level. The option will be converted to 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder serverInitializerFactory​(Object 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

      • serverInitializerFactory

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder serverInitializerFactory​(String serverInitializerFactory)
        To use a custom ServerInitializerFactory. The option will be converted to 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 NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • usingExecutorService

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder usingExecutorService​(String usingExecutorService)
        Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        usingExecutorService - the value to set
        Returns:
        the dsl builder

      • allowSerializedHeaders

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • allowSerializedHeaders

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        allowSerializedHeaders - the value to set
        Returns:
        the dsl builder

      • nativeTransport

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • nativeTransport

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        nativeTransport - the value to set
        Returns:
        the dsl builder

      • options

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • options

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • receiveBufferSize

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • receiveBufferSize

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        receiveBufferSize - the value to set
        Returns:
        the dsl builder

      • receiveBufferSizePredictor

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • receiveBufferSizePredictor

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        receiveBufferSizePredictor - the value to set
        Returns:
        the dsl builder

      • sendBufferSize

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • sendBufferSize

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        sendBufferSize - the value to set
        Returns:
        the dsl builder

      • synchronous

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder synchronous​(boolean synchronous)
        Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        synchronous - the value to set
        Returns:
        the dsl builder

      • transferExchange

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • transferExchange

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        transferExchange - the value to set
        Returns:
        the dsl builder

      • udpByteArrayCodec

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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

      • udpByteArrayCodec

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        udpByteArrayCodec - the value to set
        Returns:
        the dsl builder

      • workerCount

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        workerCount - the value to set
        Returns:
        the dsl builder

      • workerCount

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        workerCount - the value to set
        Returns:
        the dsl builder

      • workerGroup

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder workerGroup​(Object 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

      • workerGroup

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder 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
        Parameters:
        workerGroup - the value to set
        Returns:
        the dsl builder