org.apache.camel.builder.endpoint.dsl

Interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

ElytronEndpointBuilderFactory.ElytronEndpointBuilder

Enclosing interface:

ElytronEndpointBuilderFactory

public static interface ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint consumers for the Elytron component.

Method Summary

Modifier and Type	Method and Description
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	accessLog(Boolean accessLog) Whether or not the consumer should write access log.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	accessLog(String accessLog) Whether or not the consumer should write access log.
default ElytronEndpointBuilderFactory.AdvancedElytronEndpointConsumerBuilder	advanced()
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	allowedRoles(String allowedRoles) List of allowed roles in String format.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	fireWebSocketChannelEvents(boolean fireWebSocketChannelEvents) if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	fireWebSocketChannelEvents(String fireWebSocketChannelEvents) if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	httpMethodRestrict(String httpMethodRestrict) Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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 ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	optionsEnabled(boolean optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	optionsEnabled(String optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	securityConfiguration(Object securityConfiguration) OConfiguration used by UndertowSecurityProvider.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	securityConfiguration(String securityConfiguration) OConfiguration used by UndertowSecurityProvider.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	securityProvider(Object securityProvider) Security provider allows plug in the provider, which will be used to secure requests.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	securityProvider(String securityProvider) Security provider allows plug in the provider, which will be used to secure requests.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	sslContextParameters(Object sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters.
default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder	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.ElytronEndpointConsumerBuilder	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.EndpointConsumerBuilder

doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve

Method Detail

advanced

default ElytronEndpointBuilderFactory.AdvancedElytronEndpointConsumerBuilder advanced()

useStreaming

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

accessLog

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder accessLog(Boolean accessLog)

Whether or not the consumer should write access log. The option is a: java.lang.Boolean type. Default: false Group: consumer

accessLog

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder accessLog(String accessLog)

Whether or not the consumer should write access log. The option will be converted to a java.lang.Boolean type. Default: false Group: consumer

bridgeErrorHandler

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

matchOnUriPrefix

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

muteException

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

optionsEnabled

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder optionsEnabled(boolean optionsEnabled)

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option is a: boolean type. Default: false Group: consumer

optionsEnabled

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder optionsEnabled(String optionsEnabled)

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option will be converted to a boolean type. Default: false Group: consumer

allowedRoles

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder allowedRoles(String allowedRoles)

List of allowed roles in String format. The option is a: java.lang.String type. Group: security

securityConfiguration

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder securityConfiguration(Object securityConfiguration)

OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration. The option is a: java.lang.Object type. Group: security

securityConfiguration

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder securityConfiguration(String securityConfiguration)

OConfiguration used by UndertowSecurityProvider. Security configuration object for use from UndertowSecurityProvider. Configuration is UndertowSecurityProvider specific. Each provider decides whether accepts configuration. The option will be converted to a java.lang.Object type. Group: security

securityProvider

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder securityProvider(Object securityProvider)

Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI). The option is a: org.apache.camel.component.undertow.spi.UndertowSecurityProvider type. Group: security

securityProvider

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder securityProvider(String securityProvider)

Security provider allows plug in the provider, which will be used to secure requests. SPI approach could be used too (endpoint then finds security provider using SPI). The option will be converted to a org.apache.camel.component.undertow.spi.UndertowSecurityProvider type. Group: security

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)

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

sslContextParameters

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder sslContextParameters(String sslContextParameters)

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

fireWebSocketChannelEvents

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder fireWebSocketChannelEvents(boolean fireWebSocketChannelEvents)

if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType. The option is a: boolean type. Default: false Group: websocket

fireWebSocketChannelEvents

default ElytronEndpointBuilderFactory.ElytronEndpointConsumerBuilder fireWebSocketChannelEvents(String fireWebSocketChannelEvents)

if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc. See UndertowConstants.EVENT_TYPE and EventType. The option will be converted to a boolean type. Default: false Group: websocket