com.tambapps.http.hyperpoet

Class HttpPoet

java.lang.Object

com.tambapps.http.hyperpoet.AbstractHttpPoet

com.tambapps.http.hyperpoet.HttpPoet

All Implemented Interfaces:

groovy.lang.GroovyObject

public class HttpPoet
extends AbstractHttpPoet
implements groovy.lang.GroovyObject

The HTTP client

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HISTORY_LIMIT

Fields inherited from class com.tambapps.http.hyperpoet.AbstractHttpPoet

onPostExecute, onPreExecute

Constructor Summary

Constructors

Constructor and Description
HttpPoet()
HttpPoet(Map<?,?> properties)
HttpPoet(okhttp3.OkHttpClient client)
HttpPoet(okhttp3.OkHttpClient okHttpClient, String baseUrl)
HttpPoet(String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	addInterceptor(groovy.lang.Closure<okhttp3.Response> interceptor)
void	addNetworkInterceptor(groovy.lang.Closure<okhttp3.Response> interceptor)
protected Object	defaultHandleErrorResponse(okhttp3.Response response, Map<?,?> additionalParameters)
Object	delete(Map<?,?> additionalParameters, String urlOrEndpoint) Performs a delete request with the provided additional parameters and return the parsed result
Object	delete(Map<?,?> additionalParameters, String urlOrEndpoint, Function responseHandler) Performs a delete request with the provided response handler and the provided additional parameters
Object	delete(String urlOrEndpoint) Performs a delete request and return the parsed result
Object	delete(String urlOrEndpoint, Function responseHandler) Performs a delete request with the provided response handler
protected Object	doRequest(okhttp3.Request request, Map<?,?> additionalParameters)
Object	get(Map<?,?> additionalParameters, String urlOrEndpoint) Get the following url/endpoint and returns the decoded response
Object	get(Map<?,?> additionalParameters, String urlOrEndpoint, Function<Object,?> responseHandler) Get the following url/endpoint and use the closure as a response handler
Object	get(String urlOrEndpoint) Performs a get request and return the parsed result
Object	get(String urlOrEndpoint, Function responseHandler) Performs a get request with the provided response handler
groovy.lang.MetaClass	getMetaClass()
protected Object	handleErrorResponse(okhttp3.Response response, Map<?,?> additionalParameters)
protected Object	handleResponse(okhttp3.Response response, Map<?,?> additionalParameters)
Object	invokeMethod(String name, Object args)
Object	method(Map<?,?> additionalParameters, String urlOrEndpoint, HttpMethod method)
Object	method(Map<?,?> additionalParameters, String urlOrEndpoint, HttpMethod method, Function responseHandler) Performs a request with the provided method name, response handler and additional parameters
Object	method(Map<?,?> additionalParameters, String urlOrEndpoint, String method) Performs a request with the provided method name and additional parameters and return the parsed result
Object	method(Map<?,?> additionalParameters, String urlOrEndpoint, String method, Function responseHandler) Performs a request with the provided method name, response handler and additional parameters
Object	method(String urlOrEndpoint, HttpMethod method)
Object	method(String urlOrEndpoint, String method) Performs a request with the given method name and return the parsed result
Object	method(String urlOrEndpoint, String method, Function responseHandler) Performs a request with the provided method name and response handler
protected Object	parseResponse(okhttp3.Response response, Map<?,?> additionalParameters)
Object	patch(Map<?,?> additionalParameters, String urlOrEndpoint) Performs a patch request with the provided additional parameters and return the parsed result
Object	patch(Map<?,?> additionalParameters, String urlOrEndpoint, Function responseHandler) Performs a patch request with the provided response handler and the provided additional parameters
Object	patch(String urlOrEndpoint) Performs a patch request and return the parsed result
Object	patch(String urlOrEndpoint, Function responseHandler) Performs a patch request with the provided response handler
HttpPoem	poem()
Object	poem(groovy.lang.Closure closure)
Object	post(Map<?,?> additionalParameters, String urlOrEndpoint) Performs a post request with the provided additional parameters and return the parsed result
Object	post(Map<?,?> additionalParameters, String urlOrEndpoint, Function responseHandler) Performs a post request with the provided response handler and the provided additional parameters
Object	post(String urlOrEndpoint) Performs a post request and return the parsed result
Object	post(String urlOrEndpoint, Function responseHandler) Performs a post request with the provided response handler
Object	put(Map<?,?> additionalParameters, String urlOrEndpoint) Performs a put request with the provided additional parameters and return the parsed result
Object	put(Map<?,?> additionalParameters, String urlOrEndpoint, Function responseHandler) Performs a put request with the provided response handler and the provided additional parameters
Object	put(String urlOrEndpoint) Performs a put request and return the parsed result
Object	put(String urlOrEndpoint, Function responseHandler) Performs a put request with the provided response handler
okhttp3.Request	request(HttpMethod method, String urlOrEndpoint, Map<?,?> additionalParameters)
okhttp3.Request	request(String method, String urlOrEndpoint, Map<?,?> additionalParameters)
protected okhttp3.RequestBody	requestBody(Object body, Function composerOverride, ContentType contentType, String method)
void	setMetaClass(groovy.lang.MetaClass metaClass)

Methods inherited from class com.tambapps.http.hyperpoet.AbstractHttpPoet

addInterceptor, addNetworkInterceptor, configureOkHttpClient, defaultHandleErrorResponse, disableHistory, doRequest, doRequest, enableHistory, enableHistory, extractRequestBody, getAcceptContentType, getBaseUrl, getComposers, getContentType, getErrorResponseHandler, getHeaders, getHistory, getInterceptor, getInterceptors, getJsonGenerator, getMultivaluedQueryParamComposingType, getNetworkInterceptor, getNetworkInterceptors, getOkHttpClient, getOnPostExecute, getOnPreExecute, getParams, getParsers, getQueryParamComposer, getQueryParamConverters, getResponseContentType, handleErrorResponse, handleHistory, handleResponse, newPoet, parseResponse, putHeader, putHeader, removeHeader, request, setAcceptContentType, setBaseUrl, setContentType, setDefaultParser, setErrorResponseHandler, setHistory, setMultivaluedQueryParamComposingType, setOkHttpClient, setOnPostExecute, setOnPreExecute, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getProperty, setProperty

Field Detail

DEFAULT_HISTORY_LIMIT

public static final int DEFAULT_HISTORY_LIMIT

See Also:

Constant Field Values

Constructor Detail

HttpPoet

public HttpPoet()

HttpPoet

public HttpPoet(okhttp3.OkHttpClient client)

HttpPoet

public HttpPoet(Map<?,?> properties)

HttpPoet

public HttpPoet(String baseUrl)

HttpPoet

public HttpPoet(okhttp3.OkHttpClient okHttpClient,
                String baseUrl)

Method Detail

method

public Object method(String urlOrEndpoint,
                     HttpMethod method)
              throws IOException

Throws:

IOException

method

public Object method(String urlOrEndpoint,
                     String method)
              throws IOException

Performs a request with the given method name and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

method - the HTTP method

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

method

public Object method(Map<?,?> additionalParameters,
                     String urlOrEndpoint,
                     HttpMethod method)
              throws IOException

Throws:

IOException

method

public Object method(Map<?,?> additionalParameters,
                     String urlOrEndpoint,
                     String method)
              throws IOException

Performs a request with the provided method name and additional parameters and return the parsed result

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

method - the HTTP method

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

method

public Object method(String urlOrEndpoint,
                     String method,
                     Function responseHandler)
              throws IOException

Performs a request with the provided method name and response handler

Parameters:

urlOrEndpoint - the url or endpoint

method - the HTTP method

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

method

public Object method(Map<?,?> additionalParameters,
                     String urlOrEndpoint,
                     HttpMethod method,
                     Function responseHandler)
              throws IOException

Performs a request with the provided method name, response handler and additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

method - the HTTP method

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

method

public Object method(Map<?,?> additionalParameters,
                     String urlOrEndpoint,
                     String method,
                     Function responseHandler)
              throws IOException

Performs a request with the provided method name, response handler and additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

method - the HTTP method

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

put

public Object put(String urlOrEndpoint)
           throws IOException

Performs a put request and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

put

public Object put(Map<?,?> additionalParameters,
                  String urlOrEndpoint)
           throws IOException

Performs a put request with the provided additional parameters and return the parsed result

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

put

public Object put(String urlOrEndpoint,
                  Function responseHandler)
           throws IOException

Performs a put request with the provided response handler

Parameters:

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

put

public Object put(Map<?,?> additionalParameters,
                  String urlOrEndpoint,
                  Function responseHandler)
           throws IOException

Performs a put request with the provided response handler and the provided additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

patch

public Object patch(String urlOrEndpoint)
             throws IOException

Performs a patch request and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

patch

public Object patch(Map<?,?> additionalParameters,
                    String urlOrEndpoint)
             throws IOException

Performs a patch request with the provided additional parameters and return the parsed result

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

patch

public Object patch(String urlOrEndpoint,
                    Function responseHandler)
             throws IOException

Performs a patch request with the provided response handler

Parameters:

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

patch

public Object patch(Map<?,?> additionalParameters,
                    String urlOrEndpoint,
                    Function responseHandler)
             throws IOException

Performs a patch request with the provided response handler and the provided additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

post

public Object post(String urlOrEndpoint)
            throws IOException

Performs a post request and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

post

public Object post(Map<?,?> additionalParameters,
                   String urlOrEndpoint)
            throws IOException

Performs a post request with the provided additional parameters and return the parsed result

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

post

public Object post(String urlOrEndpoint,
                   Function responseHandler)
            throws IOException

Performs a post request with the provided response handler

Parameters:

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

post

public Object post(Map<?,?> additionalParameters,
                   String urlOrEndpoint,
                   Function responseHandler)
            throws IOException

Performs a post request with the provided response handler and the provided additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

delete

public Object delete(String urlOrEndpoint)
              throws IOException

Performs a delete request and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

delete

public Object delete(Map<?,?> additionalParameters,
                     String urlOrEndpoint)
              throws IOException

Performs a delete request with the provided additional parameters and return the parsed result

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

delete

public Object delete(String urlOrEndpoint,
                     Function responseHandler)
              throws IOException

Performs a delete request with the provided response handler

Parameters:

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

delete

public Object delete(Map<?,?> additionalParameters,
                     String urlOrEndpoint,
                     Function responseHandler)
              throws IOException

Performs a delete request with the provided response handler and the provided additional parameters

Parameters:

additionalParameters - the additional parameters

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

get

public Object get(String urlOrEndpoint)
           throws IOException

Performs a get request and return the parsed result

Parameters:

urlOrEndpoint - the url or endpoint

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

get

public Object get(Map<?,?> additionalParameters,
                  String urlOrEndpoint)
           throws IOException

Get the following url/endpoint and returns the decoded response

Parameters:

additionalParameters - additional parameters

urlOrEndpoint - the url or endpoint

Returns:

the response data

Throws:

IOException - in case of I/O errors

get

public Object get(String urlOrEndpoint,
                  Function responseHandler)
           throws IOException

Performs a get request with the provided response handler

Parameters:

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the result returned by the response handler

Throws:

IOException - in case of I/O error

get

public Object get(Map<?,?> additionalParameters,
                  String urlOrEndpoint,
                  Function<Object,?> responseHandler)
           throws IOException

Get the following url/endpoint and use the closure as a response handler

Parameters:

additionalParameters - additional parameters

urlOrEndpoint - the url or endpoint

responseHandler - the response handler

Returns:

the value returned by the responseHandler

Throws:

IOException - in case of I/O errors

doRequest

protected Object doRequest(okhttp3.Request request,
                           Map<?,?> additionalParameters)
                    throws IOException

Throws:

IOException

handleResponse

protected Object handleResponse(okhttp3.Response response,
                                Map<?,?> additionalParameters)

parseResponse

protected Object parseResponse(okhttp3.Response response,
                               Map<?,?> additionalParameters)

request

public okhttp3.Request request(HttpMethod method,
                               String urlOrEndpoint,
                               Map<?,?> additionalParameters)
                        throws IOException

Throws:

IOException

request

public okhttp3.Request request(String method,
                               String urlOrEndpoint,
                               Map<?,?> additionalParameters)
                        throws IOException

Throws:

IOException

handleErrorResponse

protected Object handleErrorResponse(okhttp3.Response response,
                                     Map<?,?> additionalParameters)

defaultHandleErrorResponse

protected Object defaultHandleErrorResponse(okhttp3.Response response,
                                            Map<?,?> additionalParameters)

invokeMethod

public Object invokeMethod(String name,
                           Object args)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

addInterceptor

public void addInterceptor(groovy.lang.Closure<okhttp3.Response> interceptor)

addNetworkInterceptor

public void addNetworkInterceptor(groovy.lang.Closure<okhttp3.Response> interceptor)

poem

public HttpPoem poem()

poem

public Object poem(@DelegatesTo(value=HttpPoem.class)
                   groovy.lang.Closure closure)

requestBody

protected okhttp3.RequestBody requestBody(Object body,
                                          Function composerOverride,
                                          ContentType contentType,
                                          String method)
                                   throws IOException

Overrides:

requestBody in class AbstractHttpPoet

Throws:

IOException

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject