Interface UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
UndertowEndpointBuilderFactory.UndertowEndpointBuilder
- Enclosing interface:
- UndertowEndpointBuilderFactory
public static interface UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Undertow component.
-
Method Summary
Modifier and TypeMethodDescriptionWhether or not the consumer should write access log.Whether or not the consumer should write access log.advanced()
allowedRoles
(String allowedRoles) Configuration used by UndertowSecurityProvider.fireWebSocketChannelEvents
(boolean fireWebSocketChannelEvents) if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc.fireWebSocketChannelEvents
(String fireWebSocketChannelEvents) if true, the consumer will post notifications to the route when a new WebSocket peer connects, disconnects, etc.httpMethodRestrict
(String httpMethodRestrict) Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.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.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.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.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.optionsEnabled
(boolean optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.optionsEnabled
(String optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.securityConfiguration
(Object securityConfiguration) OConfiguration used by UndertowSecurityProvider.securityConfiguration
(String securityConfiguration) OConfiguration used by UndertowSecurityProvider.securityProvider
(String securityProvider) Security provider allows plug in the provider, which will be used to secure requests.securityProvider
(org.apache.camel.component.undertow.spi.UndertowSecurityProvider securityProvider) Security provider allows plug in the provider, which will be used to secure requests.sslContextParameters
(String sslContextParameters) To configure security using SSLContextParameters.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.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.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.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.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
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
advanced
-
useStreaming
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: common- Parameters:
useStreaming
- the value to set- Returns:
- the dsl builder
-
useStreaming
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: common- Parameters:
useStreaming
- the value to set- Returns:
- the dsl builder
-
accessLog
Whether or not the consumer should write access log. The option is a: <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
accessLog
- the value to set- Returns:
- the dsl builder
-
accessLog
Whether or not the consumer should write access log. The option will be converted to a <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
accessLog
- the value to set- Returns:
- the dsl builder
-
httpMethodRestrict
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>java.lang.String</code> type. Group: consumer- Parameters:
httpMethodRestrict
- the value to set- Returns:
- the dsl builder
-
matchOnUriPrefix
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
matchOnUriPrefix
- the value to set- Returns:
- the dsl builder
-
matchOnUriPrefix
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
matchOnUriPrefix
- the value to set- Returns:
- the dsl builder
-
muteException
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
muteException
- the value to set- Returns:
- the dsl builder
-
muteException
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
muteException
- the value to set- Returns:
- the dsl builder
-
optionsEnabled
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder optionsEnabled(boolean optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
optionsEnabled
- the value to set- Returns:
- the dsl builder
-
optionsEnabled
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer- Parameters:
optionsEnabled
- the value to set- Returns:
- the dsl builder
-
transferException
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
transferException
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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>java.lang.Boolean</code> type. Default: false Group: consumer- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
allowedRoles
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder allowedRoles(String allowedRoles) Configuration used by UndertowSecurityProvider. Comma separated list of allowed roles. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
allowedRoles
- the value to set- Returns:
- the dsl builder
-
securityConfiguration
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>java.lang.Object</code> type. Group: security- Parameters:
securityConfiguration
- the value to set- Returns:
- the dsl builder
-
securityConfiguration
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>java.lang.Object</code> type. Group: security- Parameters:
securityConfiguration
- the value to set- Returns:
- the dsl builder
-
securityProvider
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder securityProvider(org.apache.camel.component.undertow.spi.UndertowSecurityProvider 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: <code>org.apache.camel.component.undertow.spi.UndertowSecurityProvider</code> type. Group: security- Parameters:
securityProvider
- the value to set- Returns:
- the dsl builder
-
securityProvider
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>org.apache.camel.component.undertow.spi.UndertowSecurityProvider</code> type. Group: security- Parameters:
securityProvider
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
sslContextParameters
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder sslContextParameters(String sslContextParameters) To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security- Parameters:
sslContextParameters
- the value to set- Returns:
- the dsl builder
-
fireWebSocketChannelEvents
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: websocket- Parameters:
fireWebSocketChannelEvents
- the value to set- Returns:
- the dsl builder
-
fireWebSocketChannelEvents
default UndertowEndpointBuilderFactory.UndertowEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: websocket- Parameters:
fireWebSocketChannelEvents
- the value to set- Returns:
- the dsl builder
-