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 Detail

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

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

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

      • lazyStartProducer

        default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder lazyStartProducer​(boolean lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer

      • lazyStartProducer

        default NettyEndpointBuilderFactory.NettyEndpointProducerBuilder lazyStartProducer​(String lazyStartProducer)
        Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a boolean type. Default: false Group: producer

      • 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: long type. Group: producer

      • 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 long type. Group: producer

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

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

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

      • decoders

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

      • encoders

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

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

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

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

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

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

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