RxHttpClientBuilder (RxGORM REST Client)

grails.http.client.RxHttpClientBuilder

All Implemented Interfaces and Traits:

java.io.Closeable
```
@groovy.transform.CompileStatic
class RxHttpClientBuilder
extends java.lang.Object
```
An asynchronous REST client that leverages Netty for non-blocking IO
Authors:
Graeme Rocher
Since:
1.0

Properties Summary

Properties
Type	Name and description
`java.nio.charset.Charset`	`charset`
`Configuration`	`configuration`
`io.reactivex.netty.client.ConnectionProviderFactory`	`connectionProviderFactory`

Constructor Summary

Constructors
Constructor and description
`RxHttpClientBuilder (Configuration configuration = new DefaultConfiguration()` Constructs a new RxHttpClientBuilder instance for the given configuration
`RxHttpClientBuilder (io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory, Configuration configuration = new DefaultConfiguration()` Constructs a new RxHttpClientBuilder instance for the given configuration

Methods Summary

Methods
Type	Name and description
`protected io.netty.handler.ssl.SslContext`	`buildSslContext(java.net.URI uriObject)`
`protected io.netty.handler.ssl.SslContext`	`buildSslContext(Configuration configuration)` Builds an io.netty.handler.ssl.SslContext from the Configuration
`void`	`close()` Close down the client and shutdown the backing thread pool
`java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse>`	`customizeRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> request, groovy.lang.Closure configurer)`
`java.util.Observable<HttpClientResponse>`	`delete(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a DELETE request to the given URI with an optional customizer
`protected java.util.Observable<HttpClientResponse>`	`doRequest(HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)`
`java.util.Observable<HttpClientResponse>`	`get(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a GET request to the given URI with an optional customizer
`java.util.Observable<HttpClientResponse>`	`head(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a HEAD request to the given URI with an optional customizer
`java.util.Observable<HttpClientResponse>`	`options(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a OPTIONS request to the given URI with an optional customizer
`java.util.Observable<HttpClientResponse>`	`patch(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a PATCH request to the given URI with an optional customizer
`java.util.Observable<HttpClientResponse>`	`post(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a POST request to the given URI with an optional customizer
`java.util.Observable<HttpClientResponse>`	`put(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a PUT request to the given URI with an optional customizer

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
  - final java.nio.charset.Charset charset
  - final Configuration configuration
  - final io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory
- Constructor Detail
  - RxHttpClientBuilder(Configuration configuration = new DefaultConfiguration()
    
    Constructs a new RxHttpClientBuilder instance for the given configuration
    Parameters:
    configuration - The configuration
  - RxHttpClientBuilder(io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory, Configuration configuration = new DefaultConfiguration()
    
    Constructs a new RxHttpClientBuilder instance for the given configuration
    Parameters:
    configuration - The configuration
- Method Detail
  - protected io.netty.handler.ssl.SslContext buildSslContext(java.net.URI uriObject)
  - protected io.netty.handler.ssl.SslContext buildSslContext(Configuration configuration)
    
    Builds an io.netty.handler.ssl.SslContext from the Configuration
    Returns:
    The io.netty.handler.ssl.SslContext instance
    Parameters:
    configuration - The configuration instance
  - @java.lang.Override @javax.annotation.PreDestroy void close()
    
    Close down the client and shutdown the backing thread pool
    throws:
    IOException
  - @groovy.transform.CompileDynamic java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse> customizeRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> request, groovy.lang.Closure configurer)
  - java.util.Observable<HttpClientResponse> delete(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a DELETE request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - protected java.util.Observable<HttpClientResponse> doRequest(HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)
  - java.util.Observable<HttpClientResponse> get(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a GET request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - java.util.Observable<HttpClientResponse> head(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a HEAD request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - java.util.Observable<HttpClientResponse> options(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a OPTIONS request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - java.util.Observable<HttpClientResponse> patch(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a PATCH request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - java.util.Observable<HttpClientResponse> post(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a POST request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer
  - java.util.Observable<HttpClientResponse> put(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a PUT request to the given URI with an optional customizer
    Returns:
    A Promise to return a HttpClientResponse
    Parameters:
    uri - The URI
    customizer - The customizer

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class RxHttpClientBuilder

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final java.nio.charset.Charset charset

final Configuration configuration

final io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory

Constructor Detail

RxHttpClientBuilder(Configuration configuration = new DefaultConfiguration()

RxHttpClientBuilder(io.reactivex.netty.client.ConnectionProviderFactory connectionProviderFactory, Configuration configuration = new DefaultConfiguration()

Method Detail

protected io.netty.handler.ssl.SslContext buildSslContext(java.net.URI uriObject)

protected io.netty.handler.ssl.SslContext buildSslContext(Configuration configuration)

@java.lang.Override @javax.annotation.PreDestroy void close()

@groovy.transform.CompileDynamic java.util.Observable<io.reactivex.netty.protocol.http.client.HttpClientResponse> customizeRequest(io.reactivex.netty.protocol.http.client.HttpClientRequest<io.netty.buffer.ByteBuf, io.netty.buffer.ByteBuf> request, groovy.lang.Closure configurer)

java.util.Observable<HttpClientResponse> delete(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

protected java.util.Observable<HttpClientResponse> doRequest(HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)

java.util.Observable<HttpClientResponse> get(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

java.util.Observable<HttpClientResponse> head(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

java.util.Observable<HttpClientResponse> options(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

java.util.Observable<HttpClientResponse> patch(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

java.util.Observable<HttpClientResponse> post(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)

java.util.Observable<HttpClientResponse> put(java.lang.String uri, @groovy.lang.DelegatesTo(HttpClientRequestBuilder) groovy.lang.Closure customizer = null)