groovyx.net.http

Class OkHttpBuilder

java.lang.Object

groovyx.net.http.HttpBuilder

groovyx.net.http.OkHttpBuilder

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class OkHttpBuilder
extends HttpBuilder

HttpBuilder implementation based on the OkHttp client library.

Generally, this class should not be used directly, the preferred method of instantiation is via one of the two static configure() methods of this class or using one of the configure methods of HttpBuilder with a factory function for this builder.

Nested Class Summary

Nested classes/interfaces inherited from class groovyx.net.http.HttpBuilder

HttpBuilder.ResponseHandlerFunction

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OkHttpBuilder(HttpObjectConfig config)

Method Summary

Modifier and Type	Method and Description
void	close()
static HttpBuilder	configure(Closure closure) Creates an HttpBuilder using the OkHttpBuilder factory instance configured with the provided configuration closure.
static HttpBuilder	configure(java.util.function.Consumer<HttpObjectConfig> configuration) Creates an HttpBuilder using the OkHttpBuilder factory instance configured with the provided configuration function.
protected java.lang.Object	doDelete(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doGet(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doHead(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doOptions(ChainedHttpConfig config)
protected java.lang.Object	doPatch(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doPost(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doPut(ChainedHttpConfig chainedConfig)
protected java.lang.Object	doTrace(ChainedHttpConfig config)
java.lang.Object	getClientImplementation() Retrieves the internal client implementation as an OkHttpClient instance.
java.util.concurrent.Executor	getExecutor()
protected ChainedHttpConfig	getObjectConfig()

Methods inherited from class groovyx.net.http.HttpBuilder

addCookieStore, configure, configure, configure, cookies, cookiesToAdd, delete, delete, delete, delete, delete, deleteAsync, deleteAsync, deleteAsync, deleteAsync, deleteAsync, findCause, get, get, get, get, get, getAsync, getAsync, getAsync, getAsync, getAsync, getCookieManager, getCookieStore, handleException, head, head, head, head, head, headAsync, headAsync, headAsync, headAsync, headAsync, options, options, options, options, options, optionsAsync, optionsAsync, optionsAsync, optionsAsync, optionsAsync, patch, patch, patch, patch, patch, patchAsync, patchAsync, patchAsync, patchAsync, patchAsync, post, post, post, post, post, postAsync, postAsync, postAsync, postAsync, postAsync, put, put, put, put, put, putAsync, putAsync, putAsync, putAsync, putAsync, trace, trace, trace, trace, trace, traceAsync, traceAsync, traceAsync, traceAsync, traceAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OkHttpBuilder

protected OkHttpBuilder(HttpObjectConfig config)

Method Detail

getClientImplementation

public java.lang.Object getClientImplementation()

Retrieves the internal client implementation as an OkHttpClient instance.

Specified by:

getClientImplementation in class HttpBuilder

Returns:

the reference to the internal client implementation as an OkHttpClient

configure

public static HttpBuilder configure(@DelegatesTo(value=HttpObjectConfig.class)
                                    Closure closure)

Creates an HttpBuilder using the OkHttpBuilder factory instance configured with the provided configuration closure.

The configuration closure delegates to the HttpObjectConfig interface, which is an extension of the HttpConfig interface - configuration properties from either may be applied to the global client configuration here. See the documentation for those interfaces for configuration property details.

def http = HttpBuilder.configure {
    request.uri = 'http://localhost:10101'
}

Parameters:

closure - the configuration closure (delegated to HttpObjectConfig)

Returns:

the configured HttpBuilder

configure

public static HttpBuilder configure(java.util.function.Consumer<HttpObjectConfig> configuration)

Creates an HttpBuilder using the OkHttpBuilder factory instance configured with the provided configuration function.

The configuration Consumer function accepts an instance of the HttpObjectConfig interface, which is an extension of the HttpConfig interface - configuration properties from either may be applied to the global client configuration here. See the documentation for those interfaces for configuration property details.

This configuration method is generally meant for use with standard Java.

HttpBuilder.configure(new Consumer<HttpObjectConfig>() {
public void accept(HttpObjectConfig config) {
    config.getRequest().setUri(format("http://localhost:%d", serverRule.getPort()));
}
});

Or, using lambda expressions:

HttpBuilder.configure(config -> {
    config.getRequest().setUri(format("http://localhost:%d", serverRule.getPort()));
});

Parameters:

configuration - the configuration function (accepting HttpObjectConfig)

Returns:

the configured HttpBuilder

getObjectConfig

protected ChainedHttpConfig getObjectConfig()

Specified by:

getObjectConfig in class HttpBuilder

getExecutor

public java.util.concurrent.Executor getExecutor()

Specified by:

getExecutor in class HttpBuilder

doGet

protected java.lang.Object doGet(ChainedHttpConfig chainedConfig)

Specified by:

doGet in class HttpBuilder

doHead

protected java.lang.Object doHead(ChainedHttpConfig chainedConfig)

Specified by:

doHead in class HttpBuilder

doPost

protected java.lang.Object doPost(ChainedHttpConfig chainedConfig)

Specified by:

doPost in class HttpBuilder

doPut

protected java.lang.Object doPut(ChainedHttpConfig chainedConfig)

Specified by:

doPut in class HttpBuilder

doPatch

protected java.lang.Object doPatch(ChainedHttpConfig chainedConfig)

Specified by:

doPatch in class HttpBuilder

doDelete

protected java.lang.Object doDelete(ChainedHttpConfig chainedConfig)

Specified by:

doDelete in class HttpBuilder

doOptions

protected java.lang.Object doOptions(ChainedHttpConfig config)

Specified by:

doOptions in class HttpBuilder

doTrace

protected java.lang.Object doTrace(ChainedHttpConfig config)

Specified by:

doTrace in class HttpBuilder

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException