org.apache.camel.builder.endpoint.dsl

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 Summary

Modifier and Type	Method and Description
default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointProducerBuilder	advanced()
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.
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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	chunked(boolean chunked) If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	chunked(String chunked) If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	clearExpiredCookies(boolean clearExpiredCookies) Whether to clear expired cookies before sending the HTTP request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	clearExpiredCookies(String clearExpiredCookies) Whether to clear expired cookies before sending the HTTP request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	connectionClose(boolean connectionClose) Specifies whether a Connection Close header must be added to HTTP Request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	connectionClose(String connectionClose) Specifies whether a Connection Close header must be added to HTTP Request.
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.
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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	customHostHeader(String customHostHeader) To use custom host header for producer.
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.
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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	httpMethod(ResteasyEndpointBuilderFactory.HttpMethods httpMethod) Configure the HTTP method to use.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	httpMethod(String httpMethod) Configure the HTTP method to use.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	ignoreResponseBody(boolean ignoreResponseBody) If this option is true, The http producer won't read response body and cache the input stream.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	ignoreResponseBody(String ignoreResponseBody) If this option is true, The http producer won't read response body and cache the input stream.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	password(String password) Sets the password.
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.
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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	proxyClientClass(String proxyClientClass) Sets the resteasy proxyClientClass.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	resteasyMethod(String resteasyMethod) Sets the resteasy method to process the request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	servletName(String servletName) Sets the servlet name.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	throwExceptionOnFailure(boolean throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	throwExceptionOnFailure(String throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
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.
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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder	username(String username) Sets the username.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointProducerBuilder advanced()

chunked

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder chunked(boolean chunked)

If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

chunked - the value to set

Returns:

the dsl builder

chunked

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder chunked(String chunked)

If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

chunked - the value to set

Returns:

the dsl builder

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

Parameters:

disableStreamCache - the value to set

Returns:

the dsl builder

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

Parameters:

disableStreamCache - the value to set

Returns:

the dsl builder

resteasyMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder resteasyMethod(String resteasyMethod)

Sets the resteasy method to process the request. The option is a: <code>java.lang.String</code> type. Default: GET Group: common

Parameters:

resteasyMethod - the value to set

Returns:

the dsl builder

servletName

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder servletName(String servletName)

Sets the servlet name. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

servletName - the value to set

Returns:

the dsl builder

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

Parameters:

transferException - the value to set

Returns:

the dsl builder

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

Parameters:

transferException - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: producer

Parameters:

bridgeEndpoint - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: producer

Parameters:

bridgeEndpoint - the value to set

Returns:

the dsl builder

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. If the component has disabled cookie management then this option is disabled too. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

clearExpiredCookies - the value to set

Returns:

the dsl builder

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. If the component has disabled cookie management then this option is disabled too. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

clearExpiredCookies - the value to set

Returns:

the dsl builder

connectionClose

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder connectionClose(boolean connectionClose)

Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

connectionClose - the value to set

Returns:

the dsl builder

connectionClose

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder connectionClose(String connectionClose)

Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

connectionClose - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: true Group: producer

Parameters:

copyHeaders - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: true Group: producer

Parameters:

copyHeaders - the value to set

Returns:

the dsl builder

customHostHeader

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder customHostHeader(String customHostHeader)

To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url. The option is a: <code>java.lang.String</code> type. Group: producer

Parameters:

customHostHeader - the value to set

Returns:

the dsl builder

httpMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder httpMethod(ResteasyEndpointBuilderFactory.HttpMethods httpMethod)

Configure the HTTP method to use. The HttpMethod header cannot override this option if set. The option is a: <code>org.apache.camel.http.common.HttpMethods</code> type. Group: producer

Parameters:

httpMethod - the value to set

Returns:

the dsl builder

httpMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder httpMethod(String httpMethod)

Configure the HTTP method to use. The HttpMethod header cannot override this option if set. The option will be converted to a <code>org.apache.camel.http.common.HttpMethods</code> type. Group: producer

Parameters:

httpMethod - the value to set

Returns:

the dsl builder

ignoreResponseBody

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder ignoreResponseBody(boolean ignoreResponseBody)

If this option is true, The http producer won't read response body and cache the input stream. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

ignoreResponseBody - the value to set

Returns:

the dsl builder

ignoreResponseBody

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder ignoreResponseBody(String ignoreResponseBody)

If this option is true, The http producer won't read response body and cache the input stream. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

ignoreResponseBody - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: false Group: producer

Parameters:

preserveHostHeader - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: false Group: producer

Parameters:

preserveHostHeader - the value to set

Returns:

the dsl builder

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: <code>boolean</code> type. Default: true Group: producer

Parameters:

throwExceptionOnFailure - the value to set

Returns:

the dsl builder

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 <code>boolean</code> type. Default: true Group: producer

Parameters:

throwExceptionOnFailure - the value to set

Returns:

the dsl builder

proxyClientClass

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder proxyClientClass(String proxyClientClass)

Sets the resteasy proxyClientClass. The option is a: <code>java.lang.String</code> type. Group: proxy

Parameters:

proxyClientClass - the value to set

Returns:

the dsl builder

password

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder password(String password)

Sets the password. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

password - the value to set

Returns:

the dsl builder

username

default ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder username(String username)

Sets the username. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

username - the value to set

Returns:

the dsl builder