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 Detail

      • bridgeEndpoint

        default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder bridgeEndpoint​(boolean bridgeEndpoint)
        If the option is true, the producer will ignore the Exchange.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
      • bridgeEndpoint

        default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder bridgeEndpoint​(String bridgeEndpoint)
        If the option is true, the producer will ignore the Exchange.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
      • 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
      • 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
      • lazyStartProducer

        default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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 NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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 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
      • 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
      • 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
      • 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
      • decoders

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

        default NettyHttpEndpointBuilderFactory.NettyHttpEndpointProducerBuilder 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 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 will be converted to a java.util.List<io.netty.channel.ChannelHandler> type. Group: codec
      • 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
      • 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
      • 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
      • 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. The option is a: java.lang.String type. Group: security