Package org.eclipse.dirigible.api.v3.http

Class HttpClientFacade

java.lang.Object

org.eclipse.dirigible.api.v3.http.HttpClientFacade

All Implemented Interfaces:

IScriptingFacade

public class HttpClientFacade
extends Object
implements IScriptingFacade

Java face for HTTP operations.

Constructor Summary

Constructors

Constructor	Description
HttpClientFacade()

Method Summary

Modifier and Type	Method	Description
static org.apache.http.client.methods.HttpDelete	createDeleteRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP DELETE Request.
static org.apache.http.client.methods.HttpGet	createGetRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP GET Request.
static org.apache.http.client.methods.HttpHead	createHeadRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP HEAD Request.
static org.apache.http.client.methods.HttpPatch	createPatchRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP PATCH Request.
static org.apache.http.client.methods.HttpPost	createPostRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP POST Request.
static org.apache.http.client.methods.HttpPut	createPutRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP PUT Request.
static org.apache.http.client.methods.HttpTrace	createTraceRequest(String url, HttpClientRequestOptions httpClientRequestOptions)	Build HTTP TRACE Request.
static String	delete(String url, String options)	Performs a DELETE request for the specified URL and options.
static String	get(String url, String options)	Performs a GET request for the specified URL and options.
static String	head(String url, String options)	Performs a HEAD request for the specified URL and options.
static HttpClientRequestOptions	parseOptions(String options)	Parse HTTP Request Options.
static String	patch(String url, String options)	Performs a PATCH request for the specified URL and options.
static String	post(String url, String options)	Performs a POST request for the specified URL and options.
static org.apache.http.client.config.RequestConfig	prepareConfig(String httpClientRequestOptions)	Prepare HTTP Request Configurations.
static org.apache.http.client.config.RequestConfig	prepareConfig(HttpClientRequestOptions httpClientRequestOptions)	Prepare HTTP Request Configurations.
static HttpClientResponse	processHttpClientResponse(org.apache.http.client.methods.CloseableHttpResponse response, boolean binary)	Process http client response.
static String	put(String url, String options)	Performs a PUT request for the specified URL and options.
static String	trace(String url, String options)	Performs a TRACE request for the specified URL and options.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpClientFacade

public HttpClientFacade()

Method Details

get

public static final String get(String url, String options) throws IOException

Performs a GET request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - In case an I/O exception occurs

post

public static final String post(String url, String options) throws IOException

Performs a POST request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - In case an I/O exception occurs

put

public static final String put(String url, String options) throws IOException

Performs a PUT request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - Signals that an I/O exception has occurred.

patch

public static final String patch(String url, String options) throws IOException

Performs a PATCH request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - Signals that an I/O exception has occurred.

delete

public static final String delete(String url, String options) throws IOException

Performs a DELETE request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - In case an I/O exception occurs

head

public static final String head(String url, String options) throws IOException

Performs a HEAD request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - In case an I/O exception occurs

trace

public static final String trace(String url, String options) throws IOException

Performs a TRACE request for the specified URL and options.

Parameters:

url - the URL

options - the options

Returns:

the response as JSON

Throws:

IOException - In case an I/O exception occurs

processHttpClientResponse

public static HttpClientResponse processHttpClientResponse(org.apache.http.client.methods.CloseableHttpResponse response, boolean binary) throws IOException

Process http client response.

Parameters:

response - the response

binary - the binary

Returns:

the http client response

Throws:

IOException - Signals that an I/O exception has occurred.

parseOptions

public static HttpClientRequestOptions parseOptions(String options)

Parse HTTP Request Options.

Parameters:

options - the options

Returns:

the http client request options

prepareConfig

public static org.apache.http.client.config.RequestConfig prepareConfig(String httpClientRequestOptions)

Prepare HTTP Request Configurations.

Parameters:

httpClientRequestOptions - the http client request options

Returns:

the request config

prepareConfig

public static org.apache.http.client.config.RequestConfig prepareConfig(HttpClientRequestOptions httpClientRequestOptions)

Prepare HTTP Request Configurations.

Parameters:

httpClientRequestOptions - the http client request options

Returns:

the request config

createGetRequest

public static org.apache.http.client.methods.HttpGet createGetRequest(String url, HttpClientRequestOptions httpClientRequestOptions)

Build HTTP GET Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http get

createPostRequest

public static final org.apache.http.client.methods.HttpPost createPostRequest(String url, HttpClientRequestOptions httpClientRequestOptions) throws IOException

Build HTTP POST Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http post

Throws:

IOException - Signals that an I/O exception has occurred.

createPutRequest

public static final org.apache.http.client.methods.HttpPut createPutRequest(String url, HttpClientRequestOptions httpClientRequestOptions) throws IOException

Build HTTP PUT Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http put

Throws:

IOException - Signals that an I/O exception has occurred.

createPatchRequest

public static final org.apache.http.client.methods.HttpPatch createPatchRequest(String url, HttpClientRequestOptions httpClientRequestOptions) throws IOException

Build HTTP PATCH Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http patch

Throws:

IOException - Signals that an I/O exception has occurred.

createDeleteRequest

public static org.apache.http.client.methods.HttpDelete createDeleteRequest(String url, HttpClientRequestOptions httpClientRequestOptions)

Build HTTP DELETE Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http delete

createHeadRequest

public static org.apache.http.client.methods.HttpHead createHeadRequest(String url, HttpClientRequestOptions httpClientRequestOptions)

Build HTTP HEAD Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http head

createTraceRequest

public static org.apache.http.client.methods.HttpTrace createTraceRequest(String url, HttpClientRequestOptions httpClientRequestOptions)

Build HTTP TRACE Request.

Parameters:

url - the url

httpClientRequestOptions - the http client request options

Returns:

the http trace