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

Interface NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder

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

    • Method Detail

      • disconnect

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

      • tcpNoDelay

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

      • bridgeErrorHandler

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

      • bridgeErrorHandler

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

      • broadcast

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder broadcast​(boolean broadcast)
        Setting to choose Multicast over UDP. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        broadcast - the value to set
        Returns:
        the dsl builder

      • clientMode

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder clientMode​(boolean clientMode)
        If the clientMode is true, netty consumer will connect the address as a TCP client. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        clientMode - the value to set
        Returns:
        the dsl builder

      • clientMode

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder clientMode​(String clientMode)
        If the clientMode is true, netty consumer will connect the address as a TCP client. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        clientMode - the value to set
        Returns:
        the dsl builder

      • reconnect

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder reconnect​(boolean reconnect)
        Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled. The option is a: <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        reconnect - the value to set
        Returns:
        the dsl builder

      • reconnect

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder reconnect​(String reconnect)
        Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        reconnect - the value to set
        Returns:
        the dsl builder

      • reconnectInterval

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder reconnectInterval​(int reconnectInterval)
        Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection. The option is a: <code>int</code> type. Default: 10000 Group: consumer
        Parameters:
        reconnectInterval - the value to set
        Returns:
        the dsl builder

      • reconnectInterval

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder reconnectInterval​(String reconnectInterval)
        Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection. The option will be converted to a <code>int</code> type. Default: 10000 Group: consumer
        Parameters:
        reconnectInterval - the value to set
        Returns:
        the dsl builder

      • hostnameVerification

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

      • keyStoreFile

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

      • needClientAuth

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder needClientAuth​(boolean needClientAuth)
        Configures whether the server needs client authentication when using SSL. The option is a: <code>boolean</code> type. Default: false Group: security
        Parameters:
        needClientAuth - the value to set
        Returns:
        the dsl builder

      • needClientAuth

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder needClientAuth​(String needClientAuth)
        Configures whether the server needs client authentication when using SSL. The option will be converted to a <code>boolean</code> type. Default: false Group: security
        Parameters:
        needClientAuth - the value to set
        Returns:
        the dsl builder

      • passphrase

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