org.apache.camel.component.undertow

Class UndertowEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.undertow.UndertowEndpoint

All Implemented Interfaces:

org.apache.camel.AsyncEndpoint, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.16.0",
             scheme="undertow",
             title="Undertow",
             syntax="undertow:httpURI",
             consumerClass=UndertowConsumer.class,
             label="http",
             lenientProperties=true)
public class UndertowEndpoint
extends org.apache.camel.impl.DefaultEndpoint
implements org.apache.camel.AsyncEndpoint, org.apache.camel.spi.HeaderFilterStrategyAware

The undertow component provides HTTP-based endpoints for consuming and producing HTTP requests.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
UndertowEndpoint(String uri, UndertowComponent component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(io.undertow.server.HttpServerExchange httpExchange)
org.apache.camel.PollingConsumer	createPollingConsumer()
org.apache.camel.Producer	createProducer()
protected void	doStart()
UndertowComponent	getComponent()
org.apache.camel.http.common.cookie.CookieHandler	getCookieHandler()
org.apache.camel.spi.HeaderFilterStrategy	getHeaderFilterStrategy()
String	getHttpMethodRestrict()
URI	getHttpURI()
Boolean	getKeepAlive()
Boolean	getMatchOnUriPrefix()
Map<String,Object>	getOptions()
Boolean	getReuseAddresses()
SSLContext	getSslContext()
org.apache.camel.util.jsse.SSLContextParameters	getSslContextParameters()
Boolean	getTcpNoDelay()
Boolean	getThrowExceptionOnFailure()
Boolean	getTransferException()
UndertowHttpBinding	getUndertowHttpBinding()
boolean	isLenientProperties()
boolean	isOptionsEnabled()
boolean	isSingleton()
void	setCookieHandler(org.apache.camel.http.common.cookie.CookieHandler cookieHandler) Configure a cookie handler to maintain a HTTP session
void	setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
void	setHttpMethodRestrict(String httpMethodRestrict) Used to only allow consuming if the HttpMethod matches, such as GET/POST/PUT etc.
void	setHttpURI(URI httpURI) The url of the HTTP endpoint to use.
void	setKeepAlive(Boolean keepAlive) Setting to ensure socket is not closed due to inactivity
void	setMatchOnUriPrefix(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.
void	setOptions(Map<String,Object> options) Sets additional channel options.
void	setOptionsEnabled(boolean optionsEnabled) Specifies whether to enable HTTP OPTIONS for this Servlet consumer.
void	setReuseAddresses(Boolean reuseAddresses) Setting to facilitate socket multiplexing
void	setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters) To configure security using SSLContextParameters
void	setTcpNoDelay(Boolean tcpNoDelay) Setting to improve TCP protocol performance
void	setThrowExceptionOnFailure(Boolean throwExceptionOnFailure) Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server.
void	setTransferException(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.
void	setUndertowHttpBinding(UndertowHttpBinding undertowHttpBinding) To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, doStop, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createExchange, createExchange, createExchange, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

UndertowEndpoint

public UndertowEndpoint(String uri,
                        UndertowComponent component)
                 throws URISyntaxException

Throws:

URISyntaxException

Method Detail

getComponent

public UndertowComponent getComponent()

Overrides:

getComponent in class org.apache.camel.impl.DefaultEndpoint

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

createPollingConsumer

public org.apache.camel.PollingConsumer createPollingConsumer()
                                                       throws Exception

Specified by:

createPollingConsumer in interface org.apache.camel.Endpoint

Overrides:

createPollingConsumer in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

isLenientProperties

public boolean isLenientProperties()

Specified by:

isLenientProperties in interface org.apache.camel.Endpoint

Overrides:

isLenientProperties in class org.apache.camel.impl.DefaultEndpoint

createExchange

public org.apache.camel.Exchange createExchange(io.undertow.server.HttpServerExchange httpExchange)
                                         throws Exception

Throws:

Exception

getSslContext

public SSLContext getSslContext()

getHttpURI

public URI getHttpURI()

setHttpURI

public void setHttpURI(URI httpURI)

The url of the HTTP endpoint to use.

getHttpMethodRestrict

public String getHttpMethodRestrict()

setHttpMethodRestrict

public void setHttpMethodRestrict(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.

getMatchOnUriPrefix

public Boolean getMatchOnUriPrefix()

setMatchOnUriPrefix

public void setMatchOnUriPrefix(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.

getHeaderFilterStrategy

public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()

Specified by:

getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

setHeaderFilterStrategy

public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

Specified by:

setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

getSslContextParameters

public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)

To configure security using SSLContextParameters

getThrowExceptionOnFailure

public Boolean getThrowExceptionOnFailure()

setThrowExceptionOnFailure

public void setThrowExceptionOnFailure(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.

getTransferException

public Boolean getTransferException()

setTransferException

public void setTransferException(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.

getUndertowHttpBinding

public UndertowHttpBinding getUndertowHttpBinding()

setUndertowHttpBinding

public void setUndertowHttpBinding(UndertowHttpBinding undertowHttpBinding)

To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow.

getKeepAlive

public Boolean getKeepAlive()

setKeepAlive

public void setKeepAlive(Boolean keepAlive)

Setting to ensure socket is not closed due to inactivity

getTcpNoDelay

public Boolean getTcpNoDelay()

setTcpNoDelay

public void setTcpNoDelay(Boolean tcpNoDelay)

Setting to improve TCP protocol performance

getReuseAddresses

public Boolean getReuseAddresses()

setReuseAddresses

public void setReuseAddresses(Boolean reuseAddresses)

Setting to facilitate socket multiplexing

getOptions

public Map<String,Object> getOptions()

setOptions

public void setOptions(Map<String,Object> options)

Sets additional channel options. The options that can be used are defined in Options. To configure from endpoint uri, then prefix each option with option., such as option.close-abort=true&option.send-buffer=8192

isOptionsEnabled

public boolean isOptionsEnabled()

setOptionsEnabled

public void setOptionsEnabled(boolean optionsEnabled)

Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.

getCookieHandler

public org.apache.camel.http.common.cookie.CookieHandler getCookieHandler()

setCookieHandler

public void setCookieHandler(org.apache.camel.http.common.cookie.CookieHandler cookieHandler)

Configure a cookie handler to maintain a HTTP session

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class org.apache.camel.impl.DefaultEndpoint

Throws:

Exception