groovyx.net.http

Class HttpConfigs.BasicResponse

java.lang.Object

groovyx.net.http.HttpConfigs.BaseResponse

groovyx.net.http.HttpConfigs.BasicResponse

All Implemented Interfaces:

ChainedHttpConfig.ChainedResponse, HttpConfig.Response

Enclosing class:

HttpConfigs

public static class HttpConfigs.BasicResponse
extends HttpConfigs.BaseResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicResponse(ChainedHttpConfig.ChainedResponse parent)

Method Summary

Modifier and Type	Method and Description
void	exception(java.util.function.Function<java.lang.Throwable,?> val) Configures the execution of the provided function to handle exceptions during request/response processing.
void	failure(java.util.function.BiFunction<FromServer,java.lang.Object,?> val) Configures the execution of the provided function "when" a failure response is received (code >= 400).
protected java.util.Map<java.lang.Integer,java.util.function.BiFunction<FromServer,java.lang.Object,?>>	getByCode()
java.util.function.Function<java.lang.Throwable,?>	getException()
protected java.util.function.BiFunction<FromServer,java.lang.Object,?>	getFailure()
java.util.Map<java.lang.String,java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>>	getParserMap()
protected java.util.function.BiFunction<FromServer,java.lang.Object,?>	getSuccess()
java.lang.Class<?>	getType()
void	setType(java.lang.Class<?> val)
void	success(java.util.function.BiFunction<FromServer,java.lang.Object,?> val) Configures the execution of the provided function when a success response is received (code < 400).

Methods inherited from class groovyx.net.http.HttpConfigs.BaseResponse

getParent, parser, parser, parser, when, when, when, when

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovyx.net.http.ChainedHttpConfig.ChainedResponse

actualAction, actualException, actualParser

Methods inherited from interface groovyx.net.http.HttpConfig.Response

exception, failure, success, when, when, when

Constructor Detail

BasicResponse

protected BasicResponse(ChainedHttpConfig.ChainedResponse parent)

Method Detail

getParserMap

public java.util.Map<java.lang.String,java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>> getParserMap()

Specified by:

getParserMap in class HttpConfigs.BaseResponse

getByCode

protected java.util.Map<java.lang.Integer,java.util.function.BiFunction<FromServer,java.lang.Object,?>> getByCode()

Specified by:

getByCode in class HttpConfigs.BaseResponse

getSuccess

protected java.util.function.BiFunction<FromServer,java.lang.Object,?> getSuccess()

Specified by:

getSuccess in class HttpConfigs.BaseResponse

getFailure

protected java.util.function.BiFunction<FromServer,java.lang.Object,?> getFailure()

Specified by:

getFailure in class HttpConfigs.BaseResponse

getException

public java.util.function.Function<java.lang.Throwable,?> getException()

success

public void success(java.util.function.BiFunction<FromServer,java.lang.Object,?> val)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function when a success response is received (code < 400). The function will be called with an instance of the response as a FromServer instance and the body content as an Object (if present). The value returned from the function will be used as the result value of the request; this allows the function to modify the captured response.

This method is generally used for Java-specific configuration.

HttpBuilder http = HttpBuilder.configure(config -> {
    config.getRequest().setUri("http://localhost:10101");
});
http.get( config -> {
    config.getRequest().getUri().setPath("/foo");
    config.getResponse().success(new BiFunction<FromServer, Object, Object>() {
         // executed when a success response is received
    });
});

This method is the same as calling either the when(Status.SUCCESS, BiFunction) method.

Parameters:

val - the closure to be executed

failure

public void failure(java.util.function.BiFunction<FromServer,java.lang.Object,?> val)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function "when" a failure response is received (code >= 400). The function will be called with an instance of the response as a FromServer instance and the body content as an Object (if present). The value returned from the function will be used as the result value of the request; this allows the function to modify the captured response.

This method is generally used for Java-specific configuration.

HttpBuilder http = HttpBuilder.configure(config -> {
    config.getRequest().setUri("http://localhost:10101");
});
http.get( config -> {
    config.getRequest().getUri().setPath("/foo");
    config.getResponse().failure(new BiFunction<FromServer, Object, Object>() {
         // executed when a failure response is received
    });
});

This method is the same as calling either the when(Status.FAILURE, BiFunction) method.

Parameters:

val - the closure to be executed

exception

public void exception(java.util.function.Function<java.lang.Throwable,?> val)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function to handle exceptions during request/response processing. This is different from a failure condition because there is no response, no status code, no headers, etc. The function will be called with the best guess as to what was the original exception. Some attempts will be made to unwrap exceptions that are of type TransportingException or UndeclaredThrowableException.

The value returned from the function will be used as the result value of the request. Since there is no response body for the function to process, this usually means that the function should do one of three things: re-throw the exception or throw a wrapped version of the exception, return null, or return a predefined empty value.

This method is generally used for Java-specific configuration.

HttpBuilder http = HttpBuilder.configure(config -> {
    config.getRequest().setUri("http://localhost:10101");
});
http.get( config -> {
    config.getRequest().getUri().setPath("/foo");
    config.getResponse().exception((t) -> {
         t.printStackTrace();
         throw new RuntimeException(t);
    });
});

The built in exception method wraps the exception in a RuntimeException (if it is not already of that type) and rethrows.

Parameters:

val - the function to be executed

getType

public java.lang.Class<?> getType()

setType

public void setType(java.lang.Class<?> val)

Specified by:

setType in class HttpConfigs.BaseResponse