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: int type. Group: consumer (advanced)

      • 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 int type. Group: consumer (advanced)

      • 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: int type. Default: 1 Group: consumer (advanced)

      • 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 int type. Default: 1 Group: consumer (advanced)

      • 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: boolean type. Default: true Group: consumer (advanced)

      • 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 boolean type. Default: true Group: consumer (advanced)

      • 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)

      • 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)

      • 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: org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)

      • 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 org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)

      • 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: org.apache.camel.LoggingLevel type. Default: DEBUG Group: consumer (advanced)

      • 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 org.apache.camel.LoggingLevel type. Default: DEBUG Group: consumer (advanced)

      • 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: org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)

      • 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 org.apache.camel.LoggingLevel type. Default: WARN Group: consumer (advanced)

      • 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: boolean type. Default: true Group: consumer (advanced)

      • 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: boolean type. Default: false Group: advanced

      • 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 boolean type. Default: false Group: advanced

      • basicPropertyBinding

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder basicPropertyBinding​(boolean basicPropertyBinding)
        Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced

      • basicPropertyBinding

        default NettyEndpointBuilderFactory.AdvancedNettyEndpointConsumerBuilder basicPropertyBinding​(String basicPropertyBinding)
        Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option will be converted to a boolean type. Default: false Group: advanced

      • 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: boolean type. Default: false Group: advanced

      • 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 boolean type. Default: false Group: advanced

      • 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: java.util.Map<java.lang.String, java.lang.Object> 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

      • 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: java.util.Map<java.lang.String, java.lang.Object> 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

      • 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: boolean type. Default: false Group: advanced

      • 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 boolean type. Default: false Group: advanced

      • 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: int type. Group: advanced

      • 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 int type. Group: advanced

      • 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: io.netty.channel.EventLoopGroup type. Group: advanced

      • 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 io.netty.channel.EventLoopGroup type. Group: advanced