com.helger.as2lib.util.http

Class AS2HttpClient

java.lang.Object

com.helger.as2lib.util.http.AS2HttpClient

All Implemented Interfaces:

IAS2HttpConnection

public class AS2HttpClient
extends Object
implements IAS2HttpConnection

Http connection, Implemented as HttpClient.

Author:

Ziv Harpaz

Constructor Summary

Constructors

Constructor and Description
AS2HttpClient(String sUrl, int nConnectTimeout, int nReadTimeout, com.helger.commons.http.EHttpMethod eRequestMethod, Proxy aProxy, SSLContext aSSLContext, HostnameVerifier aHV)

Method Summary

Modifier and Type	Method and Description
void	disconnect() Close the connection
InputStream	getInputStream() Get InputStream
OutputStream	getOutputStream() Provides an output stream so user can write message content to it.
int	getResponseCode() Get response HTTP Status as integer
com.helger.commons.http.HttpHeaderMap	getResponseHeaderFields()
String	getResponseMessage() Get the response message
URL	getURL() Get URL
long	send(InputStream aISToSend, com.helger.mail.cte.EContentTransferEncoding eCTE, IHTTPOutgoingDumper aOutgoingDumper)
void	setHttpHeader(String sName, String sValue) Set an HTTP header (replacing existing value)

Methods inherited from class java.lang.Object

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

Constructor Detail

AS2HttpClient

public AS2HttpClient(@Nonnull @Nonempty
                     String sUrl,
                     int nConnectTimeout,
                     int nReadTimeout,
                     @Nonnull
                     com.helger.commons.http.EHttpMethod eRequestMethod,
                     @Nullable
                     Proxy aProxy,
                     @Nullable
                     SSLContext aSSLContext,
                     @Nullable
                     HostnameVerifier aHV)

Method Detail

setHttpHeader

public void setHttpHeader(@Nonnull
                          String sName,
                          @Nonnull
                          String sValue)

Set an HTTP header (replacing existing value)

Specified by:

setHttpHeader in interface IAS2HttpConnection

Parameters:

sName - Header name

sValue - Header value

getURL

public URL getURL()
           throws OpenAS2Exception

Get URL

Specified by:

getURL in interface IAS2HttpConnection

Returns:

URL

Throws:

OpenAS2Exception - in case of error

getOutputStream

@Nonnull
public OutputStream getOutputStream()
                                       throws IOException

Provides an output stream so user can write message content to it. Starts the sending to caller can start write to the received stream

Specified by:

getOutputStream in interface IAS2HttpConnection

Returns:

OutputStream to write message body to

Throws:

IOException - in case of error

send

@Nonnegative
public long send(@Nonnull
                               InputStream aISToSend,
                               @Nonnull
                               com.helger.mail.cte.EContentTransferEncoding eCTE,
                               @Nullable
                               IHTTPOutgoingDumper aOutgoingDumper)
                        throws IOException

Parameters:

aISToSend - InputStream to send. May not be null.

eCTE - Content-Transfer-Encoding to be used. May not be null.

aOutgoingDumper - Optional outgoing dumper

Returns:

bytes sent. Must be ≥ 0.

Throws:

IOException - In case of error

getInputStream

public InputStream getInputStream()
                           throws OpenAS2Exception,
                                  IOException

Get InputStream

Specified by:

getInputStream in interface IAS2HttpConnection

Returns:

InputStream to read response body from

Throws:

OpenAS2Exception - in case of error

IOException - in case of error

getResponseCode

public int getResponseCode()
                    throws OpenAS2Exception

Get response HTTP Status as integer

Specified by:

getResponseCode in interface IAS2HttpConnection

Returns:

response HTTP Status as integer

Throws:

OpenAS2Exception - in case of error

getResponseMessage

public String getResponseMessage()
                          throws OpenAS2Exception

Get the response message

Specified by:

getResponseMessage in interface IAS2HttpConnection

Returns:

the response message

Throws:

OpenAS2Exception - in case of error

getResponseHeaderFields

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.http.HttpHeaderMap getResponseHeaderFields()
                                                                                              throws OpenAS2Exception

Specified by:

getResponseHeaderFields in interface IAS2HttpConnection

Returns:

the headers of the response

Throws:

OpenAS2Exception - in case of error

disconnect

public void disconnect()

Close the connection

Specified by:

disconnect in interface IAS2HttpConnection