Package io.toro.martini

Class RestMethods

java.lang.Object

io.toro.martini.RestMethods

public final class RestMethods
extends Object

Provides one-liners for easily executing HTTP requests in Groovy.

Constructor Summary

Constructors

Constructor	Description
RestMethods(io.toro.martini.service.UrlRewriter urlRewriter)

Method Summary

Modifier and Type	Method	Description
static Object	jsonDelete(String url)	Execute a DELETE request against a web service.
static Object	jsonDelete(String url, Map<String,?> params)	Execute a DELETE request against a web service.
static Object	jsonGet(String url)	Execute a GET request against a web service.
static Object	jsonGet(String url, Closure closure)	Execute a GET request against a web service.
static Object	jsonGet(String url, Map<String,?> params)	Execute a GET request against a web service.
static Object	jsonGet(String url, Map<String,?> params, Closure closure)	Execute a GET request against a web service.
static Object	jsonHead(String url)	Execute a HEAD request against a web service.
static Object	jsonHead(String url, Map<String,?> params)	Execute a HEAD request against a web service.
static Object	jsonOptions(String url)	Execute an OPTIONS request against a web service.
static Object	jsonOptions(String url, Map<String,?> params)	Execute an OPTIONS request against a web service.
static Object	jsonPatch(String url)	Execute a PATCH request against a web service.
static Object	jsonPatch(String url, Map<String,?> params)	Execute a PATCH request against a web service.
static Object	jsonPost(String url)	Execute a POST request against a web service.
static Object	jsonPost(String url, Closure closure)	Execute a POST request against a web service.
static Object	jsonPost(String url, Map<String,?> params)	Execute a POST request against a web service.
static Object	jsonPost(String url, Map<String,?> params, Closure closure)	Execute a POST request against a web service.
static Object	jsonPut(String url)	Execute a POST request against a web service.
static Object	jsonPut(String url, Map<String,?> params)	Execute a POST request against a web service.
static Object	request(String url, String method, groovyx.net.http.ContentType contentType, Closure configClosure)	Send a request, configured after the provided request data, to a RESTful web service.
static Object	request(String url, String method, groovyx.net.http.ContentType contentType, Map<String,?> params, Closure responseClosure)	Send a request, configured after the provided request data, to a RESTful web service.
static Object	xmlDelete(String url)	Execute a DELETE request against a web service.
static Object	xmlDelete(String url, Map<String,?> params)	Execute a DELETE request against a web service.
static Object	xmlGet(String url)	Execute a GET request against a web service.
static Object	xmlGet(String url, Closure closure)	Execute a GET request against a web service.
static Object	xmlGet(String url, Map<String,?> params)	Execute a GET request against a web service.
static Object	xmlGet(String url, Map<String,?> params, Closure closure)	Execute a GET request against a web service.
static Object	xmlHead(String url)	Execute a HEAD request against a web service.
static Object	xmlHead(String url, Map<String,?> params)	Execute a HEAD request against a web service.
static Object	xmlOptions(String url)	Execute an OPTIONS request against a web service.
static Object	xmlOptions(String url, Map<String,?> params)	Execute an OPTIONS request against a web service.
static Object	xmlPatch(String url)	Execute a PATCH request against a web service.
static Object	xmlPatch(String url, Map<String,?> params)	Execute a PATCH request against a web service.
static Object	xmlPost(String url)	Execute a POST request against a web service.
static Object	xmlPost(String url, Closure closure)	Execute a POST request against a web service.
static Object	xmlPost(String url, Map<String,?> params)	Execute a POST request against a web service.
static Object	xmlPost(String url, Map<String,?> params, Closure closure)	Execute a POST request against a web service.
static Object	xmlPut(String url)	Execute a PUT request against a web service.
static Object	xmlPut(String url, Map<String,?> params)	Execute a PUT request against a web service.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestMethods

@Autowired
RestMethods(io.toro.martini.service.UrlRewriter urlRewriter)

Method Detail

request

public static Object request(String url,
                             String method,
                             groovyx.net.http.ContentType contentType,
                             Map<String,?> params,
                             Closure responseClosure)
                      throws IOException,
                             URISyntaxException

Send a request, configured after the provided request data, to a RESTful web service.

Parameters:

uri - the URL of the RESTful web service

method - the type of HTTP method to use

contentType - the content type of the request and response

params - a map of parameters

responseClosure - closure to execute after the response has been received

Returns:

the response, as generated by the response handler

Throws:

IllegalArgumentException - if provided HTTP method is unknown

IOException

URISyntaxException

Since:

1.0

request

public static Object request(String url,
                             String method,
                             groovyx.net.http.ContentType contentType,
                             Closure configClosure)
                      throws IOException,
                             URISyntaxException

Send a request, configured after the provided request data, to a RESTful web service. This one-liner allows the caller to further configure request properties under configClosure through RequestConfigDelegate. Configurable properties include, but are not limited to:

• the URI path
• query parameters
• request body
• response handlers

Parameters:

url - the URL of the RESTful web service

method - the URL of the RESTful web service

contentType - the content type of the request and response; either a ContentType or valid content-type string

configClosure - closure from which to configure request options

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonDelete

public static Object jsonDelete(String url)
                         throws IOException,
                                URISyntaxException

Execute a DELETE request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonDelete().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonDelete

public static Object jsonDelete(String url,
                                Map<String,?> params)
                         throws IOException,
                                URISyntaxException

