com.adaptris.core.http.client.net

Class StandardHttpProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.RequestReplyProducerImp

com.adaptris.core.http.client.net.HttpProducer<java.net.HttpURLConnection,java.net.HttpURLConnection>

com.adaptris.core.http.client.net.StandardHttpProducer

All Implemented Interfaces:

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

@ComponentProfile(summary="Make a HTTP request to a remote server using standard JRE components",
                  tag="producer,http,https",
                  metadata="adphttpresponse",
                  recommended=NullConnection.class)
public class StandardHttpProducer
extends HttpProducer<java.net.HttpURLConnection,java.net.HttpURLConnection>

Default HttpProducer implementation that uses HttpURLConnection available in a standard java runtime.

This uses com.adaptris.core.http.client interfaces to manage request and response headers and also the DataInputParameter and DataOutputParameter interfaces to source the HTTP body and to handle the HTTP response body respectively. Without specific overrides for these new fields then they default to the payload body.

Note that configuring a AdaptrisMessageEncoder instance will cause the DataInputParameter and DataOutputParameter fields to be ignored.

When interacting with HTTPS sites, then you may need to configure a truststore / keystore system properties if non-default certificate handling is required. As this uses HttpsURLConnection under the covers; then please consult Oracles JSSE documentation for a full discussion of the required system properties.

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

Field Summary

Fields inherited from class com.adaptris.core.http.client.net.HttpProducer

DEFAULT_TIMEOUT

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
StandardHttpProducer()
StandardHttpProducer(ProduceDestination d)

Method Summary

Modifier and Type	Method and Description
protected AdaptrisMessage	doRequest(AdaptrisMessage msg, ProduceDestination destination, long timeout) Actually do the request.
java.lang.Boolean	getAlwaysSendPayload()
HttpAuthenticator	getAuthenticator()
TimeInterval	getConnectTimeout()
TimeInterval	getReadTimeout()
DataInputParameter<java.io.InputStream>	getRequestBody()
DataOutputParameter<InputStreamWithEncoding>	getResponseBody()
void	prepare() Prepare for initialisation.
void	produce(AdaptrisMessage msg, ProduceDestination dest) Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.
void	setAlwaysSendPayload(java.lang.Boolean b) Specify whether or not to always attempt to send the payload as the entity body.
void	setAuthenticator(HttpAuthenticator authenticator) Set the authentication method to use for the HTTP request
void	setConnectTimeout(TimeInterval t) Set the connect timeout.
void	setReadTimeout(TimeInterval t) Set the read timeout.
void	setRequestBody(DataInputParameter<java.io.InputStream> input) Set where the HTTP Request body is going to come from.
void	setResponseBody(DataOutputParameter<InputStreamWithEncoding> output) Set where the HTTP Response Body will be written to.

Methods inherited from class com.adaptris.core.http.client.net.HttpProducer

close, defaultTimeout, getAllowRedirect, getContentTypeProvider, getIgnoreServerResponseCode, getMethod, getMethodProvider, getRequestHeaderProvider, getResponseHeaderHandler, init, logHeaders, setAllowRedirect, setContentTypeProvider, setIgnoreServerResponseCode, setMethodProvider, setRequestHeaderProvider, setResponseHeaderHandler, start, stop

Methods inherited from class com.adaptris.core.RequestReplyProducerImp

getIgnoreReplyMetadata, produce, request, request, request, request, setIgnoreReplyMetadata, shouldIgnoreReplyMetadata

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

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

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.AdaptrisMessageWorker

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

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

StandardHttpProducer

public StandardHttpProducer()

StandardHttpProducer

public StandardHttpProducer(ProduceDestination d)

Method Detail

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination dest)
             throws ProduceException

Description copied from interface: AdaptrisMessageSender

Produce the AdaptrisMessage to the supplied ProduceDestination , over-riding any configured destinations.

Specified by:

produce in interface AdaptrisMessageSender

Overrides:

produce in class HttpProducer<java.net.HttpURLConnection,java.net.HttpURLConnection>

Parameters:

msg - the AdaptrisMessage to produce

dest - the ProduceDestination to produce to

Throws:

ProduceException - wrapping any underlying Exceptions

See Also:

AdaptrisMessageSender.produce(AdaptrisMessage, ProduceDestination)

doRequest

protected AdaptrisMessage doRequest(AdaptrisMessage msg,
                                    ProduceDestination destination,
                                    long timeout)
                             throws ProduceException

Description copied from class: RequestReplyProducerImp

Actually do the request.

Specified by:

doRequest in class RequestReplyProducerImp

Throws:

ProduceException

See Also:

#request(AdaptrisMessage, ProduceDestination, long)

getRequestBody

public DataInputParameter<java.io.InputStream> getRequestBody()

setRequestBody

public void setRequestBody(DataInputParameter<java.io.InputStream> input)

Set where the HTTP Request body is going to come from.

Parameters:

input - the input; default is PayloadStreamInputParameter which is the only implementation currently.

getResponseBody

public DataOutputParameter<InputStreamWithEncoding> getResponseBody()

setResponseBody

public void setResponseBody(DataOutputParameter<InputStreamWithEncoding> output)

Set where the HTTP Response Body will be written to.

Note that if you have configured an AdaptrisMessageEncoder via AdaptrisMessageWorkerImp.setEncoder(com.adaptris.core.AdaptrisMessageEncoder) (such as for AS2) then this may have no effect.

Parameters:

output - the output; default is PayloadStreamOutputParameter.

prepare

public void prepare()
             throws CoreException

Description copied from interface: ComponentLifecycleExtension

Prepare for initialisation.

Throws:

CoreException

getAuthenticator

public HttpAuthenticator getAuthenticator()

setAuthenticator

public void setAuthenticator(HttpAuthenticator authenticator)

Set the authentication method to use for the HTTP request

getAlwaysSendPayload

public java.lang.Boolean getAlwaysSendPayload()

Returns:

the alwaysSendPayload

setAlwaysSendPayload

public void setAlwaysSendPayload(java.lang.Boolean b)

Specify whether or not to always attempt to send the payload as the entity body.

Only the TRACE method explicitly forbids an entity body; other methods are technically unrestricted. However, best practice suggests that entity bodies are only included for the POST/PUT/(PATCH) methods.

Parameters:

b - set this to true to always attempt to send a body (apart from TRACE), default false.

getConnectTimeout

public TimeInterval getConnectTimeout()

setConnectTimeout

public void setConnectTimeout(TimeInterval t)

Set the connect timeout.

Parameters:

t - the timeout (will be used for URLConnection.setConnectTimeout(int))

getReadTimeout

public TimeInterval getReadTimeout()

setReadTimeout

public void setReadTimeout(TimeInterval t)

Set the read timeout.

Note that any read timeout will be overridden by the timeout value passed in via the {RequestReplyProducerImp.request(AdaptrisMessage, long) method; if it is not the same as 60000

Parameters:

t - the timeout (will be used for URLConnection.setReadTimeout(int))