Package com.adaptris.core.http.apache5

Class ApacheHttpProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.RequestReplyProducerBase

com.adaptris.core.RequestReplyProducerImp

com.adaptris.core.http.apache5.HttpProducer

com.adaptris.core.http.apache5.ApacheHttpProducer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, MessageEventGenerator

@ComponentProfile(summary="Make a HTTP(s) request to a remote server using the Apache HTTP Client",
                  tag="producer,http,https",
                  metadata="adphttpresponse",
                  recommended=com.adaptris.core.NullConnection.class,
                  author="Adaptris Ltd",
                  since="4.1.0")
public class ApacheHttpProducer
extends HttpProducer

Producer implementation that uses the Apache HTTP Client as the underlying transport.

In the adapter configuration file this class is aliased as apache-http-producer which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ApacheHttpProducer.ApacheResourceTargetMatcher

Nested classes/interfaces inherited from class com.adaptris.core.http.apache5.HttpProducer

HttpProducer.HttpMethod

Field Summary

Fields inherited from class com.adaptris.core.http.apache5.HttpProducer

DEFAULT_TIMEOUT

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Constructor Summary

Constructors

Constructor	Description
ApacheHttpProducer()

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder	customise(org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)	Do any further customisations.
protected AdaptrisMessage	doRequest(AdaptrisMessage msg, java.lang.String uri, long timeout)
ResponseHandlerFactory	getResponseHandlerFactory()	How to handle the response from the HTTP Server.
protected ResponseHandlerFactory	responseHandlerFactory()
void	setResponseHandlerFactory(ResponseHandlerFactory responseHandlerFactory)	How to handle the response from the HTTP Server.

Methods inherited from class com.adaptris.core.http.apache5.HttpProducer

authenticator, defaultTimeout, doProduce, endpoint, getAuthenticator, getClientConfig, getContentTypeProvider, getIgnoreServerResponseCode, getMethod, getMethodProvider, getRequestHeaderProvider, getResponseHeaderHandler, getUrl, ignoreServerResponseCode, prepare, preserveRequestPayload, setAuthenticator, setClientConfig, setContentTypeProvider, setIgnoreServerResponseCode, setMethodProvider, setRequestHeaderProvider, setResponseHeaderHandler, setUrl, withURL

Methods inherited from class com.adaptris.core.RequestReplyProducerImp

produce, request, request

Methods inherited from class com.adaptris.core.RequestReplyProducerBase

copyReplyContents, getIgnoreReplyMetadata, mergeReply, setIgnoreReplyMetadata

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

createName

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.ComponentLifecycle

init, start, stop

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createQualifier, isTrackingEndpoint

Constructor Detail

ApacheHttpProducer

public ApacheHttpProducer()

Method Detail

responseHandlerFactory

protected ResponseHandlerFactory responseHandlerFactory()

close

public void close()

doRequest

protected AdaptrisMessage doRequest(AdaptrisMessage msg,
                                    java.lang.String uri,
                                    long timeout)
                             throws ProduceException

Specified by:

doRequest in class RequestReplyProducerImp

Throws:

ProduceException

customise

protected org.apache.hc.client5.http.impl.classic.HttpClientBuilder customise(org.apache.hc.client5.http.impl.classic.HttpClientBuilder builder)
                                                                       throws java.lang.Exception

Do any further customisations.

Parameters:

builder - the builder

Returns:

the builder.

Throws:

java.lang.Exception

getResponseHandlerFactory

public ResponseHandlerFactory getResponseHandlerFactory()

How to handle the response from the HTTP Server.

If not explicitly configured then the response payload is stored as the payload of the resulting AdaptrisMessage.

setResponseHandlerFactory

public void setResponseHandlerFactory(ResponseHandlerFactory responseHandlerFactory)

How to handle the response from the HTTP Server.

If not explicitly configured then the response payload is stored as the payload of the resulting AdaptrisMessage.