org.alfresco.test.utils.http

Class HttpUtils

java.lang.Object

org.alfresco.test.utils.CommonUtils

org.alfresco.test.utils.http.HttpUtils

public class HttpUtils
extends CommonUtils

Helper class for HttpClient based Utils.

Since:

1.0

Author:

Meenal Bhave

Constructor Summary

Constructors

Constructor and Description
HttpUtils()

Method Summary

Modifier and Type	Method and Description
protected static Boolean	checkHttpResponse(org.apache.http.HttpResponse actualResponse, int expectedResponseCode) Helper to check the actual Result Vs expected
static org.apache.http.HttpEntity	executeRequest(org.apache.http.client.HttpClient client, org.apache.http.client.methods.HttpGet request)
static org.apache.http.HttpResponse	executeRequest(org.apache.http.client.HttpClient client, org.apache.http.client.methods.HttpPost request)
static org.apache.http.HttpResponse	executeRequestHttpResp(org.apache.http.client.HttpClient client, org.apache.http.client.methods.HttpRequestBase request)
static org.apache.http.client.methods.HttpDelete	generateDeleteRequest(String requestURL, String[] headers, String[] reqBody)
static org.apache.http.client.methods.HttpGet	generateGetRequest(String requestURL, String[] headers)
static org.apache.http.client.methods.HttpPost	generatePostRequest(String requestURL, String[] headers, org.json.JSONObject reqBody)
static org.apache.http.client.methods.HttpPost	generatePostRequest(String requestURL, String[] headers, String[] reqBody)
static org.apache.http.client.methods.HttpPut	generatePutRequest(String requestURL, String[] headers, String[] reqBody)
String	getHeaderKey()
static org.apache.http.client.HttpClient	getHttpClientWithBasicAuth(String username, String password)
static org.apache.http.client.HttpClient	getHttpClientWithBasicAuth(String apiUrl, String username, String password)
static String	getParameterValue(String entity, String paramName, String response)
String[]	getRequestHeaders(String contentType)
static String	readStream(InputStream stream) Reads input stream.
protected static void	releaseConnection(org.apache.http.client.HttpClient client, org.apache.http.HttpEntity entity)
protected static void	releaseResources(org.apache.http.client.methods.HttpRequestBase request, org.apache.http.HttpResponse response)
static org.apache.http.entity.StringEntity	setMessageBody(org.json.JSONObject json) Populate HTTP message call with given content.
static org.apache.http.entity.StringEntity	setMessageBody(String content) Populate HTTP message call with given content.

Methods inherited from class org.alfresco.test.utils.CommonUtils

checkMandotaryParam, compareObjects

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpUtils

public HttpUtils()

Method Detail

getHeaderKey

public String getHeaderKey()

getRequestHeaders

public String[] getRequestHeaders(String contentType)

getHttpClientWithBasicAuth

public static org.apache.http.client.HttpClient getHttpClientWithBasicAuth(String apiUrl,
                                                                           String username,
                                                                           String password)

getHttpClientWithBasicAuth

public static org.apache.http.client.HttpClient getHttpClientWithBasicAuth(String username,
                                                                           String password)

releaseResources

protected static void releaseResources(org.apache.http.client.methods.HttpRequestBase request,
                                       org.apache.http.HttpResponse response)

generatePostRequest

public static org.apache.http.client.methods.HttpPost generatePostRequest(String requestURL,
                                                                          String[] headers,
                                                                          String[] reqBody)
                                                                   throws Exception

Throws:

Exception

generatePostRequest

public static org.apache.http.client.methods.HttpPost generatePostRequest(String requestURL,
                                                                          String[] headers,
                                                                          org.json.JSONObject reqBody)
                                                                   throws Exception

Throws:

Exception

generatePutRequest

public static org.apache.http.client.methods.HttpPut generatePutRequest(String requestURL,
                                                                        String[] headers,
                                                                        String[] reqBody)
                                                                 throws Exception

Throws:

Exception

generateGetRequest

public static org.apache.http.client.methods.HttpGet generateGetRequest(String requestURL,
                                                                        String[] headers)
                                                                 throws Exception

Throws:

Exception

getParameterValue

public static String getParameterValue(String entity,
                                       String paramName,
                                       String response)
                                throws Exception

Throws:

Exception

executeRequest

public static org.apache.http.HttpResponse executeRequest(org.apache.http.client.HttpClient client,
                                                          org.apache.http.client.methods.HttpPost request)
                                                   throws Exception

Throws:

Exception

executeRequest

public static org.apache.http.HttpEntity executeRequest(org.apache.http.client.HttpClient client,
                                                        org.apache.http.client.methods.HttpGet request)
                                                 throws Exception

Throws:

Exception

executeRequestHttpResp

public static org.apache.http.HttpResponse executeRequestHttpResp(org.apache.http.client.HttpClient client,
                                                                  org.apache.http.client.methods.HttpRequestBase request)
                                                           throws Exception

Throws:

Exception

releaseConnection

protected static void releaseConnection(org.apache.http.client.HttpClient client,
                                        org.apache.http.HttpEntity entity)
                                 throws Exception

Throws:

Exception

checkHttpResponse

protected static Boolean checkHttpResponse(org.apache.http.HttpResponse actualResponse,
                                           int expectedResponseCode)

Helper to check the actual Result Vs expected

Parameters:

HttpResponse - actualResponse

int - expectedResponseCode

Returns:

Boolean when actual matches expected response

generateDeleteRequest

public static org.apache.http.client.methods.HttpDelete generateDeleteRequest(String requestURL,
                                                                              String[] headers,
                                                                              String[] reqBody)
                                                                       throws Exception

Throws:

Exception

readStream

public static String readStream(InputStream stream)

Reads input stream.

Parameters:

stream - InputStream

Returns:

String message if input

setMessageBody

public static org.apache.http.entity.StringEntity setMessageBody(String content)
                                                          throws UnsupportedEncodingException

Populate HTTP message call with given content.

Parameters:

content - String content

Returns:

StringEntity content.

Throws:

UnsupportedEncodingException - if unsupported

setMessageBody

public static org.apache.http.entity.StringEntity setMessageBody(org.json.JSONObject json)
                                                          throws UnsupportedEncodingException

Populate HTTP message call with given content.

Parameters:

json - JSONObject content

Returns:

StringEntity content.

Throws:

UnsupportedEncodingException - if unsupported