RestBuilder

grails.plugins.rest.client.RestBuilder

Main API entry to the synchronous version of the REST low-level client API
Authors:
Graeme Rocher
Since:
1.0

Properties Summary

Properties
Type	Name and description
`org.springframework.web.client.RestTemplate`	`restTemplate`

Constructor Summary

Constructors
Constructor and description
`RestBuilder (java.util.Map settings = [:])`
`RestBuilder (org.springframework.web.client.RestTemplate restTemplate)`

Methods Summary

Methods
Type	Name and description
`RestResponse`	`delete(java.lang.String url, groovy.lang.Closure customizer = null)` Issues DELETE a request and returns the response
`RestResponse`	`delete(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues DELETE a request and returns the response
`protected RestResponse`	`doRequestInternal(java.lang.String url, groovy.lang.Closure customizer, org.springframework.http.HttpMethod method, java.util.Map<java.lang.String, java.lang.Object> urlVariables = Collections.emptyMap()`
`RestResponse`	`get(java.lang.String url, groovy.lang.Closure customizer = null)` Issues a GET request and returns the response in the most appropriate type
`RestResponse`	`get(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues a GET request and returns the response in the most appropriate type
`static java.net.Proxy`	`getProxyForSystemProperties()`
`protected RestResponse`	`handleResponse(org.springframework.http.ResponseEntity responseEntity)`
`RestResponse`	`head(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues HEAD a request and returns the response
`RestResponse`	`head(java.lang.String url, groovy.lang.Closure customizer = null)` Issues HEAD a request and returns the response
`protected org.springframework.http.ResponseEntity`	`invokeRestTemplate(java.lang.String url, org.springframework.http.HttpMethod method, RequestCustomizer requestCustomizer)`
`RestResponse`	`options(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues OPTIONS a request and returns the response
`RestResponse`	`options(java.lang.String url, groovy.lang.Closure customizer = null)` Issues OPTIONS a request and returns the response
`RestResponse`	`patch(java.lang.String url, groovy.lang.Closure customizer = null)` Issues a PATCH request and returns the response
`RestResponse`	`patch(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues a PATCH request and returns the response
`RestResponse`	`post(java.lang.String url, groovy.lang.Closure customizer = null)` Issues a POST request and returns the response
`RestResponse`	`post(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues a POST request and returns the response
`RestResponse`	`put(java.lang.String url, groovy.lang.Closure customizer = null)` Issues a PUT request and returns the response in the most appropriate type
`RestResponse`	`put(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues a PUT request and returns the response in the most appropriate type
`protected void`	`registerMessageConverters(org.springframework.web.client.RestTemplate restTemplate)`
`RestResponse`	`trace(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, groovy.lang.Closure customizer = null)` Issues TRACE a request and returns the response
`RestResponse`	`trace(java.lang.String url, groovy.lang.Closure customizer = null)` Issues TRACE a request and returns the response

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - org.springframework.web.client.RestTemplate restTemplate
- Constructor Detail
  - RestBuilder(java.util.Map settings = [:])
  - RestBuilder(org.springframework.web.client.RestTemplate restTemplate)
- Method Detail
  - RestResponse delete(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues DELETE a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse delete(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues DELETE a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - protected RestResponse doRequestInternal(java.lang.String url, groovy.lang.Closure customizer, org.springframework.http.HttpMethod method, java.util.Map<java.lang.String, java.lang.Object> urlVariables = Collections.emptyMap()
  - RestResponse get(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a GET request and returns the response in the most appropriate type
    Parameters:
    url - The URL
    url - The closure customizer used to customize request attributes
  - RestResponse get(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a GET request and returns the response in the most appropriate type
    paral:
    urlVariables The urlVariables required by the URL pattern
    
    Parameters:
    url - The URL
    url - The closure customizer used to customize request attributes
  - static java.net.Proxy getProxyForSystemProperties()
  - protected RestResponse handleResponse(org.springframework.http.ResponseEntity responseEntity)
  - RestResponse head(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues HEAD a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse head(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues HEAD a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - protected org.springframework.http.ResponseEntity invokeRestTemplate(java.lang.String url, org.springframework.http.HttpMethod method, RequestCustomizer requestCustomizer)
  - RestResponse options(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues OPTIONS a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse options(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues OPTIONS a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse patch(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a PATCH request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse patch(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a PATCH request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse post(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a POST request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse post(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a POST request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse put(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a PUT request and returns the response in the most appropriate type
    Parameters:
    url - The URL
    customizer - The clouser customizer
  - RestResponse put(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues a PUT request and returns the response in the most appropriate type
    Parameters:
    url - The URL
    customizer - The clouser customizer
  - protected void registerMessageConverters(org.springframework.web.client.RestTemplate restTemplate)
  - RestResponse trace(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues TRACE a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer
  - RestResponse trace(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)
    
    Issues TRACE a request and returns the response
    Parameters:
    url - The URL
    customizer - (optional) The closure customizer

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class RestBuilder

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

org.springframework.web.client.RestTemplate restTemplate

Constructor Detail

RestBuilder(java.util.Map settings = [:])

RestBuilder(org.springframework.web.client.RestTemplate restTemplate)

Method Detail

RestResponse delete(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse delete(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

protected RestResponse doRequestInternal(java.lang.String url, groovy.lang.Closure customizer, org.springframework.http.HttpMethod method, java.util.Map<java.lang.String, java.lang.Object> urlVariables = Collections.emptyMap()

RestResponse get(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse get(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

static java.net.Proxy getProxyForSystemProperties()

protected RestResponse handleResponse(org.springframework.http.ResponseEntity responseEntity)

RestResponse head(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse head(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

protected org.springframework.http.ResponseEntity invokeRestTemplate(java.lang.String url, org.springframework.http.HttpMethod method, RequestCustomizer requestCustomizer)

RestResponse options(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse options(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse patch(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse patch(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse post(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse post(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse put(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse put(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

protected void registerMessageConverters(org.springframework.web.client.RestTemplate restTemplate)

RestResponse trace(java.lang.String url, java.util.Map<java.lang.String, java.lang.Object> urlVariables, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)

RestResponse trace(java.lang.String url, @groovy.lang.DelegatesTo(RequestCustomizer) groovy.lang.Closure customizer = null)