AsyncHttpBuilder (Grails Views 1.0.0-SNAPSHOT)

grails.http.client.AsyncHttpBuilder

An asynchronous REST client that leverages Netty for non-blocking IO
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`AsyncHttpBuilder.AsyncHttpClientInitializer`	Initializes the HTTP client channel
`static class`	`AsyncHttpBuilder.HttpConnectionListener`
`static class`	`AsyncHttpBuilder.HttpResponseHandler`

Field Summary

Fields
Modifiers	Name	Description
`protected io.netty.bootstrap.Bootstrap`	`bootstrap`
`protected io.netty.channel.EventLoopGroup`	`group`

Properties Summary

Properties
Type	Name and description
`java.nio.charset.Charset`	`charset`
`Configuration`	`configuration`

Constructor Summary

Constructors
Constructor and description
`AsyncHttpBuilder (Configuration configuration = new DefaultConfiguration()` Constructs a new AsyncHttpBuilder instance for the given configuration

Methods Summary

Methods
Type	Name and description
`protected NettyPromise<HttpClientResponse>`	`buildPromise(io.netty.util.concurrent.Promise promise)`
`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
`grails.async.Promise<HttpClientResponse>`	`delete(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a DELETE request to the given URI with an optional customizer
`protected io.netty.channel.ChannelFuture`	`doConnect(java.net.URI uri, io.netty.handler.ssl.SslContext sslCtx)`
`protected io.netty.channel.ChannelFuture`	`doConnect(java.lang.String host, int port, io.netty.handler.ssl.SslContext sslCtx)` Creates an initial connection to the given remote host
`protected io.netty.channel.ChannelFuture`	`doConnect(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port)` Creates an initial connection with the given bootstrap and remote host
`protected NettyPromise<HttpClientResponse>`	`doRequest(io.netty.handler.codec.http.HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)`
`grails.async.Promise<HttpClientResponse>`	`get(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a GET request to the given URI with an optional customizer
`grails.async.Promise<HttpClientResponse>`	`head(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a HEAD request to the given URI with an optional customizer
`protected io.netty.util.concurrent.Promise`	`newPromise(io.netty.channel.ChannelFuture channelFuture)`
`grails.async.Promise<HttpClientResponse>`	`options(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a OPTIONS request to the given URI with an optional customizer
`grails.async.Promise<HttpClientResponse>`	`patch(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a PATCH request to the given URI with an optional customizer
`grails.async.Promise<HttpClientResponse>`	`post(java.lang.String uri, groovy.lang.Closure customizer = null)` Executes a POST request to the given URI with an optional customizer
`grails.async.Promise<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()`

- Field Detail
  - protected final io.netty.bootstrap.Bootstrap bootstrap
  - protected final io.netty.channel.EventLoopGroup group
- Property Detail
  - final java.nio.charset.Charset charset
  - final Configuration configuration
- Constructor Detail
  - AsyncHttpBuilder(Configuration configuration = new DefaultConfiguration()
    
    Constructs a new AsyncHttpBuilder instance for the given configuration
    Parameters:
    configuration - The configuration
- Method Detail
  - protected NettyPromise<HttpClientResponse> buildPromise(io.netty.util.concurrent.Promise promise)
  - 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
    Parameters:
    configuration - The configuration instance
    Returns:
    The io.netty.handler.ssl.SslContext instance
  - grails.async.Promise<HttpClientResponse> delete(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a DELETE request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - protected io.netty.channel.ChannelFuture doConnect(java.net.URI uri, io.netty.handler.ssl.SslContext sslCtx)
  - protected io.netty.channel.ChannelFuture doConnect(java.lang.String host, int port, io.netty.handler.ssl.SslContext sslCtx)
    
    Creates an initial connection to the given remote host
    Parameters:
    host - The host
    port - The port
    sslCtx - The SslContext instance
    Returns:
    A ChannelFuture
  - protected io.netty.channel.ChannelFuture doConnect(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port)
    
    Creates an initial connection with the given bootstrap and remote host
    Parameters:
    bootstrap - The bootstrap instance
    host - The host
    port - The port
    Returns:
    The ChannelFuture
  - protected NettyPromise<HttpClientResponse> doRequest(io.netty.handler.codec.http.HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)
  - grails.async.Promise<HttpClientResponse> get(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a GET request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - grails.async.Promise<HttpClientResponse> head(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a HEAD request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - protected io.netty.util.concurrent.Promise newPromise(io.netty.channel.ChannelFuture channelFuture)
  - grails.async.Promise<HttpClientResponse> options(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a OPTIONS request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - grails.async.Promise<HttpClientResponse> patch(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a PATCH request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - grails.async.Promise<HttpClientResponse> post(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a POST request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse
  - grails.async.Promise<HttpClientResponse> put(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)
    
    Executes a PUT request to the given URI with an optional customizer
    Parameters:
    uri - The URI
    customizer - The customizer
    Returns:
    A Promise to return a HttpClientResponse

Groovy Documentation

[Groovy] Class AsyncHttpBuilder

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected final io.netty.bootstrap.Bootstrap bootstrap

protected final io.netty.channel.EventLoopGroup group

Property Detail

final java.nio.charset.Charset charset

final Configuration configuration

Constructor Detail

AsyncHttpBuilder(Configuration configuration = new DefaultConfiguration()

Method Detail

protected NettyPromise<HttpClientResponse> buildPromise(io.netty.util.concurrent.Promise promise)

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

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

grails.async.Promise<HttpClientResponse> delete(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

protected io.netty.channel.ChannelFuture doConnect(java.net.URI uri, io.netty.handler.ssl.SslContext sslCtx)

protected io.netty.channel.ChannelFuture doConnect(java.lang.String host, int port, io.netty.handler.ssl.SslContext sslCtx)

protected io.netty.channel.ChannelFuture doConnect(io.netty.bootstrap.Bootstrap bootstrap, java.lang.String host, int port)

protected NettyPromise<HttpClientResponse> doRequest(io.netty.handler.codec.http.HttpMethod httpMethod, groovy.lang.Closure customizer, java.lang.String uri)

grails.async.Promise<HttpClientResponse> get(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

grails.async.Promise<HttpClientResponse> head(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

protected io.netty.util.concurrent.Promise newPromise(io.netty.channel.ChannelFuture channelFuture)

grails.async.Promise<HttpClientResponse> options(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

grails.async.Promise<HttpClientResponse> patch(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

grails.async.Promise<HttpClientResponse> post(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)

grails.async.Promise<HttpClientResponse> put(java.lang.String uri, @groovy.lang.DelegatesTo(HttpRequestBuilder) groovy.lang.Closure customizer = null)