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

Interface NettyEndpointBuilderFactory.NettyEndpointProducerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
All Known Subinterfaces:
NettyEndpointBuilderFactory.NettyEndpointBuilder
Enclosing interface:
NettyEndpointBuilderFactory
public static interface NettyEndpointBuilderFactory.NettyEndpointProducerBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Netty component.

  • Method Details

    • advanced

      default NettyEndpointBuilderFactory.AdvancedNettyEndpointProducerBuilder advanced()

    • disconnect

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: common
      Parameters:
      disconnect - the value to set
      Returns:
      the dsl builder

    • disconnect

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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 <code>boolean</code> type. Default: false Group: common
      Parameters:
      disconnect - the value to set
      Returns:
      the dsl builder

    • keepAlive

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

    • keepAlive

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

    • reuseAddress

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder reuseAddress(boolean reuseAddress)
      Setting to facilitate socket multiplexing. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      reuseAddress - the value to set
      Returns:
      the dsl builder

    • reuseAddress

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

    • reuseChannel

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: common
      Parameters:
      reuseChannel - the value to set
      Returns:
      the dsl builder

    • reuseChannel

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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 <code>boolean</code> type. Default: false Group: common
      Parameters:
      reuseChannel - the value to set
      Returns:
      the dsl builder

    • sync

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

    • sync

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

    • tcpNoDelay

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder tcpNoDelay(boolean tcpNoDelay)
      Setting to improve TCP protocol performance. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      tcpNoDelay - the value to set
      Returns:
      the dsl builder

    • tcpNoDelay

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

    • connectTimeout

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

    • connectTimeout

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

    • requestTimeout

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>long</code> type. Group: producer
      Parameters:
      requestTimeout - the value to set
      Returns:
      the dsl builder

    • requestTimeout

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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 <code>long</code> type. Group: producer
      Parameters:
      requestTimeout - the value to set
      Returns:
      the dsl builder

    • hostnameVerification

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

    • hostnameVerification

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

    • allowDefaultCodec

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder allowDefaultCodec(boolean allowDefaultCodec)
      The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. The option is a: <code>boolean</code> type. Default: true Group: codec
      Parameters:
      allowDefaultCodec - the value to set
      Returns:
      the dsl builder

    • allowDefaultCodec

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder allowDefaultCodec(String allowDefaultCodec)
      The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. The option will be converted to a <code>boolean</code> type. Default: true Group: codec
      Parameters:
      allowDefaultCodec - the value to set
      Returns:
      the dsl builder

    • autoAppendDelimiter

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder autoAppendDelimiter(boolean autoAppendDelimiter)
      Whether or not to auto append missing end delimiter when sending using the textline codec. The option is a: <code>boolean</code> type. Default: true Group: codec
      Parameters:
      autoAppendDelimiter - the value to set
      Returns:
      the dsl builder

    • autoAppendDelimiter

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder autoAppendDelimiter(String autoAppendDelimiter)
      Whether or not to auto append missing end delimiter when sending using the textline codec. The option will be converted to a <code>boolean</code> type. Default: true Group: codec
      Parameters:
      autoAppendDelimiter - the value to set
      Returns:
      the dsl builder

    • decoderMaxLineLength

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder decoderMaxLineLength(int decoderMaxLineLength)
      The max line length to use for the textline codec. The option is a: <code>int</code> type. Default: 1024 Group: codec
      Parameters:
      decoderMaxLineLength - the value to set
      Returns:
      the dsl builder

    • decoderMaxLineLength

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder decoderMaxLineLength(String decoderMaxLineLength)
      The max line length to use for the textline codec. The option will be converted to a <code>int</code> type. Default: 1024 Group: codec
      Parameters:
      decoderMaxLineLength - the value to set
      Returns:
      the dsl builder

    • decoders

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: codec
      Parameters:
      decoders - the value to set
      Returns:
      the dsl builder

    • delimiter

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder delimiter(org.apache.camel.component.netty.TextLineDelimiter delimiter)
      The delimiter to use for the textline codec. Possible values are LINE and NULL. The option is a: <code>org.apache.camel.component.netty.TextLineDelimiter</code> type. Default: LINE Group: codec
      Parameters:
      delimiter - the value to set
      Returns:
      the dsl builder

    • delimiter

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder delimiter(String delimiter)
      The delimiter to use for the textline codec. Possible values are LINE and NULL. The option will be converted to a <code>org.apache.camel.component.netty.TextLineDelimiter</code> type. Default: LINE Group: codec
      Parameters:
      delimiter - the value to set
      Returns:
      the dsl builder

    • encoders

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: codec
      Parameters:
      encoders - the value to set
      Returns:
      the dsl builder

    • encoding

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder encoding(String encoding)
      The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset. The option is a: <code>java.lang.String</code> type. Group: codec
      Parameters:
      encoding - the value to set
      Returns:
      the dsl builder

    • textline

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder textline(boolean textline)
      Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default. The option is a: <code>boolean</code> type. Default: false Group: codec
      Parameters:
      textline - the value to set
      Returns:
      the dsl builder

    • textline

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder textline(String textline)
      Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default. The option will be converted to a <code>boolean</code> type. Default: false Group: codec
      Parameters:
      textline - the value to set
      Returns:
      the dsl builder

    • enabledProtocols

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

    • keyStoreFile

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

    • keyStoreFile

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

    • keyStoreFormat

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

    • keyStoreResource

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: security
      Parameters:
      keyStoreResource - the value to set
      Returns:
      the dsl builder

    • passphrase

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

    • securityProvider

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

    • ssl

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

    • ssl

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

    • sslClientCertHeaders

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>boolean</code> type. Default: false Group: security
      Parameters:
      sslClientCertHeaders - the value to set
      Returns:
      the dsl builder

    • sslClientCertHeaders

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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 <code>boolean</code> type. Default: false Group: security
      Parameters:
      sslClientCertHeaders - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters)
      To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
      Parameters:
      sslContextParameters - the value to set
      Returns:
      the dsl builder

    • sslContextParameters

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

    • sslHandler

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

    • sslHandler

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

    • trustStoreFile

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

    • trustStoreFile

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

    • trustStoreResource

      default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder 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: <code>java.lang.String</code> type. Group: security
      Parameters:
      trustStoreResource - the value to set
      Returns:
      the dsl builder