groovyx.net.http

Interface HttpObjectConfig.Execution

Enclosing interface:

HttpObjectConfig

public static interface HttpObjectConfig.Execution

The Execution configuration interface provides a means of configuring the execution-specific properties of the underlying HTTP client.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Executor	getExecutor() Retrieves the configured executor.
javax.net.ssl.HostnameVerifier	getHostnameVerifier() Used to retrieve the HostnameVerifier configured for the client.
java.util.EnumMap<HttpVerb,java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object>>	getInterceptors() Used to retrieve the interceptors configured.
int	getMaxThreads() Retrieves the configured max number of connection threads used by the client.
ProxyInfo	getProxyInfo()
javax.net.ssl.SSLContext	getSslContext() Retrieves the SSLContext configured for the underlying HTTP client.
void	interceptor(HttpVerb[] verbs, java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object> func) Configures an interceptor (similar to an Http Servlet filter) which allows operations to be performed before and after a request, even alteration of the data.
void	interceptor(HttpVerb verb, java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object> func) Configures an interceptor (similar to an Http Servlet filter) which allows operations to be performed before and after a request, even alteration of the data.
void	proxy(java.net.Proxy proxy, boolean secure) Configures proxy information for all requests using this client
void	proxy(java.lang.String host, int port, java.net.Proxy.Type type, boolean secure) Configures proxy information for all requests using this client
void	setExecutor(java.util.concurrent.Executor val) Specifies the executor to be used.
void	setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier) Specifies the HostnameVerifier to be used by the configured client (related to SSL).
void	setMaxThreads(int val) Specifies the maximum number of connection threads to be used by the client.
void	setSslContext(javax.net.ssl.SSLContext val) Specifies the SSLContext to be used by the configured client.

Method Detail

setMaxThreads

void setMaxThreads(int val)

Specifies the maximum number of connection threads to be used by the client.

Parameters:

val - the max thread count

getMaxThreads

int getMaxThreads()

Retrieves the configured max number of connection threads used by the client.

Returns:

the max thread count

setExecutor

void setExecutor(java.util.concurrent.Executor val)

Specifies the executor to be used.

Parameters:

val - the executor to be used

getExecutor

java.util.concurrent.Executor getExecutor()

Retrieves the configured executor.

Returns:

the executor

setSslContext

void setSslContext(javax.net.ssl.SSLContext val)

Specifies the SSLContext to be used by the configured client.

Parameters:

val - the SSLContext

setHostnameVerifier

void setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)

Specifies the HostnameVerifier to be used by the configured client (related to SSL).

Parameters:

verifier - the hostname verifier

getHostnameVerifier

javax.net.ssl.HostnameVerifier getHostnameVerifier()

Used to retrieve the HostnameVerifier configured for the client.

Returns:

the configured HostnameVerifier

getSslContext

javax.net.ssl.SSLContext getSslContext()

Retrieves the SSLContext configured for the underlying HTTP client.

Returns:

the configured SSLContext

interceptor

void interceptor(HttpVerb verb,
                 java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object> func)

Configures an interceptor (similar to an Http Servlet filter) which allows operations to be performed before and after a request, even alteration of the data.

long elapsed = configure {
     request.uri = 'http://localhost:10101/foo'
     execution.interceptor(GET) { ChainedHttpConfig cfg, Function<ChainedHttpConfig, Object> fx ->
         long started = System.currentTimeMillis()
         fx.apply(cfg)
         System.currentTimeMillis() - started
     }
}.get(Long, NO_OP)

The example above would return the elapsed time for the request as the result of the request.

Parameters:

verb - the HTTP verb to intercept

func - the interceptor function

interceptor

void interceptor(HttpVerb[] verbs,
                 java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object> func)

Configures an interceptor (similar to an Http Servlet filter) which allows operations to be performed before and after a request, even alteration of the data.

Parameters:

verbs - the HTTP verbs to intercept

func - the interceptor function

getInterceptors

java.util.EnumMap<HttpVerb,java.util.function.BiFunction<ChainedHttpConfig,java.util.function.Function<ChainedHttpConfig,java.lang.Object>,java.lang.Object>> getInterceptors()

Used to retrieve the interceptors configured.

Returns:

all interceptors

proxy

void proxy(java.net.Proxy proxy,
           boolean secure)

Configures proxy information for all requests using this client

Parameters:

proxy - the Proxy object used for configuring proxy connections

secure - some clients use this parameter to configure application level ssl proxying. If the client can determine the underlying protocol without issues this parameter will be ignored.

proxy

void proxy(java.lang.String host,
           int port,
           java.net.Proxy.Type type,
           boolean secure)
    throws java.net.UnknownHostException

Configures proxy information for all requests using this client

Parameters:

host - the host of the proxy. This can be either an ip address or a domain name.

port - the port of the proxy.

type - the type of the proxy.

secure - some clients use this parameter to configure application level ssl proxying. If the client can determine the underlying protocol without issues this parameter will be ignored.

Throws:

java.net.UnknownHostException

getProxyInfo

ProxyInfo getProxyInfo()