Interface UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- All Known Subinterfaces:
UndertowEndpointBuilderFactory.UndertowEndpointBuilder
- Enclosing interface:
- UndertowEndpointBuilderFactory
public static interface UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint producers for the Undertow component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
allowedRoles
(String allowedRoles) Configuration used by UndertowSecurityProvider.cookieHandler
(String cookieHandler) Configure a cookie handler to maintain a HTTP session.cookieHandler
(org.apache.camel.http.base.cookie.CookieHandler cookieHandler) Configure a cookie handler to maintain a HTTP session.Setting to ensure socket is not closed due to inactivity.Setting to ensure socket is not closed due to inactivity.Sets additional channel options.Sets additional channel options.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.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.reuseAddresses
(Boolean reuseAddresses) Setting to facilitate socket multiplexing.reuseAddresses
(String reuseAddresses) Setting to facilitate socket multiplexing.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.sendTimeout
(Integer sendTimeout) Timeout in milliseconds when sending to a websocket channel.sendTimeout
(String sendTimeout) Timeout in milliseconds when sending to a websocket channel.To send to all websocket subscribers.To send to all websocket subscribers.sslContextParameters
(String sslContextParameters) To configure security using SSLContextParameters.sslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters.tcpNoDelay
(Boolean tcpNoDelay) Setting to improve TCP protocol performance.tcpNoDelay
(String tcpNoDelay) Setting to improve TCP protocol performance.throwExceptionOnFailure
(Boolean throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.throwExceptionOnFailure
(String throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.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.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve
-
Method Details
-
advanced
-
useStreaming
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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
-
cookieHandler
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder cookieHandler(org.apache.camel.http.base.cookie.CookieHandler cookieHandler) Configure a cookie handler to maintain a HTTP session. The option is a: <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer- Parameters:
cookieHandler
- the value to set- Returns:
- the dsl builder
-
cookieHandler
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder cookieHandler(String cookieHandler) Configure a cookie handler to maintain a HTTP session. The option will be converted to a <code>org.apache.camel.http.base.cookie.CookieHandler</code> type. Group: producer- Parameters:
cookieHandler
- the value to set- Returns:
- the dsl builder
-
keepAlive
Setting to ensure socket is not closed due to inactivity. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
keepAlive
- the value to set- Returns:
- the dsl builder
-
keepAlive
Setting to ensure socket is not closed due to inactivity. The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
keepAlive
- the value to set- Returns:
- the dsl builder
-
options
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder options(String key, Object value) 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: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: producer- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
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: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the options(String, Object) method to add a value (call the method multiple times to set more values). Group: producer- Parameters:
values
- the values- Returns:
- the dsl builder
-
preserveHostHeader
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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: <code>boolean</code> type. Default: true Group: producer- Parameters:
preserveHostHeader
- the value to set- Returns:
- the dsl builder
-
preserveHostHeader
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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 <code>boolean</code> type. Default: true Group: producer- Parameters:
preserveHostHeader
- the value to set- Returns:
- the dsl builder
-
reuseAddresses
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder reuseAddresses(Boolean reuseAddresses) Setting to facilitate socket multiplexing. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
reuseAddresses
- the value to set- Returns:
- the dsl builder
-
reuseAddresses
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder reuseAddresses(String reuseAddresses) Setting to facilitate socket multiplexing. The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
reuseAddresses
- the value to set- Returns:
- the dsl builder
-
tcpNoDelay
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder tcpNoDelay(Boolean tcpNoDelay) Setting to improve TCP protocol performance. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
tcpNoDelay
- the value to set- Returns:
- the dsl builder
-
tcpNoDelay
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder tcpNoDelay(String tcpNoDelay) Setting to improve TCP protocol performance. The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
tcpNoDelay
- the value to set- Returns:
- the dsl builder
-
throwExceptionOnFailure
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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: <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
throwExceptionOnFailure
- the value to set- Returns:
- the dsl builder
-
throwExceptionOnFailure
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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 <code>java.lang.Boolean</code> type. Default: true Group: producer- Parameters:
throwExceptionOnFailure
- the value to set- Returns:
- the dsl builder
-
allowedRoles
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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.UndertowEndpointProducerBuilder 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
-
sendTimeout
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder sendTimeout(Integer sendTimeout) Timeout in milliseconds when sending to a websocket channel. The default timeout is 30000 (30 seconds). The option is a: <code>java.lang.Integer</code> type. Default: 30000 Group: websocket- Parameters:
sendTimeout
- the value to set- Returns:
- the dsl builder
-
sendTimeout
default UndertowEndpointBuilderFactory.UndertowEndpointProducerBuilder 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 <code>java.lang.Integer</code> type. Default: 30000 Group: websocket- Parameters:
sendTimeout
- the value to set- Returns:
- the dsl builder
-
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: <code>java.lang.Boolean</code> type. Group: websocket- Parameters:
sendToAll
- the value to set- Returns:
- the dsl builder
-
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 <code>java.lang.Boolean</code> type. Group: websocket- Parameters:
sendToAll
- the value to set- Returns:
- the dsl builder
-