AbstractAsyncResourcesClient

grails.plugins.rest.client.async.AbstractAsyncResourcesClient

Abstract base class for Asynchronous resource clients
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
`AsyncRestBuilder`	`restBuilder`
`java.lang.String`	`url`

Constructor Summary

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

Methods Summary

Methods
Type	Name and description
`void`	`customize(groovy.lang.Closure customizer)`
`grails.async.Promise<RestResponse>`	`delete(java.lang.Object id)` Issues a DELETE request for the given id
`grails.async.Promise<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.)
`grails.async.Promise<T>`	`getAll(java.lang.String acceptContentType = getAcceptContentType()` Issues a GET request to the configured URL
`grails.async.Promise<RestResponse>`	`head(java.lang.Object id)` Issues a HEAD request for the given id
`grails.async.Promise<RestResponse>`	`head()` Issues a HEAD request for the given id
`grails.async.Promise<RestResponse>`	`options(java.lang.Object id)` Issues a OPTIONS request for the given id
`grails.async.Promise<RestResponse>`	`options()` Issues a OPTIONS request for the given id
`grails.async.Promise<RestResponse>`	`patch(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PATCH request for the given id
`grails.async.Promise<RestResponse>`	`patch(java.lang.Object id, T requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PATCH request for the given id
`grails.async.Promise<RestResponse>`	`post(T requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a POST request for the given id
`grails.async.Promise<RestResponse>`	`post(java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a POST request for the given id
`grails.async.Promise<RestResponse>`	`put(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()` Issues a PUT request for the given id
`grails.async.Promise<RestResponse>`	`put(java.lang.Object id, T 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
  - AsyncRestBuilder restBuilder
  - java.lang.String url
- Constructor Detail
  - AbstractAsyncResourcesClient(java.lang.String url)
    
    Parameters:
    url - The base URL. Example http://localhost:8080/books
  - AbstractAsyncResourcesClient(java.lang.String url, AsyncRestBuilder restBuilder)
- Method Detail
  - void customize(@groovy.lang.DelegatesTo( RequestCustomizer ) groovy.lang.Closure customizer)
  - grails.async.Promise<RestResponse> delete(java.lang.Object id)
    
    Issues a DELETE request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - grails.async.Promise<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
  - grails.async.Promise<T> getAll(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
  - grails.async.Promise<RestResponse> head(java.lang.Object id)
    
    Issues a HEAD request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - grails.async.Promise<RestResponse> head()
    
    Issues a HEAD request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - grails.async.Promise<RestResponse> options(java.lang.Object id)
    
    Issues a OPTIONS request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - grails.async.Promise<RestResponse> options()
    
    Issues a OPTIONS request for the given id
    Parameters:
    id - The id
    Returns:
    The result
  - grails.async.Promise<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
  - grails.async.Promise<RestResponse> patch(java.lang.Object id, T requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a PATCH request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - grails.async.Promise<RestResponse> post(T requestBody, java.lang.String bodyContentType = getAcceptContentType()
    
    Issues a POST request for the given id
    Parameters:
    requestBody - The requestBody of the request
    Returns:
    The result
  - grails.async.Promise<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
  - grails.async.Promise<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
  - grails.async.Promise<RestResponse> put(java.lang.Object id, T 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 AbstractAsyncResourcesClient<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

AsyncRestBuilder restBuilder

java.lang.String url

Constructor Detail

AbstractAsyncResourcesClient(java.lang.String url)

AbstractAsyncResourcesClient(java.lang.String url, AsyncRestBuilder restBuilder)

Method Detail

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

grails.async.Promise<RestResponse> delete(java.lang.Object id)

grails.async.Promise<T> get(java.lang.Object id, java.lang.String acceptContentType = getAcceptContentType()

java.lang.String getAcceptContentType()

java.lang.Class getAcceptType()

grails.async.Promise<T> getAll(java.lang.String acceptContentType = getAcceptContentType()

grails.async.Promise<RestResponse> head(java.lang.Object id)

grails.async.Promise<RestResponse> head()

grails.async.Promise<RestResponse> options(java.lang.Object id)

grails.async.Promise<RestResponse> options()

grails.async.Promise<RestResponse> patch(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

grails.async.Promise<RestResponse> patch(java.lang.Object id, T requestBody, java.lang.String bodyContentType = getAcceptContentType()

grails.async.Promise<RestResponse> post(T requestBody, java.lang.String bodyContentType = getAcceptContentType()

grails.async.Promise<RestResponse> post(java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

grails.async.Promise<RestResponse> put(java.lang.Object id, java.lang.String requestBody, java.lang.String bodyContentType = getAcceptContentType()

grails.async.Promise<RestResponse> put(java.lang.Object id, T requestBody, java.lang.String bodyContentType = getAcceptContentType()