org.apache.camel.component.ahc

Class AhcEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.ahc.AhcEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, HeaderFilterStrategyAware, StatefulService, SuspendableService

Direct Known Subclasses:

WsEndpoint

@UriEndpoint(scheme="ahc",
             title="AHC",
             syntax="ahc:httpUri",
             producerOnly=true,
             label="http")
public class AhcEndpoint
extends DefaultEndpoint
implements HeaderFilterStrategyAware

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
AhcEndpoint(String endpointUri, AhcComponent component, URI httpUri)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.ning.http.client.AsyncHttpClient	createClient(com.ning.http.client.AsyncHttpClientConfig config)
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
AhcBinding	getBinding()
int	getBufferSize()
com.ning.http.client.AsyncHttpClient	getClient()
com.ning.http.client.AsyncHttpClientConfig	getClientConfig()
AhcComponent	getComponent() Returns the component that created this endpoint.
HeaderFilterStrategy	getHeaderFilterStrategy() Gets the header filter strategy used
URI	getHttpUri()
SSLContextParameters	getSslContextParameters()
boolean	isBridgeEndpoint()
boolean	isLenientProperties() Should all properties be known or does the endpoint allow unknown options? lenient = false means that the endpoint should validate that all given options is known and configured properly.
boolean	isSingleton() Whether this class supports being singleton or not.
boolean	isThrowExceptionOnFailure()
boolean	isTransferException()
void	setBinding(AhcBinding binding) To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
void	setBridgeEndpoint(boolean bridgeEndpoint) If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request.
void	setBufferSize(int bufferSize) The initial in-memory buffer size used when transferring data between Camel and AHC Client.
void	setClient(com.ning.http.client.AsyncHttpClient client) To use a custom AsyncHttpClient
void	setClientConfig(com.ning.http.client.AsyncHttpClientConfig clientConfig) To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
void	setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
void	setHttpUri(URI httpUri) The URI to use such as http://hostname:port/path
void	setSslContextParameters(SSLContextParameters sslContextParameters) Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry.
void	setThrowExceptionOnFailure(boolean throwExceptionOnFailure) Option to disable throwing the AhcOperationFailedException 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 (for example using Jetty or Servlet Camel components).

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, getPollingConsumerQueueSize, hashCode, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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.Service

start, stop

Constructor Detail

AhcEndpoint

public AhcEndpoint(String endpointUri,
           AhcComponent component,
           URI httpUri)

Method Detail

getComponent

public AhcComponent getComponent()

Description copied from class: DefaultEndpoint

Returns the component that created this endpoint.

Overrides:

getComponent in class DefaultEndpoint

Returns:

the component that created this endpoint, or null if none set

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isLenientProperties

public boolean isLenientProperties()

Description copied from interface: Endpoint

Should all properties be known or does the endpoint allow unknown options?

lenient = false means that the endpoint should validate that all given options is known and configured properly. lenient = true means that the endpoint allows additional unknown options to be passed to it but does not throw a ResolveEndpointFailedException when creating the endpoint.

This options is used by a few components for instance the HTTP based that can have dynamic URI options appended that is targeted for an external system.

Most endpoints is configured to be not lenient.

Specified by:

isLenientProperties in interface Endpoint

Overrides:

isLenientProperties in class DefaultEndpoint

Returns:

whether properties is lenient or not

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

getClient

public com.ning.http.client.AsyncHttpClient getClient()

setClient

public void setClient(com.ning.http.client.AsyncHttpClient client)

To use a custom AsyncHttpClient

getClientConfig

public com.ning.http.client.AsyncHttpClientConfig getClientConfig()

setClientConfig

public void setClientConfig(com.ning.http.client.AsyncHttpClientConfig clientConfig)

To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.

getHttpUri

public URI getHttpUri()

setHttpUri

public void setHttpUri(URI httpUri)

The URI to use such as http://hostname:port/path

getBinding

public AhcBinding getBinding()

setBinding

public void setBinding(AhcBinding binding)

To use a custom AhcBinding which allows to control how to bind between AHC and Camel.

getHeaderFilterStrategy

public HeaderFilterStrategy getHeaderFilterStrategy()

Description copied from interface: HeaderFilterStrategyAware

Gets the header filter strategy used

Specified by:

getHeaderFilterStrategy in interface HeaderFilterStrategyAware

Returns:

the strategy

setHeaderFilterStrategy

public void setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy)

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

Specified by:

setHeaderFilterStrategy in interface HeaderFilterStrategyAware

Parameters:

headerFilterStrategy - the strategy

isBridgeEndpoint

public boolean isBridgeEndpoint()

setBridgeEndpoint

public void setBridgeEndpoint(boolean bridgeEndpoint)

If the option is true, then the Exchange.HTTP_URI header is ignored, and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back.

isThrowExceptionOnFailure

public boolean isThrowExceptionOnFailure()

setThrowExceptionOnFailure

public void setThrowExceptionOnFailure(boolean throwExceptionOnFailure)

Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.

isTransferException

public boolean isTransferException()

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 (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the AhcOperationFailedException. The caused exception is required to be serialized.

getSslContextParameters

public SSLContextParameters getSslContextParameters()

setSslContextParameters

public void setSslContextParameters(SSLContextParameters sslContextParameters)

Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.

getBufferSize

public int getBufferSize()

setBufferSize

public void setBufferSize(int bufferSize)

The initial in-memory buffer size used when transferring data between Camel and AHC Client.

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

createClient

protected com.ning.http.client.AsyncHttpClient createClient(com.ning.http.client.AsyncHttpClientConfig config)

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()