org.apache.camel.builder.endpoint.dsl

Interface ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder, ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

Enclosing interface:

ResteasyEndpointBuilderFactory

public static interface ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder
extends ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder, ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

Builder for endpoint for the Resteasy component.

Method Summary

Modifier and Type	Method and Description
default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointBuilder	advanced()
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	basicAuth(Boolean basicAuth) Sets the flag to basicAuth on endpoint.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	basicAuth(String basicAuth) Sets the flag to basicAuth on endpoint.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	password(String password) Sets the password.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	proxyClientClass(String proxyClientClass) Sets the resteasy proxyClientClass.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	proxyMethod(String proxyMethod) Sets the proxy method defined in an interface.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	restEasyHttpBindingRef(Object restEasyHttpBindingRef) Sets the restEasyHttpBinding if you have a customised one registered in the context.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	restEasyHttpBindingRef(String restEasyHttpBindingRef) Sets the restEasyHttpBinding if you have a customised one registered in the context.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	resteasyMethod(String resteasyMethod) Sets the resteasy method to process the request.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	servletName(String servletName) Sets the servlet name.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	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.ResteasyEndpointBuilder	username(String username) Sets the username.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	x509HostnameVerifier(Object x509HostnameVerifier) To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier.
default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder	x509HostnameVerifier(String x509HostnameVerifier) To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

async, async, bridgeErrorHandler, bridgeErrorHandler, httpMethodRestrict, matchOnUriPrefix, matchOnUriPrefix, muteException, muteException, responseBufferSize, responseBufferSize

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

authDomain, authenticationPreemptive, authenticationPreemptive, authHost, authMethod, authMethodPriority, authPassword, authUsername, bridgeEndpoint, bridgeEndpoint, clearExpiredCookies, clearExpiredCookies, connectionClose, connectionClose, copyHeaders, copyHeaders, customHostHeader, httpMethod, httpMethod, ignoreResponseBody, ignoreResponseBody, lazyStartProducer, lazyStartProducer, preserveHostHeader, preserveHostHeader, proxyAuthDomain, proxyAuthHost, proxyAuthMethod, proxyAuthPassword, proxyAuthPort, proxyAuthPort, proxyAuthScheme, proxyAuthUsername, proxyHost, proxyPort, proxyPort, throwExceptionOnFailure, throwExceptionOnFailure

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default ResteasyEndpointBuilderFactory.AdvancedResteasyEndpointBuilder advanced()

Specified by:

advanced in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

advanced in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

chunked

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

Specified by:

chunked in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

chunked in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

chunked

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

Specified by:

chunked in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

chunked in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

disableStreamCache

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

Specified by:

disableStreamCache in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

disableStreamCache in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

disableStreamCache

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

Specified by:

disableStreamCache in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

disableStreamCache in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

restEasyHttpBindingRef

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder restEasyHttpBindingRef(Object restEasyHttpBindingRef)

Sets the restEasyHttpBinding if you have a customised one registered in the context. The option is a: org.apache.camel.component.resteasy.ResteasyHttpBinding type. Group: common

Specified by:

restEasyHttpBindingRef in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

restEasyHttpBindingRef in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

restEasyHttpBindingRef

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder restEasyHttpBindingRef(String restEasyHttpBindingRef)

Sets the restEasyHttpBinding if you have a customised one registered in the context. The option will be converted to a org.apache.camel.component.resteasy.ResteasyHttpBinding type. Group: common

Specified by:

restEasyHttpBindingRef in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

restEasyHttpBindingRef in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

resteasyMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder resteasyMethod(String resteasyMethod)

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

Specified by:

resteasyMethod in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

resteasyMethod in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

servletName

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder servletName(String servletName)

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

Specified by:

servletName in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

servletName in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

transferException

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

Specified by:

transferException in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

transferException in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

transferException

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

Specified by:

transferException in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

transferException in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

proxyClientClass

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder proxyClientClass(String proxyClientClass)

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

Specified by:

proxyClientClass in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

proxyClientClass in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

proxyMethod

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder proxyMethod(String proxyMethod)

Sets the proxy method defined in an interface. The option is a: java.lang.String type. Group: proxy

Specified by:

proxyMethod in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

proxyMethod in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

basicAuth

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder basicAuth(Boolean basicAuth)

Sets the flag to basicAuth on endpoint. The option is a: java.lang.Boolean type. Group: security

Specified by:

basicAuth in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

basicAuth in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

basicAuth

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder basicAuth(String basicAuth)

Sets the flag to basicAuth on endpoint. The option will be converted to a java.lang.Boolean type. Group: security

Specified by:

basicAuth in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

basicAuth in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

password

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder password(String password)

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

Specified by:

password in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

password in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

sslContextParameters

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

sslContextParameters in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

sslContextParameters

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.util.jsse.SSLContextParameters is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security

Specified by:

sslContextParameters in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

sslContextParameters in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

username

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder username(String username)

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

Specified by:

username in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

username in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

x509HostnameVerifier

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder x509HostnameVerifier(Object x509HostnameVerifier)

To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a: javax.net.ssl.HostnameVerifier type. Group: security

Specified by:

x509HostnameVerifier in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

x509HostnameVerifier in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder

x509HostnameVerifier

default ResteasyEndpointBuilderFactory.ResteasyEndpointBuilder x509HostnameVerifier(String x509HostnameVerifier)

To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option will be converted to a javax.net.ssl.HostnameVerifier type. Group: security

Specified by:

x509HostnameVerifier in interface ResteasyEndpointBuilderFactory.ResteasyEndpointConsumerBuilder

Specified by:

x509HostnameVerifier in interface ResteasyEndpointBuilderFactory.ResteasyEndpointProducerBuilder