org.ws4d.java.communication.protocol.http

Interface HTTPRequest

All Known Implementing Classes:

DefaultHTTPGetRequest, SOAPRequest

public interface HTTPRequest

Interface for HTTP request implementations.

This interface allows to queue a HTTP request into the HTTPClient.

Method Summary

Modifier and Type	Method and Description
long	calculateSize(ConnectionInfo connectionInfo)
AttributedURI	getOptionalMessageId()
HTTPRequestHeader	getRequestHeader(ConnectionInfo connectionInfo) Returns the HTTP header for this HTTP request.
HTTPResponseHandler	getResponseHandler(ContentType mediaType) This method allows the handling of this request's incoming response.
XAddressInfo	getTargetXAddressInfo()
void	messageWithoutBodyReceived(int code, ConnectionInfo connectionInfo, MonitoringContext context)
boolean	needsBody()
void	requestSendFailed(java.lang.Exception e, ConnectionInfo connectionInfo, MonitoringContext context) This method will be invoked if an exception occurs whilst sending the HTTP request.
void	responseReceiveFailed(java.lang.Exception e, ConnectionInfo connectionInfo, MonitoringContext context) This method will be invoked if an exception occurs whilst receiving the HTTP response.
void	serializeRequestBody(java.io.OutputStream out, ConnectionInfo connectionInfo, MonitoringContext context) Serializes the HTTP body to the given stream.

Method Detail

getRequestHeader

HTTPRequestHeader getRequestHeader(ConnectionInfo connectionInfo)

Returns the HTTP header for this HTTP request.

Returns:

the HTTP request header.

calculateSize

long calculateSize(ConnectionInfo connectionInfo)

serializeRequestBody

void serializeRequestBody(java.io.OutputStream out,
                          ConnectionInfo connectionInfo,
                          MonitoringContext context)
                   throws java.io.IOException

Serializes the HTTP body to the given stream.

Parameters:

out - the stream to serialize the body.

connectionInfo - addressing information associated to the request

Throws:

java.io.IOException

getResponseHandler

HTTPResponseHandler getResponseHandler(ContentType mediaType)
                                throws java.io.IOException

This method allows the handling of this request's incoming response.

The HTTPClient will call this method for a incoming response. If no HTTPResponseHandler belongs to this request, the HTTP client will check the internal handler list.

Parameters:

mediaType - The Internet media type of the response.

Returns:

The HTTPResponseHandler which should handle the response.

Throws:

java.io.IOException

requestSendFailed

void requestSendFailed(java.lang.Exception e,
                       ConnectionInfo connectionInfo,
                       MonitoringContext context)

This method will be invoked if an exception occurs whilst sending the HTTP request.

This method allows to check for exceptions during the HTTP request.

Parameters:

e - the exception.

responseReceiveFailed

void responseReceiveFailed(java.lang.Exception e,
                           ConnectionInfo connectionInfo,
                           MonitoringContext context)

This method will be invoked if an exception occurs whilst receiving the HTTP response.

This method allows to check for exceptions during the HTTP response.

Parameters:

e - the exception.

messageWithoutBodyReceived

void messageWithoutBodyReceived(int code,
                                ConnectionInfo connectionInfo,
                                MonitoringContext context)

getOptionalMessageId

AttributedURI getOptionalMessageId()

getTargetXAddressInfo

XAddressInfo getTargetXAddressInfo()

needsBody

boolean needsBody()