com.helger.phase4.client

Class BasicHttpPoster

java.lang.Object

com.helger.phase4.client.BasicHttpPoster

Direct Known Subclasses:

AbstractAS4Client

public class BasicHttpPoster
extends Object

A generic HTTP POST wrapper based on IHttpClientProvider and HttpPost.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
BasicHttpPoster()

Method Summary

Modifier and Type	Method and Description
static com.helger.httpclient.HttpClientFactory	createDefaultHttpClientFactory()
com.helger.httpclient.HttpClientFactory	getHttpClientFactory()
com.helger.commons.functional.IConsumer<? super org.apache.http.client.methods.HttpPost>	getHttpCustomizer()
boolean	isQuoteHttpHeaders()
<T> T	sendGenericMessage(String sURL, org.apache.http.HttpEntity aHttpEntity, com.helger.commons.http.HttpHeaderMap aCustomHeaders, org.apache.http.client.ResponseHandler<? extends T> aResponseHandler) Send an arbitrary HTTP POST message to the provided URL, using the contained HttpClientFactory as well as the customizer.
<T> T	sendGenericMessageWithRetries(com.helger.commons.http.HttpHeaderMap aHttpHeaders, org.apache.http.HttpEntity aHttpEntity, String sMessageID, String sURL, int nMaxRetries, long nRetryIntervalMS, org.apache.http.client.ResponseHandler<? extends T> aResponseHandler, IAS4OutgoingDumper aOutgoingDumper)
BasicHttpPoster	setHttpClientFactory(com.helger.httpclient.HttpClientFactory aHttpClientFactory) Set the HTTP client provider to be used.
BasicHttpPoster	setHttpCustomizer(com.helger.commons.functional.IConsumer<? super org.apache.http.client.methods.HttpPost> aHttpCustomizer) Set the HTTP Post Customizer to be used.
BasicHttpPoster	setQuoteHttpHeaders(boolean bQuoteHttpHeaders) Enable or disable, if HTTP header values should be quoted or not.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicHttpPoster

public BasicHttpPoster()

Method Detail

createDefaultHttpClientFactory

@Nonnull
public static com.helger.httpclient.HttpClientFactory createDefaultHttpClientFactory()

Returns:

The default HttpClientFactory to be used.

Since:

0.8.3

getHttpClientFactory

@Nonnull
public final com.helger.httpclient.HttpClientFactory getHttpClientFactory()

Returns:

The internal http client factory used for http sending.

setHttpClientFactory

@Nonnull
public final BasicHttpPoster setHttpClientFactory(@Nonnull
                                                            com.helger.httpclient.HttpClientFactory aHttpClientFactory)

Set the HTTP client provider to be used. This is e.g. necessary when a custom SSL context or a proxy server is to be used. See createDefaultHttpClientFactory() as the default implementation of IHttpClientProvider. This factory is used for http sending.

Parameters:

aHttpClientFactory - The HTTP client factory to be used. May not be null.

Returns:

this for chaining

getHttpCustomizer

@Nullable
public final com.helger.commons.functional.IConsumer<? super org.apache.http.client.methods.HttpPost> getHttpCustomizer()

Returns:

The HTTP Post customizer to be used. May be null.

Since:

0.8.3

setHttpCustomizer

@Nonnull
public final BasicHttpPoster setHttpCustomizer(@Nullable
                                                         com.helger.commons.functional.IConsumer<? super org.apache.http.client.methods.HttpPost> aHttpCustomizer)

Set the HTTP Post Customizer to be used.

Parameters:

aHttpCustomizer - The new customizer. May be null.

Returns:

this for chaining

Since:

0.8.3

isQuoteHttpHeaders

public final boolean isQuoteHttpHeaders()

Returns:

true if HTTP header values should be quoted if they contain forbidden characters, false if not.

Since:

v0.9.1

setQuoteHttpHeaders

@Nonnull
public final BasicHttpPoster setQuoteHttpHeaders(boolean bQuoteHttpHeaders)

Enable or disable, if HTTP header values should be quoted or not. For compatibility it is recommended, to not quote the values.

Parameters:

bQuoteHttpHeaders - true to quote them, false to not quote them.

Returns:

this for chaining

Since:

v0.9.1

sendGenericMessage

@Nullable
public final <T> T sendGenericMessage(@Nonnull @Nonempty
                                                 String sURL,
                                                 @Nonnull
                                                 org.apache.http.HttpEntity aHttpEntity,
                                                 @Nullable
                                                 com.helger.commons.http.HttpHeaderMap aCustomHeaders,
                                                 @Nonnull
                                                 org.apache.http.client.ResponseHandler<? extends T> aResponseHandler)
                                          throws javax.mail.MessagingException,
                                                 IOException

Send an arbitrary HTTP POST message to the provided URL, using the contained HttpClientFactory as well as the customizer. Additionally the AS4 HTTP debugging is invoked in here.
This method does NOT retry

Type Parameters:

T - Response data type

Parameters:

sURL - The URL to send to. May neither be null nor empty.

aHttpEntity - The HTTP entity to be send. May not be null.

aCustomHeaders - An optional http header map that should be applied. May be null.

aResponseHandler - The Http response handler that should be used to convert the HTTP response to a domain object.

Returns:

The HTTP response. May be null.

Throws:

javax.mail.MessagingException - In case moving HTTP headers from the Mime part to the HTTP message fails

IOException - In case of IO error

sendGenericMessageWithRetries

@Nonnull
public final <T> T sendGenericMessageWithRetries(@Nullable
                                                           com.helger.commons.http.HttpHeaderMap aHttpHeaders,
                                                           @Nonnull
                                                           org.apache.http.HttpEntity aHttpEntity,
                                                           @Nonnull
                                                           String sMessageID,
                                                           @Nonnull
                                                           String sURL,
                                                           int nMaxRetries,
                                                           long nRetryIntervalMS,
                                                           @Nonnull
                                                           org.apache.http.client.ResponseHandler<? extends T> aResponseHandler,
                                                           @Nullable
                                                           IAS4OutgoingDumper aOutgoingDumper)
                                                    throws Exception

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object