org.apache.camel.builder.endpoint.dsl

Interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder

Enclosing interface:

ResteasyEndpointBuilderFactory

public static interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Resteasy component.

Method Summary

Modifier and Type	Method and Description
default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointConsumerBuilder	advanced()
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	async(boolean async) Configure the consumer to work in async mode.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	async(String async) Configure the consumer to work in async mode.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	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.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	httpMethodRestrict(String httpMethodRestrict) Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	matchOnUriPrefix(boolean matchOnUriPrefix) Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	matchOnUriPrefix(String matchOnUriPrefix) Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	muteException(boolean muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	muteException(String muteException) If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	password(String password) Sets the password.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	proxyClientClass(String proxyClientClass) Sets the resteasy proxyClientClass.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	responseBufferSize(Integer responseBufferSize) To use a custom buffer size on the javax.servlet.ServletResponse.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	responseBufferSize(String responseBufferSize) To use a custom buffer size on the javax.servlet.ServletResponse.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	resteasyMethod(String resteasyMethod) Sets the resteasy method to process the request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	servletName(String servletName) Sets the servlet name.
default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	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.ResteasyEndpointConsumerBuilder	username(String username) Sets the username.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointConsumerBuilder advanced()

chunked

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder 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: boolean type. Default: true Group: common

chunked

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder 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 boolean type. Default: true Group: common

disableStreamCache

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

resteasyMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder resteasyMethod(String resteasyMethod)

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

servletName

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder servletName(String servletName)

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

transferException

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

async

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder async(boolean async)

Configure the consumer to work in async mode. The option is a: boolean type. Default: false Group: consumer

async

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder async(String async)

Configure the consumer to work in async mode. The option will be converted to a boolean type. Default: false Group: consumer

bridgeErrorHandler

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

httpMethodRestrict

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder httpMethodRestrict(String httpMethodRestrict)

Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. The option is a: java.lang.String type. Group: consumer

matchOnUriPrefix

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder matchOnUriPrefix(boolean matchOnUriPrefix)

Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. The option is a: boolean type. Default: false Group: consumer

matchOnUriPrefix

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder matchOnUriPrefix(String matchOnUriPrefix)

Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. The option will be converted to a boolean type. Default: false Group: consumer

muteException

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder muteException(boolean muteException)

If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option is a: boolean type. Default: false Group: consumer

muteException

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder muteException(String muteException)

If enabled and an Exchange failed processing on the consumer side the response's body won't contain the exception's stack trace. The option will be converted to a boolean type. Default: false Group: consumer

responseBufferSize

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder responseBufferSize(Integer responseBufferSize)

To use a custom buffer size on the javax.servlet.ServletResponse. The option is a: java.lang.Integer type. Group: consumer

responseBufferSize

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder responseBufferSize(String responseBufferSize)

To use a custom buffer size on the javax.servlet.ServletResponse. The option will be converted to a java.lang.Integer type. Group: consumer

proxyClientClass

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder proxyClientClass(String proxyClientClass)

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

password

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder password(String password)

Sets the password. The option is a: java.lang.String type. Group: security

username

default ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder username(String username)

Sets the username. The option is a: java.lang.String type. Group: security