org.apache.camel.builder.endpoint.dsl

Interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

ElytronEndpointBuilderFactory.ElytronEndpointBuilder

Enclosing interface:

ElytronEndpointBuilderFactory

public static interface ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Elytron component.

Method Summary

Modifier and Type	Method and Description
default ElytronEndpointBuilderFactory.AdvancedElytronEndpointProducerBuilder	advanced()
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	allowedRoles(String allowedRoles) Comma separated list of allowed roles.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	cookieHandler(Object cookieHandler) Configure a cookie handler to maintain a HTTP session.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	cookieHandler(String cookieHandler) Configure a cookie handler to maintain a HTTP session.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	keepAlive(Boolean keepAlive) Setting to ensure socket is not closed due to inactivity.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	keepAlive(String keepAlive) Setting to ensure socket is not closed due to inactivity.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	options(Map<String,Object> options) Sets additional channel options.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	options(String options) Sets additional channel options.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	preserveHostHeader(boolean preserveHostHeader) If the option is true, UndertowProducer 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 ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	preserveHostHeader(String preserveHostHeader) If the option is true, UndertowProducer 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 ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	reuseAddresses(Boolean reuseAddresses) Setting to facilitate socket multiplexing.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	reuseAddresses(String reuseAddresses) Setting to facilitate socket multiplexing.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sendTimeout(Integer sendTimeout) Timeout in milliseconds when sending to a websocket channel.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sendTimeout(String sendTimeout) Timeout in milliseconds when sending to a websocket channel.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sendToAll(Boolean sendToAll) To send to all websocket subscribers.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sendToAll(String sendToAll) To send to all websocket subscribers.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	tcpNoDelay(Boolean tcpNoDelay) Setting to improve TCP protocol performance.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	tcpNoDelay(String tcpNoDelay) Setting to improve TCP protocol performance.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	throwExceptionOnFailure(Boolean throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	throwExceptionOnFailure(String throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	useStreaming(boolean useStreaming) For HTTP endpoint: if true , text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange ; otherwise they will be passed as byte.
default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder	useStreaming(String useStreaming) For HTTP endpoint: if true , text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange ; otherwise they will be passed as byte.

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

doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve

Method Detail

advanced

default ElytronEndpointBuilderFactory.AdvancedElytronEndpointProducerBuilder advanced()

allowedRoles

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder allowedRoles(String allowedRoles)

Comma separated list of allowed roles. The option is a: java.lang.String type. Group: common

useStreaming

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder useStreaming(boolean useStreaming)

For HTTP endpoint: if true , text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange ; otherwise they will be passed as byte. For WebSocket endpoint: if true , text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange ; otherwise they will be passed as String and byte respectively. The option is a: boolean type. Default: false Group: common

useStreaming

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder useStreaming(String useStreaming)

For HTTP endpoint: if true , text and binary messages will be wrapped as java.io.InputStream before they are passed to an Exchange ; otherwise they will be passed as byte. For WebSocket endpoint: if true , text and binary messages will be wrapped as java.io.Reader and java.io.InputStream respectively before they are passed to an Exchange ; otherwise they will be passed as String and byte respectively. The option will be converted to a boolean type. Default: false Group: common

cookieHandler

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder cookieHandler(Object cookieHandler)

Configure a cookie handler to maintain a HTTP session. The option is a: org.apache.camel.http.base.cookie.CookieHandler type. Group: producer

cookieHandler

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder cookieHandler(String cookieHandler)

Configure a cookie handler to maintain a HTTP session. The option will be converted to a org.apache.camel.http.base.cookie.CookieHandler type. Group: producer

keepAlive

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder keepAlive(Boolean keepAlive)

Setting to ensure socket is not closed due to inactivity. The option is a: java.lang.Boolean type. Default: true Group: producer

keepAlive

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder keepAlive(String keepAlive)

Setting to ensure socket is not closed due to inactivity. The option will be converted to a java.lang.Boolean type. Default: true Group: producer

lazyStartProducer

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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 ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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

options

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder options(Map<String,Object> options)

Sets additional channel options. The options that can be used are defined in org.xnio.Options . To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192. The option is a: java.util.Map<java.lang.String, java.lang.Object> type. Group: producer

options

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder options(String options)

Sets additional channel options. The options that can be used are defined in org.xnio.Options . To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192. The option will be converted to a java.util.Map<java.lang.String, java.lang.Object> type. Group: producer

preserveHostHeader

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder preserveHostHeader(boolean preserveHostHeader)

If the option is true, UndertowProducer 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: true Group: producer

preserveHostHeader

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder preserveHostHeader(String preserveHostHeader)

If the option is true, UndertowProducer 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: true Group: producer

reuseAddresses

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder reuseAddresses(Boolean reuseAddresses)

Setting to facilitate socket multiplexing. The option is a: java.lang.Boolean type. Default: true Group: producer

reuseAddresses

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder reuseAddresses(String reuseAddresses)

Setting to facilitate socket multiplexing. The option will be converted to a java.lang.Boolean type. Default: true Group: producer

tcpNoDelay

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder tcpNoDelay(Boolean tcpNoDelay)

Setting to improve TCP protocol performance. The option is a: java.lang.Boolean type. Default: true Group: producer

tcpNoDelay

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder tcpNoDelay(String tcpNoDelay)

Setting to improve TCP protocol performance. The option will be converted to a java.lang.Boolean type. Default: true Group: producer

throwExceptionOnFailure

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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: java.lang.Boolean type. Default: true Group: producer

throwExceptionOnFailure

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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 java.lang.Boolean type. Default: true Group: producer

transferException

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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: java.lang.Boolean type. Default: false Group: producer

transferException

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder 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 java.lang.Boolean type. Default: false Group: producer

sendTimeout

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sendTimeout(Integer sendTimeout)

Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds). The option is a: java.lang.Integer type. Default: 30000 Group: websocket

sendTimeout

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sendTimeout(String sendTimeout)

Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds). The option will be converted to a java.lang.Integer type. Default: 30000 Group: websocket

sendToAll

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sendToAll(Boolean sendToAll)

To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message. The option is a: java.lang.Boolean type. Group: websocket

sendToAll

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sendToAll(String sendToAll)

To send to all websocket subscribers. Can be used to configure on endpoint level, instead of having to use the UndertowConstants.SEND_TO_ALL header on the message. The option will be converted to a java.lang.Boolean type. Group: websocket

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sslContextParameters(Object sslContextParameters)

To configure security using SSLContextParameters. The option is a: org.apache.camel.support.jsse.SSLContextParameters type. Group: security

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointProducerBuilder sslContextParameters(String sslContextParameters)

To configure security using SSLContextParameters. The option will be converted to a org.apache.camel.support.jsse.SSLContextParameters type. Group: security