AbstractResourcesClient

grails.plugins.rest.client.templated.AbstractResourcesClient

Provides a simple client to resources exposed using Grails' REST support. Following the same conventions for URI scheme as Grails does
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`protected groovy.lang.Closure`	`customizer`
`protected java.lang.String`	`templatedUrl`

Properties Summary

Properties
Type	Name and description
`RestBuilder`	`restBuilder`
`java.lang.String`	`url`

Constructor Summary

Constructors
Constructor and description
`AbstractResourcesClient (java.lang.String url)` Parameters: `url` - The base URL.
`AbstractResourcesClient (java.lang.String url, RestBuilder restBuilder)`

Methods Summary

Methods
Type	Name and description
`protected java.lang.Object`	`convertBody(java.lang.Object requestBody)` Subclasses can optionally override to provide conversion
`void`	`customize(groovy.lang.Closure customizer)`
`RestResponse`	`delete(java.lang.Object id)` Issues a DELETE request for the given id
`T`	`get(java.lang.String acceptContentType = getAcceptContentType()` Issues a GET request to the configured URL
`T`	`get(java.lang.Object id, java.lang.String acceptContentType = getAcceptContentType()` Issues a GET request for the given id
`java.lang.String`	`getAcceptContentType()` @return Subclasses should implement to provide the default content type used to exchange resources
`java.lang.Class`	`getAcceptType()` Subclasses should implement to provide the conversion to the target representation (JSON, XML etc.)
`RestResponse`	`head(java.lang.Object id)` Issues a HEAD request for the given id
`RestResponse`	`head()` Issues a HEAD request for the given id
`RestResponse`	`options(java.lang.Object id)` Issues a OPTIONS request for the given id
`RestResponse`	`options()` Issues a OPTIONS request for the given id
`RestResponse`	`patch(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PATCH request for the given id
`RestResponse`	`patch(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PATCH request for the given id
`RestResponse`	`post(java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a POST request for the given id
`RestResponse`	`post(java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a POST request for the given id
`RestResponse`	`put(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PUT request for the given id
`RestResponse`	`put(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PUT request for the given id

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

- Field Detail
  - protected groovy.lang.Closure customizer
  - protected java.lang.String templatedUrl
- Property Detail
  - RestBuilder restBuilder
  - java.lang.String url
- Constructor Detail
  - AbstractResourcesClient(java.lang.String url)
    
    Parameters:
    url - The base URL. Example http://localhost:8080/books
  - AbstractResourcesClient(java.lang.String url, RestBuilder restBuilder)
- Method Detail
  - protected java.lang.Object convertBody(java.lang.Object requestBody)
    
    Subclasses can optionally override to provide conversion
    Parameters:
    requestBody - The request body
    Returns:
    The converted body
  - void customize(@groovy.lang.DelegatesTo( RequestCustomizer ) groovy.lang.Closure customizer)
  - RestResponse delete(java.lang.Object id)
    
    Issues a DELETE request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - T get(java.lang.String acceptContentType = getAcceptContentType()
    
    Issues a GET request to the configured URL
    Parameters:
    acceptContentType - The content type to pass in the ACCEPT header
    Returns:
    The result
  - T get(java.lang.Object id, java.lang.String acceptContentType = getAcceptContentType()
    
    Issues a GET request for the given id
    Parameters:
    id - The id
    acceptContentType - The content type to pass in the ACCEPT header
    Returns:
    The result
  - java.lang.String getAcceptContentType()
    
    Returns:
    Subclasses should implement to provide the default content type used to exchange resources
  - java.lang.Class getAcceptType()
    
    Subclasses should implement to provide the conversion to the target representation (JSON, XML etc.)
    Parameters:
    restResponse - The RestResponse
    Returns:
    The converted type
  - RestResponse head(java.lang.Object id)
    
    Issues a HEAD request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - RestResponse head()
    
    Issues a HEAD request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - RestResponse options(java.lang.Object id)
    
    Issues a OPTIONS request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - RestResponse options()
    
    Issues a OPTIONS request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - RestResponse patch(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a PATCH request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - RestResponse patch(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a PATCH request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - RestResponse post(java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a POST request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - RestResponse post(java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a POST request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - RestResponse put(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a PUT request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - RestResponse put(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a PUT request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result

Summary:
Field
Property
Constructor
Method

[Groovy] Class AbstractResourcesClient<T>

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected groovy.lang.Closure customizer

protected java.lang.String templatedUrl

Property Detail

RestBuilder restBuilder

java.lang.String url

Constructor Detail

AbstractResourcesClient(java.lang.String url)

AbstractResourcesClient(java.lang.String url, RestBuilder restBuilder)

Method Detail

protected java.lang.Object convertBody(java.lang.Object requestBody)

void customize(@groovy.lang.DelegatesTo( RequestCustomizer ) groovy.lang.Closure customizer)

RestResponse delete(java.lang.Object id)

T get(java.lang.String acceptContentType = getAcceptContentType()

T get(java.lang.Object id, java.lang.String acceptContentType = getAcceptContentType()

java.lang.String getAcceptContentType()

java.lang.Class getAcceptType()

RestResponse head(java.lang.Object id)

RestResponse head()

RestResponse options(java.lang.Object id)

RestResponse options()

RestResponse patch(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

RestResponse patch(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()

RestResponse post(java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()

RestResponse post(java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

RestResponse put(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

RestResponse put(java.lang.Object id, java.lang.Object requestBody, java.lang.String bodyContentType = getAcceptContentType()