Interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder
    Enclosing interface:
    ResteasyEndpointBuilderFactory

    public static interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder
    extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the Resteasy component.
    • Method Detail

      • disableStreamCache

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder disableStreamCache​(boolean disableStreamCache)
        Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option is a: boolean type. Default: false Group: common
      • disableStreamCache

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder disableStreamCache​(String disableStreamCache)
        Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The http producer will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is as the message body. The option will be converted to a boolean type. Default: false Group: common
      • transferException

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder transferException​(boolean transferException)
        If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option is a: boolean type. Default: false Group: common
      • transferException

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder transferException​(String transferException)
        If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. The option will be converted to a boolean type. Default: false Group: common
      • bridgeEndpoint

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder bridgeEndpoint​(boolean bridgeEndpoint)
        If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option is a: boolean type. Default: false Group: producer
      • bridgeEndpoint

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder bridgeEndpoint​(String bridgeEndpoint)
        If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. The option will be converted to a boolean type. Default: false Group: producer
      • clearExpiredCookies

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder clearExpiredCookies​(boolean clearExpiredCookies)
        Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. The option is a: boolean type. Default: true Group: producer
      • clearExpiredCookies

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder clearExpiredCookies​(String clearExpiredCookies)
        Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. The option will be converted to a boolean type. Default: true Group: producer
      • copyHeaders

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder copyHeaders​(boolean copyHeaders)
        If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). The option is a: boolean type. Default: true Group: producer
      • copyHeaders

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder copyHeaders​(String copyHeaders)
        If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). The option will be converted to a boolean type. Default: true Group: producer
      • lazyStartProducer

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder 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 ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder 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
      • preserveHostHeader

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder preserveHostHeader​(boolean preserveHostHeader)
        If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option is a: boolean type. Default: false Group: producer
      • preserveHostHeader

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder preserveHostHeader​(String preserveHostHeader)
        If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. The option will be converted to a boolean type. Default: false Group: producer
      • throwExceptionOnFailure

        default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder 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 ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder 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