vle.domain.webservice.http
Class HttpPostRequest

java.lang.Object
  vle.domain.webservice.http.AbstractHttpRequest
      vle.domain.webservice.http.HttpPostRequest

public final class HttpPostRequest
extends AbstractHttpRequest

Immutable and thread-safe class to encapsulate data required for a post request (headers, parameters, body, relativeUrl and expected response).

Version:

$Id$

Author:

Cynick Young

Field Summary

Fields inherited from class vle.domain.webservice.http.AbstractHttpRequest

expectedResponseStatusCode, logger, relativeUrl, requestHeaders, requestParameters

Constructor Summary

HttpPostRequest(Map<String,String> requestHeaders, Map<String,String> requestParameters, String bodyData, String relativeUrl, int expectedResponseStatusCode)
Creates an HttpPostRequest object with all of the data required.

Method Summary

String

getBodyData() Returns the body data for this request.

Methods inherited from class vle.domain.webservice.http.AbstractHttpRequest

checkForLegalHeaders, getExpectedResponseStatusCode, getRelativeUrl, getRequestHeaders, getRequestParameters, isValidResponseStatus, logMethodInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPostRequest

public HttpPostRequest(Map<String,String> requestHeaders,
                       Map<String,String> requestParameters,
                       String bodyData,
                       String relativeUrl,
                       int expectedResponseStatusCode)
                throws BadHeaderException

Creates an HttpPostRequest object with all of the data required.

Parameters:

requestHeaders - is a map of HTTP request headers

requestParameters - is a map of HTTP request parameters

bodyData - is the serialized string of the body of a POST request

relativeUrl - is the target relative URL for this request

expectedResponseStatusCode - is the HTTP status code that is expected to be returned by the server

Throws:

BadHeaderException - if the request headers contain any illegal characters either in the request field name or the request field value

Method Detail

getBodyData

public String getBodyData()

Returns the body data for this request.

Returns:

the bodyData