Execute a DELETE request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonDelete( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonGet

public static Object jsonGet(String url,
                             Map<String,?> params,
                             Closure closure)
                      throws IOException,
                             URISyntaxException

Execute a GET request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.jsonGet( [ 'queryString': 'page=1&size=50' ] ) {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonGet

public static Object jsonGet(String url,
                             Closure closure)
                      throws IOException,
                             URISyntaxException

Execute a GET request against a web service. JSON will be used as the request and response content type. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.jsonGet() {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonGet

public static Object jsonGet(String url,
                             Map<String,?> params)
                      throws IOException,
                             URISyntaxException

Execute a GET request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonGet( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonGet

public static Object jsonGet(String url)
                      throws IOException,
                             URISyntaxException

Execute a GET request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonGet().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonHead

public static Object jsonHead(String url,
                              Map<String,?> params)
                       throws IOException,
                              URISyntaxException

Execute a HEAD request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonHead( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonHead

public static Object jsonHead(String url)
                       throws IOException,
                              URISyntaxException

Execute a HEAD request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonHead().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonOptions

public static Object jsonOptions(String url,
                                 Map<String,?> params)
                          throws IOException,
                                 URISyntaxException

Execute an OPTIONS request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonOptions( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonOptions

public static Object jsonOptions(String url)
                          throws IOException,
                                 URISyntaxException

Execute an OPTIONS request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonOptions().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPatch

public static Object jsonPatch(String url,
                               Map<String,?> params)
                        throws IOException,
                               URISyntaxException

Execute a PATCH request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPatch( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPatch

public static Object jsonPatch(String url)
                        throws IOException,
                               URISyntaxException

Execute a PATCH request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPatch().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPost

public static Object jsonPost(String url,
                              Map<String,?> params,
                              Closure closure)
                       throws IOException,
                              URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPost( [ 'queryString': 'page=1&size=50' ] ) {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPost

public static Object jsonPost(String url,
                              Closure closure)
                       throws IOException,
                              URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPost() {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPost

public static Object jsonPost(String url,
                              Map<String,?> params)
                       throws IOException,
                              URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPost( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPost

public static Object jsonPost(String url)
                       throws IOException,
                              URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPost().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPut

public static Object jsonPut(String url,
                             Map<String,?> params)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPut( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

jsonPut

public static Object jsonPut(String url)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. JSON will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.jsonPut().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlDelete

public static Object xmlDelete(String url,
                               Map<String,?> params)
                        throws IOException,
                               URISyntaxException

Execute a DELETE request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlDelete( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlDelete

public static Object xmlDelete(String url)
                        throws IOException,
                               URISyntaxException

Execute a DELETE request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlDelete().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlGet

public static Object xmlGet(String url,
                            Map<String,?> params,
                            Closure closure)
                     throws IOException,
                            URISyntaxException

Execute a GET request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.xmlGet( [ 'queryString': 'page=1&size=50' ] ) {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlGet

public static Object xmlGet(String url,
                            Closure closure)
                     throws IOException,
                            URISyntaxException

Execute a GET request against a web service. XML will be used as the request and response content type. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.xmlGet() {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlGet

public static Object xmlGet(String url,
                            Map<String,?> params)
                     throws IOException,
                            URISyntaxException

Execute a GET request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlGet( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlGet

public static Object xmlGet(String url)
                     throws IOException,
                            URISyntaxException

Execute a GET request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlGet().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlHead

public static Object xmlHead(String url,
                             Map<String,?> params)
                      throws IOException,
                             URISyntaxException

Execute a HEAD request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlHead( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlHead

public static Object xmlHead(String url)
                      throws IOException,
                             URISyntaxException

Execute a HEAD request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlHead().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlOptions

public static Object xmlOptions(String url,
                                Map<String,?> params)
                         throws IOException,
                                URISyntaxException

Execute an OPTIONS request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlOptions( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlOptions

public static Object xmlOptions(String url)
                         throws IOException,
                                URISyntaxException

Execute an OPTIONS request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlOptions().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPatch

public static Object xmlPatch(String url)
                       throws IOException,
                              URISyntaxException

Execute a PATCH request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPatch().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPatch

public static Object xmlPatch(String url,
                              Map<String,?> params)
                       throws IOException,
                              URISyntaxException

Execute a PATCH request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPatch( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPost

public static Object xmlPost(String url,
                             Map<String,?> params,
                             Closure closure)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPost( [ 'queryString': 'page=1&size=50' ] ) {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPost

public static Object xmlPost(String url,
                             Closure closure)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. XML will be used as the request and response content type. Additional processing for the response can be done through closure.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPost() {
     response, reader -> {
         return reader
     }
 }
 

Parameters:

url - the URL of the RESTful web service

closure - closure to call after receiving the response, for further processing

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPost

public static Object xmlPost(String url,
                             Map<String,?> params)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPost( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPost

public static Object xmlPost(String url)
                      throws IOException,
                             URISyntaxException

Execute a POST request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPost().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPut

public static Object xmlPut(String url,
                            Map<String,?> params)
                     throws IOException,
                            URISyntaxException

Execute a PUT request against a web service. XML will be used as the request and response content type. Parameters for the to-be-executed request can be provided through params.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPut( [ 'queryString': 'page=1&size=50' ] ).data
 

Parameters:

url - the URL of the RESTful web service

params - a map of parameters

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0

xmlPut

public static Object xmlPut(String url)
                     throws IOException,
                            URISyntaxException

Execute a PUT request against a web service. XML will be used as the request and response content type.

Example usage:

 def data = 'http://my.host/api/resource'.xmlPut().data
 

Parameters:

url - the URL of the RESTful web service

Returns:

response returned by the server

Throws:

IOException

URISyntaxException

Since:

1.0