org.alfresco.dataprep

Class AlfrescoHttpClient

java.lang.Object

org.alfresco.dataprep.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.
void	close(org.apache.http.impl.client.CloseableHttpClient client) Closes the HttpClient.
org.apache.http.HttpResponse	execute(String userName, String password, org.apache.http.client.methods.HttpRequestBase request) Execute HttpClient request without releasing the connection
org.apache.http.HttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase request) Deprecated. Execute HttpClient request.
org.apache.http.HttpResponse	executeRequest(String userName, String password, org.apache.http.client.methods.HttpRequestBase request) Execute HttpClient request.
org.apache.http.HttpResponse	executeRequest(String userName, String password, org.json.simple.JSONObject body, org.apache.http.client.methods.HttpEntityEnclosingRequestBase request) Execute HttpClient POST OR PUT
String	getAlfrescoUrl()
String	getAlfrescoVersion() Get the alfresco version
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()
List<String>	getElementsFromJsonArray(org.apache.http.HttpResponse response, String array, String elementFromArray) Get the elements from a JSONArray
String	getHost()
org.apache.http.impl.client.CloseableHttpClient	getHttpClientWithBasicAuth(String username, String password) Get basic http client with basic credential.
String	getParameterFromJSON(org.apache.http.HttpResponse response, String jsonObject, String parameter) Method to get parameters from JSON
String	getParameterFromJSON(String result, String param) Method to get parameters from JSON
int	getPort()
String	getScheme()
String	getSpecificElementFromJArray(org.apache.http.HttpResponse response, String array, String itemName, String itemParameter, String requiredElement)
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)

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

Parameters:

username - user identifier

password - user password

Returns:

String authentication ticket

getAlfrescoVersion

public String getAlfrescoVersion()

Get the alfresco version

Returns:

String version of alfresco

setMessageBody

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

Populate HTTP message call with given content.

Parameters:

json - JSONObject content

Returns:

StringEntity content.

executeRequest

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

Deprecated. Execute HttpClient request.

Parameters:

request - to send

Returns:

HttpResponse response

execute

public org.apache.http.HttpResponse execute(String userName,
                                            String password,
                                            org.apache.http.client.methods.HttpRequestBase request)

Execute HttpClient request without releasing the connection

Parameters:

userName - user name

password - password

request - to send

Returns:

HttpResponse response

executeRequest

public org.apache.http.HttpResponse executeRequest(String userName,
                                                   String password,
                                                   org.apache.http.client.methods.HttpRequestBase request)

Execute HttpClient request.

Parameters:

userName - String user name

password - String password

request - HttpRequestBase the request

Returns:

HttpResponse response

executeRequest

public org.apache.http.HttpResponse executeRequest(String userName,
                                                   String password,
                                                   org.json.simple.JSONObject body,
                                                   org.apache.http.client.methods.HttpEntityEnclosingRequestBase request)

Execute HttpClient POST OR PUT

Parameters:

userName - String user name

password - String password

body - JSONObject body of the request

request - HttpEntityEnclosingRequestBase the request

Returns:

HttpResponse response

getHttpClientWithBasicAuth

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

Get basic http client with basic credential.

Parameters:

username - String username

password - String password

Returns:

CloseableHttpClient 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)

Method to get parameters from JSON

Parameters:

result - json message

param - key identifier

Returns:

String value of key

getParameterFromJSON

public String getParameterFromJSON(org.apache.http.HttpResponse response,
                                   String jsonObject,
                                   String parameter)

Method to get parameters from JSON

Parameters:

response - HttpResponse response

jsonObject - String json object from response

parameter - String parameter from json

Returns:

String result

getElementsFromJsonArray

public List<String> getElementsFromJsonArray(org.apache.http.HttpResponse response,
                                             String array,
                                             String elementFromArray)

Get the elements from a JSONArray

Parameters:

response - HttpResponse response

array - String the name of the array

elementFromArray - element from array

Returns:

List elements found in the array

getSpecificElementFromJArray

public String getSpecificElementFromJArray(org.apache.http.HttpResponse response,
                                           String array,
                                           String itemName,
                                           String itemParameter,
                                           String requiredElement)

close

public void close()

Closes the HttpClient.

Throws:

IOException - if error

close

public void close(org.apache.http.impl.client.CloseableHttpClient client)

Closes the HttpClient.

Parameters:

client - CloseableHttpClient the client

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()