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

Interface NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
NettyHttpEndpointBuilderFactory.NettyHttpEndpointBuilder
Enclosing interface:
NettyHttpEndpointBuilderFactory
public static interface NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Netty HTTP component.

  • Method Details

    • advanced

      default NettyHttpEndpointBuilderFactory.AdvancedNettyHttpEndpointProducerBuilder advanced()

    • bridgeEndpoint

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder bridgeEndpoint(boolean bridgeEndpoint)
      If the option is true, the producer will ignore the NettyHttpConstants.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). The option is a: boolean type. Default: false Group: common
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder

    • bridgeEndpoint

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder bridgeEndpoint(String bridgeEndpoint)
      If the option is true, the producer will ignore the NettyHttpConstants.HTTP_URI header, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      bridgeEndpoint - the value to set
      Returns:
      the dsl builder

    • disconnect

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      disconnect - the value to set
      Returns:
      the dsl builder

    • disconnect

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder disconnect(String disconnect)
      Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. The option will be converted to a boolean type. Default: false Group: common
      Parameters:
      disconnect - the value to set
      Returns:
      the dsl builder

    • keepAlive

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder keepAlive(boolean keepAlive)
      Setting to ensure socket is not closed due to inactivity. The option is a: boolean type. Default: true Group: common
      Parameters:
      keepAlive - the value to set
      Returns:
      the dsl builder

    • keepAlive

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder keepAlive(String keepAlive)
      Setting to ensure socket is not closed due to inactivity. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      keepAlive - the value to set
      Returns:
      the dsl builder

    • reuseAddress

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder reuseAddress(boolean reuseAddress)
      Setting to facilitate socket multiplexing. The option is a: boolean type. Default: true Group: common
      Parameters:
      reuseAddress - the value to set
      Returns:
      the dsl builder

    • reuseAddress

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder reuseAddress(String reuseAddress)
      Setting to facilitate socket multiplexing. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      reuseAddress - the value to set
      Returns:
      the dsl builder

    • reuseChannel

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      reuseChannel - the value to set
      Returns:
      the dsl builder

    • reuseChannel

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder reuseChannel(String 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 will be converted to a boolean type. Default: false Group: common
      Parameters:
      reuseChannel - the value to set
      Returns:
      the dsl builder

    • sync

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sync(boolean sync)
      Setting to set endpoint as one-way or request-response. The option is a: boolean type. Default: true Group: common
      Parameters:
      sync - the value to set
      Returns:
      the dsl builder

    • sync

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sync(String sync)
      Setting to set endpoint as one-way or request-response. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      sync - the value to set
      Returns:
      the dsl builder

    • tcpNoDelay

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder tcpNoDelay(boolean tcpNoDelay)
      Setting to improve TCP protocol performance. The option is a: boolean type. Default: true Group: common
      Parameters:
      tcpNoDelay - the value to set
      Returns:
      the dsl builder

    • tcpNoDelay

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder tcpNoDelay(String tcpNoDelay)
      Setting to improve TCP protocol performance. The option will be converted to a boolean type. Default: true Group: common
      Parameters:
      tcpNoDelay - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder connectTimeout(int connectTimeout)
      Time to wait for a socket connection to be available. Value is in milliseconds. The option is a: int type. Default: 10000 Group: producer
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • connectTimeout

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder connectTimeout(String connectTimeout)
      Time to wait for a socket connection to be available. Value is in milliseconds. The option will be converted to a int type. Default: 10000 Group: producer
      Parameters:
      connectTimeout - the value to set
      Returns:
      the dsl builder

    • cookieHandler

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder cookieHandler(org.apache.camel.http.base.cookie.CookieHandler cookieHandler)
      Configure a cookie handler to maintain a HTTP session. The option is a: org.apache.camel.http.base.cookie.CookieHandler type. Group: producer
      Parameters:
      cookieHandler - the value to set
      Returns:
      the dsl builder

    • cookieHandler

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder cookieHandler(String cookieHandler)
      Configure a cookie handler to maintain a HTTP session. The option will be converted to a org.apache.camel.http.base.cookie.CookieHandler type. Group: producer
      Parameters:
      cookieHandler - the value to set
      Returns:
      the dsl builder

    • requestTimeout

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      requestTimeout - the value to set
      Returns:
      the dsl builder

    • requestTimeout

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder requestTimeout(String 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 will be converted to a long type. Group: producer
      Parameters:
      requestTimeout - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder throwExceptionOnFailure(boolean throwExceptionOnFailure)
      Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option is a: boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • throwExceptionOnFailure

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder throwExceptionOnFailure(String throwExceptionOnFailure)
      Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. The option will be converted to a boolean type. Default: true Group: producer
      Parameters:
      throwExceptionOnFailure - the value to set
      Returns:
      the dsl builder

    • decoders

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder decoders(String 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.lang.String type. Group: codec
      Parameters:
      decoders - the value to set
      Returns:
      the dsl builder

    • encoders

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder encoders(String 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.lang.String type. Group: codec
      Parameters:
      encoders - the value to set
      Returns:
      the dsl builder

    • enabledProtocols

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder enabledProtocols(String enabledProtocols)
      Which protocols to enable when using SSL. The option is a: java.lang.String type. Default: TLSv1.2,TLSv1.3 Group: security
      Parameters:
      enabledProtocols - the value to set
      Returns:
      the dsl builder

    • hostnameVerification

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder hostnameVerification(boolean hostnameVerification)
      To enable/disable hostname verification on SSLEngine. The option is a: boolean type. Default: false Group: security
      Parameters:
      hostnameVerification - the value to set
      Returns:
      the dsl builder

    • hostnameVerification

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder hostnameVerification(String hostnameVerification)
      To enable/disable hostname verification on SSLEngine. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      hostnameVerification - the value to set
      Returns:
      the dsl builder

    • keyStoreFile

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder keyStoreFile(File keyStoreFile)
      Client side certificate keystore to be used for encryption. The option is a: java.io.File type. Group: security
      Parameters:
      keyStoreFile - the value to set
      Returns:
      the dsl builder

    • keyStoreFile

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder keyStoreFile(String keyStoreFile)
      Client side certificate keystore to be used for encryption. The option will be converted to a java.io.File type. Group: security
      Parameters:
      keyStoreFile - the value to set
      Returns:
      the dsl builder

    • keyStoreFormat

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder keyStoreFormat(String keyStoreFormat)
      Keystore format to be used for payload encryption. Defaults to JKS if not set. The option is a: java.lang.String type. Group: security
      Parameters:
      keyStoreFormat - the value to set
      Returns:
      the dsl builder

    • keyStoreResource

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      keyStoreResource - the value to set
      Returns:
      the dsl builder

    • passphrase

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder passphrase(String passphrase)
      Password setting to use in order to encrypt/decrypt payloads sent using SSH. The option is a: java.lang.String type. Group: security
      Parameters:
      passphrase - the value to set
      Returns:
      the dsl builder

    • securityProvider

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder securityProvider(String securityProvider)
      Security provider to be used for payload encryption. Defaults to SunX509 if not set. The option is a: java.lang.String type. Group: security
      Parameters:
      securityProvider - the value to set
      Returns:
      the dsl builder

    • ssl

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder ssl(boolean ssl)
      Setting to specify whether SSL encryption is applied to this endpoint. The option is a: boolean type. Default: false Group: security
      Parameters:
      ssl - the value to set
      Returns:
      the dsl builder

    • ssl

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder ssl(String ssl)
      Setting to specify whether SSL encryption is applied to this endpoint. The option will be converted to a boolean type. Default: false Group: security
      Parameters:
      ssl - the value to set
      Returns:
      the dsl builder

    • sslClientCertHeaders

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      sslClientCertHeaders - the value to set
      Returns:
      the dsl builder

    • sslClientCertHeaders

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sslClientCertHeaders(String 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 will be converted to a boolean type. Default: false Group: security
      Parameters:
      sslClientCertHeaders - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sslContextParameters(String sslContextParameters)
      To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslHandler

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sslHandler(io.netty.handler.ssl.SslHandler sslHandler)
      Reference to a class that could be used to return an SSL Handler. The option is a: io.netty.handler.ssl.SslHandler type. Group: security
      Parameters:
      sslHandler - the value to set
      Returns:
      the dsl builder

    • sslHandler

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder sslHandler(String sslHandler)
      Reference to a class that could be used to return an SSL Handler. The option will be converted to a io.netty.handler.ssl.SslHandler type. Group: security
      Parameters:
      sslHandler - the value to set
      Returns:
      the dsl builder

    • trustStoreFile

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder trustStoreFile(File trustStoreFile)
      Server side certificate keystore to be used for encryption. The option is a: java.io.File type. Group: security
      Parameters:
      trustStoreFile - the value to set
      Returns:
      the dsl builder

    • trustStoreFile

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder trustStoreFile(String trustStoreFile)
      Server side certificate keystore to be used for encryption. The option will be converted to a java.io.File type. Group: security
      Parameters:
      trustStoreFile - the value to set
      Returns:
      the dsl builder

    • trustStoreResource

      default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: java.lang.String type. Group: security
      Parameters:
      trustStoreResource - the value to set
      Returns:
      the dsl builder