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

Interface NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointBuilder
Enclosing interface:
NettyHttpEndpointBuilderFactory
public static interface NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Netty HTTP component.

  • Method Details

    • basic

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointConsumerBuilder basic()

    • backlog

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • bossGroup

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • bridgeErrorHandler

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • chunkedMaxContentLength

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder chunkedMaxContentLength(int chunkedMaxContentLength)
      Value in bytes the max content length per chunked frame received on the Netty HTTP server. The option is a: <code>int</code> type. Default: 1048576 Group: consumer (advanced)
      Parameters:
      chunkedMaxContentLength - the value to set
      Returns:
      the dsl builder

    • chunkedMaxContentLength

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder chunkedMaxContentLength(String chunkedMaxContentLength)
      Value in bytes the max content length per chunked frame received on the Netty HTTP server. The option will be converted to a <code>int</code> type. Default: 1048576 Group: consumer (advanced)
      Parameters:
      chunkedMaxContentLength - the value to set
      Returns:
      the dsl builder

    • compression

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder compression(boolean compression)
      Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      compression - the value to set
      Returns:
      the dsl builder

    • compression

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder compression(String compression)
      Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      compression - the value to set
      Returns:
      the dsl builder

    • disconnectOnNoReply

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • httpMethodRestrict

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder httpMethodRestrict(String httpMethodRestrict)
      To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)
      Parameters:
      httpMethodRestrict - the value to set
      Returns:
      the dsl builder

    • logWarnOnBadRequest

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder logWarnOnBadRequest(boolean logWarnOnBadRequest)
      Whether Netty HTTP server should log a WARN if decoding the HTTP request failed and a HTTP Status 400 (bad request) is returned. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      logWarnOnBadRequest - the value to set
      Returns:
      the dsl builder

    • logWarnOnBadRequest

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder logWarnOnBadRequest(String logWarnOnBadRequest)
      Whether Netty HTTP server should log a WARN if decoding the HTTP request failed and a HTTP Status 400 (bad request) is returned. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      logWarnOnBadRequest - the value to set
      Returns:
      the dsl builder

    • mapHeaders

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder mapHeaders(boolean mapHeaders)
      If this option is enabled, then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance. The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHeaders - the value to set
      Returns:
      the dsl builder

    • mapHeaders

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder mapHeaders(String mapHeaders)
      If this option is enabled, then during binding from Netty to Camel Message then the headers will be mapped as well (eg added as header to the Camel Message as well). You can turn off this option to disable this. The headers can still be accessed from the org.apache.camel.component.netty.http.NettyHttpMessage message with the method getHttpRequest() that returns the Netty HTTP request io.netty.handler.codec.http.HttpRequest instance. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
      Parameters:
      mapHeaders - the value to set
      Returns:
      the dsl builder

    • maxChunkSize

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxChunkSize(int maxChunkSize)
      The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple io.netty.handler.codec.http.HttpContents whose length is maxChunkSize at maximum. See io.netty.handler.codec.http.HttpObjectDecoder. The option is a: <code>int</code> type. Default: 8192 Group: consumer (advanced)
      Parameters:
      maxChunkSize - the value to set
      Returns:
      the dsl builder

    • maxChunkSize

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxChunkSize(String maxChunkSize)
      The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk will be split into multiple io.netty.handler.codec.http.HttpContents whose length is maxChunkSize at maximum. See io.netty.handler.codec.http.HttpObjectDecoder. The option will be converted to a <code>int</code> type. Default: 8192 Group: consumer (advanced)
      Parameters:
      maxChunkSize - the value to set
      Returns:
      the dsl builder

    • maxHeaderSize

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxHeaderSize(int maxHeaderSize)
      The maximum length of all headers. If the sum of the length of each header exceeds this value, a io.netty.handler.codec.TooLongFrameException will be raised. The option is a: <code>int</code> type. Default: 8192 Group: consumer (advanced)
      Parameters:
      maxHeaderSize - the value to set
      Returns:
      the dsl builder

    • maxHeaderSize

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxHeaderSize(String maxHeaderSize)
      The maximum length of all headers. If the sum of the length of each header exceeds this value, a io.netty.handler.codec.TooLongFrameException will be raised. The option will be converted to a <code>int</code> type. Default: 8192 Group: consumer (advanced)
      Parameters:
      maxHeaderSize - the value to set
      Returns:
      the dsl builder

    • maxInitialLineLength

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxInitialLineLength(int maxInitialLineLength)
      The maximum length of the initial line (e.g. {code GET / HTTP/1.0} or {code HTTP/1.0 200 OK}) If the length of the initial line exceeds this value, a TooLongFrameException will be raised. See io.netty.handler.codec.http.HttpObjectDecoder. The option is a: <code>int</code> type. Default: 4096 Group: consumer (advanced)
      Parameters:
      maxInitialLineLength - the value to set
      Returns:
      the dsl builder

    • maxInitialLineLength

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder maxInitialLineLength(String maxInitialLineLength)
      The maximum length of the initial line (e.g. {code GET / HTTP/1.0} or {code HTTP/1.0 200 OK}) If the length of the initial line exceeds this value, a TooLongFrameException will be raised. See io.netty.handler.codec.http.HttpObjectDecoder. The option will be converted to a <code>int</code> type. Default: 4096 Group: consumer (advanced)
      Parameters:
      maxInitialLineLength - the value to set
      Returns:
      the dsl builder

    • nettyServerBootstrapFactory

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • nettyServerBootstrapFactory

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • nettySharedHttpServer

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder nettySharedHttpServer(org.apache.camel.component.netty.http.NettySharedHttpServer nettySharedHttpServer)
      To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. The option is a: <code>org.apache.camel.component.netty.http.NettySharedHttpServer</code> type. Group: consumer (advanced)
      Parameters:
      nettySharedHttpServer - the value to set
      Returns:
      the dsl builder

    • nettySharedHttpServer

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder nettySharedHttpServer(String nettySharedHttpServer)
      To use a shared Netty HTTP server. See Netty HTTP Server Example for more details. The option will be converted to a <code>org.apache.camel.component.netty.http.NettySharedHttpServer</code> type. Group: consumer (advanced)
      Parameters:
      nettySharedHttpServer - the value to set
      Returns:
      the dsl builder

    • noReplyLogLevel

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • serverInitializerFactory

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • traceEnabled

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder traceEnabled(boolean traceEnabled)
      Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      traceEnabled - the value to set
      Returns:
      the dsl builder

    • traceEnabled

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder traceEnabled(String traceEnabled)
      Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      traceEnabled - the value to set
      Returns:
      the dsl builder

    • urlDecodeHeaders

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder urlDecodeHeaders(boolean urlDecodeHeaders)
      If this option is enabled, then during binding from Netty to Camel Message then the header values will be URL decoded (eg %20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      urlDecodeHeaders - the value to set
      Returns:
      the dsl builder

    • urlDecodeHeaders

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder urlDecodeHeaders(String urlDecodeHeaders)
      If this option is enabled, then during binding from Netty to Camel Message then the header values will be URL decoded (eg %20 will be a space character. Notice this option is used by the default org.apache.camel.component.netty.http.NettyHttpBinding and therefore if you implement a custom org.apache.camel.component.netty.http.NettyHttpBinding then you would need to decode the headers accordingly to this option. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      urlDecodeHeaders - the value to set
      Returns:
      the dsl builder

    • usingExecutorService

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • channelGroup

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • channelGroup

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder channelGroup(String channelGroup)
      To use a explicit ChannelGroup. The option will be converted to a <code>io.netty.channel.group.ChannelGroup</code> type. Group: advanced
      Parameters:
      channelGroup - the value to set
      Returns:
      the dsl builder

    • configuration

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder configuration(org.apache.camel.component.netty.http.NettyHttpConfiguration configuration)
      To use a custom configured NettyHttpConfiguration for configuring this endpoint. The option is a: <code>org.apache.camel.component.netty.http.NettyHttpConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • configuration

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder configuration(String configuration)
      To use a custom configured NettyHttpConfiguration for configuring this endpoint. The option will be converted to a <code>org.apache.camel.component.netty.http.NettyHttpConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • disableStreamCache

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder disableStreamCache(boolean disableStreamCache)
      Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing, which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream, because Netty has closed it. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • disableStreamCache

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder disableStreamCache(String disableStreamCache)
      Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing, which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream, because Netty has closed it. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      disableStreamCache - the value to set
      Returns:
      the dsl builder

    • headerFilterStrategy

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • headerFilterStrategy

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)
      To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • nativeTransport

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • nettyHttpBinding

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • nettyHttpBinding

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder nettyHttpBinding(String nettyHttpBinding)
      To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. The option will be converted to 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • synchronous

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder synchronous(String synchronous)
      Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder

    • transferException

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder transferException(boolean transferException)
      If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • transferException

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder transferException(String transferException)
      If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • transferExchange

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • unixDomainSocketPath

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder unixDomainSocketPath(String unixDomainSocketPath)
      Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false. The option is a: <code>java.lang.String</code> type. Group: advanced
      Parameters:
      unixDomainSocketPath - the value to set
      Returns:
      the dsl builder

    • workerCount

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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 NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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

    • workerGroup

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointConsumerBuilder 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