org.jcoderz.commons.connector.http
Interface HttpConnection

All Known Subinterfaces:

HttpConnectionExtended

All Known Implementing Classes:

HttpConnectionHelper, HttpConnectionImpl

public interface HttpConnection

This is the interface provided by the commons http connector.

Method Summary

void	close() Initiates close of the connection handle at the application level.
byte[]	sendAndReceive(byte[] message) Send a http message using retries to the peer associated with the connection in use and afterwards receive a response from it.
void	setEventListener(HttpConnectorEventListener listener, ConnectorContext context) Sets the listener for http connector events like request send and response received.
void	setRequestResponseHeader(HttpRequestResponseHeader header) Sets http request header values used whilst sending the request and http response header validated whilst receiveing the response.

Method Detail

sendAndReceive

byte[] sendAndReceive(byte[] message)
                      throws ResourceException,
                             ConnectorException

Send a http message using retries to the peer associated with the connection in use and afterwards receive a response from it.

Parameters:

message - the request message that have to be send to the peer.

Returns:

byte array containing the received http response from the peer.

Throws:

ResourceException - indicating an error while sending a request and receiving a response detected by the application server

ConnectorException - in case of a failure on transport level whilst sending/receiving the request/response

close

void close()

Initiates close of the connection handle at the application level. A connection client is required to call this method after the connection is no more in use. The physical connection will be still open afterwards.

setEventListener

void setEventListener(HttpConnectorEventListener listener,
                      ConnectorContext context)
                      throws ResourceException

Sets the listener for http connector events like request send and response received.

Parameters:

listener - the listener providing callback methods used by the connector

context - used whilst callbacks

Throws:

ResourceException - if appserver fails performing the call on the managed connection

setRequestResponseHeader

void setRequestResponseHeader(HttpRequestResponseHeader header)
                              throws ResourceException

Sets http request header values used whilst sending the request and http response header validated whilst receiveing the response.

Parameters:

header - contains request header to set and response header to validate

Throws:

ResourceException - in case of appserver failure