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

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

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

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

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

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

      • 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: int type. Default: 10000 Group: consumer

      • 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: boolean type. Default: true Group: codec

      • 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 boolean type. Default: true Group: codec

      • 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: boolean type. Default: true Group: codec

      • decoders

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder decoders​(List<Object> 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.util.List<io.netty.channel.ChannelHandler> type. Group: codec

      • 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 will be converted to a java.util.List<io.netty.channel.ChannelHandler> type. Group: codec

      • encoders

        default NettyEndpointBuilderFactory.NettyEndpointConsumerBuilder encoders​(List<Object> 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.util.List<io.netty.channel.ChannelHandler> type. Group: codec

      • 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 will be converted to a java.util.List<io.netty.channel.ChannelHandler> type. Group: codec

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

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

      • 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: java.lang.String type. Group: security

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

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

      • 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: java.lang.String type. Group: security