com.helger.as2lib.util.http

Class HTTPHelper

java.lang.Object

com.helger.as2lib.util.http.HTTPHelper

@ThreadSafe
public final class HTTPHelper
extends Object

HTTP utility methods.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	MA_HTTP_REQ_TYPE The request method used (POST or GET)
static String	MA_HTTP_REQ_URL The request URL used - defaults to "/"
static String	MA_HTTP_REQ_VERSION The HTTP version used.

Method Summary

Modifier and Type	Method and Description
static com.helger.commons.collection.impl.ICommonsList<String>	getAllHTTPHeaderLines(javax.mail.internet.InternetHeaders aHeaders)
static IHTTPIncomingDumper	getHTTPIncomingDumper()
static IHTTPOutgoingDumper	getHTTPOutgoingDumper(IBaseMessage aMsg)
static int	readChunkLen(InputStream aIS) Read chunk size (including the newline ending it).
static byte[]	readHttpPayload(InputStream aIS, IAS2HttpResponseHandler aResponseHandler, IMessage aMsg)
static DataSource	readHttpRequest(IAS2InputStreamProvider aISP, IAS2HttpResponseHandler aResponseHandler, IMessage aMsg) Read headers and payload from the passed input stream provider.
static void	readTillNexLine(InputStream aIS) Read up to (and including )CRLF.
static void	sendSimpleHTTPResponse(IAS2HttpResponseHandler aResponseHandler, int nResponseCode) Send a simple HTTP response that only contains the HTTP status code and the respective descriptive text.
static void	setHTTPIncomingDumperFactory(com.helger.commons.functional.ISupplier<? extends IHTTPIncomingDumper> aHttpDumperFactory) Set the factory for creating dumper for incoming HTTP requests.
static void	setHTTPOutgoingDumperFactory(com.helger.commons.functional.IFunction<? super IBaseMessage,? extends IHTTPOutgoingDumper> aHttpDumperFactory) Set the factory for creating dumper for outgoing HTTP requests

Methods inherited from class java.lang.Object

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

Field Detail

MA_HTTP_REQ_TYPE

public static final String MA_HTTP_REQ_TYPE

The request method used (POST or GET)

See Also:

Constant Field Values

MA_HTTP_REQ_URL

public static final String MA_HTTP_REQ_URL

The request URL used - defaults to "/"

See Also:

Constant Field Values

MA_HTTP_REQ_VERSION

public static final String MA_HTTP_REQ_VERSION

The HTTP version used. E.g. "HTTP/1.1"

See Also:

Constant Field Values

Method Detail

getAllHTTPHeaderLines

@Nonnull
 @ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsList<String> getAllHTTPHeaderLines(@Nonnull
                                                                                                                            javax.mail.internet.InternetHeaders aHeaders)

readHttpPayload

@Nonnull
public static byte[] readHttpPayload(@Nonnull
                                               InputStream aIS,
                                               @Nonnull
                                               IAS2HttpResponseHandler aResponseHandler,
                                               @Nonnull
                                               IMessage aMsg)
                                        throws IOException

Throws:

IOException

getHTTPIncomingDumper

@Nullable
public static IHTTPIncomingDumper getHTTPIncomingDumper()

Returns:

the dumper for incoming HTTP requests or null if none is present

Since:

3.0.1

setHTTPIncomingDumperFactory

public static void setHTTPIncomingDumperFactory(@Nonnull
                                                com.helger.commons.functional.ISupplier<? extends IHTTPIncomingDumper> aHttpDumperFactory)

Set the factory for creating dumper for incoming HTTP requests.

Parameters:

aHttpDumperFactory - The dumper factory to be used. May not be null.

Since:

3.1.0

getHTTPOutgoingDumper

@Nullable
public static IHTTPOutgoingDumper getHTTPOutgoingDumper(@Nonnull
                                                                   IBaseMessage aMsg)

Parameters:

aMsg - The message for which a dumper should be created.

Returns:

the dumper for outgoing HTTP requests or null if none is present. Must be closed afterwards!

Since:

3.0.1

setHTTPOutgoingDumperFactory

public static void setHTTPOutgoingDumperFactory(@Nullable
                                                com.helger.commons.functional.IFunction<? super IBaseMessage,? extends IHTTPOutgoingDumper> aHttpDumperFactory)

Set the factory for creating dumper for outgoing HTTP requests

Parameters:

aHttpDumperFactory - The dumper factory to be used. May not be null.

Since:

3.1.0

readHttpRequest

@Nonnull
public static DataSource readHttpRequest(@Nonnull
                                                   IAS2InputStreamProvider aISP,
                                                   @Nonnull
                                                   IAS2HttpResponseHandler aResponseHandler,
                                                   @Nonnull
                                                   IMessage aMsg)
                                            throws IOException,
                                                   javax.mail.MessagingException

Read headers and payload from the passed input stream provider. For large file support, return DataSource. If is on, data is not read.

Parameters:

aISP - The abstract input stream provider to use. May not be null.

aResponseHandler - The HTTP response handler to be used. May not be null.

aMsg - The Message to be filled. May not be null.

Returns:

A DataSource that holds/refers to the body.

Throws:

IOException - In case of error reading from the InputStream

javax.mail.MessagingException - In case header line parsing fails

sendSimpleHTTPResponse

public static void sendSimpleHTTPResponse(@Nonnull
                                          IAS2HttpResponseHandler aResponseHandler,
                                          @Nonnegative
                                          int nResponseCode)
                                   throws IOException

Send a simple HTTP response that only contains the HTTP status code and the respective descriptive text. An empty header map us used.

Parameters:

aResponseHandler - The response handler to be used.

nResponseCode - The HTTP response code to use.

Throws:

IOException - In case sending fails for whatever reason

readChunkLen

public static int readChunkLen(@Nonnull @WillNotClose
                               InputStream aIS)
                        throws IOException

Read chunk size (including the newline ending it). Discard any other data, e.g. headers that my be there.

Parameters:

aIS - - input stream to read from

Returns:

Chunk length

Throws:

IOException - if stream ends during chunk length read

readTillNexLine

public static void readTillNexLine(@Nonnull @WillNotClose
                                   InputStream aIS)
                            throws IOException

Read up to (and including )CRLF.

Parameters:

aIS - - input stream to read from

Throws:

IOException - if stream ends during chunk length read