org.alfresco.test.util

Class AlfrescoHttpClient

java.lang.Object

org.alfresco.test.util.AlfrescoHttpClient

public class AlfrescoHttpClient
extends Object

Helper class that provides HttpClient.

Author:

Michael Suzuki

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALFRESCO_API_PATH
static String	ALFRESCO_API_VERSION
static String	MIME_TYPE_JSON
static String	UTF_8_ENCODING

Constructor Summary

Constructors

Constructor and Description
AlfrescoHttpClient(String scheme, String host)
AlfrescoHttpClient(String scheme, String host, int port)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the HttpClient.
org.apache.http.HttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase request) Execute HttpClient request.
org.apache.http.HttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase request, org.apache.http.protocol.HttpContext context) Execute HttpClient request.
org.apache.http.client.methods.HttpPost	generatePostRequest(String requestURL, org.json.simple.JSONObject body) Creates the post request message body.
String	getAlfrescoUrl()
String	getAlfTicket(String username, String password) Generates an Alfresco Authentication Ticket based on the user name and password passed in.
String	getApiUrl()
String	getApiVersionUrl()
org.apache.http.client.HttpClient	getClient()
String	getHost()
org.apache.http.client.HttpClient	getHttpClientWithBasicAuth(String username, String password) Get basic http client with basic credential.
String	getParameterFromJSON(String result, String param) Method to get parameters from JSON
int	getPort()
String	getScheme()
org.json.simple.JSONObject	readStream(org.apache.http.HttpEntity entity) Parses http response stream into a JSONObject.
org.apache.http.entity.StringEntity	setMessageBody(org.json.simple.JSONObject json) Populate HTTP message call with given content.

Methods inherited from class java.lang.Object

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

Field Detail

UTF_8_ENCODING

public static final String UTF_8_ENCODING

See Also:

Constant Field Values

MIME_TYPE_JSON

public static final String MIME_TYPE_JSON

See Also:

Constant Field Values

ALFRESCO_API_PATH

public static String ALFRESCO_API_PATH

ALFRESCO_API_VERSION

public static String ALFRESCO_API_VERSION

Constructor Detail

AlfrescoHttpClient

public AlfrescoHttpClient(String scheme,
                          String host)

AlfrescoHttpClient

public AlfrescoHttpClient(String scheme,
                          String host,
                          int port)

Method Detail

getApiVersionUrl

public String getApiVersionUrl()

getAlfTicket

public String getAlfTicket(String username,
                           String password)
                    throws IOException,
                           org.json.simple.parser.ParseException

Generates an Alfresco Authentication Ticket based on the user name and password passed in.

Parameters:

username - user identifier

password - user password

Returns:

Sting authentication ticket

Throws:

org.json.simple.parser.ParseException - if error

IOException - if error

generatePostRequest

public org.apache.http.client.methods.HttpPost generatePostRequest(String requestURL,
                                                                   org.json.simple.JSONObject body)
                                                            throws Exception

Creates the post request message body.

Parameters:

requestURL - url end point

body - content of request

Returns:

HttpPost post request in json format

Throws:

Exception - if error

setMessageBody

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

Populate HTTP message call with given content.

Parameters:

json - JSONObject content

Returns:

StringEntity content.

Throws:

UnsupportedEncodingException - if unsupported

executeRequest

public org.apache.http.HttpResponse executeRequest(org.apache.http.client.methods.HttpRequestBase request)
                                            throws Exception

Execute HttpClient request.

Parameters:

request - to send

Returns:

HttpResponse response

Throws:

Exception - if error

executeRequest

public org.apache.http.HttpResponse executeRequest(org.apache.http.client.methods.HttpRequestBase request,
                                                   org.apache.http.protocol.HttpContext context)
                                            throws Exception

Execute HttpClient request.

Parameters:

request - the request to execute

context - the context to use for the execution

Returns:

HttpResponse response

Throws:

Exception - if error

getHttpClientWithBasicAuth

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

Get basic http client with basic credential.

Parameters:

username - String username

password - String password

Returns:

HttpClient client

readStream

public org.json.simple.JSONObject readStream(org.apache.http.HttpEntity entity)

Parses http response stream into a JSONObject.

Parameters:

entity - Http response entity

Returns:

JSONObject response

getParameterFromJSON

public String getParameterFromJSON(String result,
                                   String param)
                            throws org.json.simple.parser.ParseException

Method to get parameters from JSON

Parameters:

result - json message

param - key identifier

Returns:

String value of key

Throws:

org.json.simple.parser.ParseException - if error parsing

close

public void close()
           throws IOException

Closes the HttpClient.

Throws:

IOException - if error

getClient

public org.apache.http.client.HttpClient getClient()

getScheme

public String getScheme()

getHost

public String getHost()

getPort

public int getPort()

getApiUrl

public String getApiUrl()

getAlfrescoUrl

public String getAlfrescoUrl()