groovyx.net.http

Class HttpConfigs.BaseResponse

java.lang.Object

groovyx.net.http.HttpConfigs.BaseResponse

All Implemented Interfaces:

ChainedHttpConfig.ChainedResponse, HttpConfig.Response

Direct Known Subclasses:

HttpConfigs.BasicResponse, HttpConfigs.ThreadSafeResponse

Enclosing class:

HttpConfigs

public abstract static class HttpConfigs.BaseResponse
extends java.lang.Object
implements ChainedHttpConfig.ChainedResponse

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Map<java.lang.Integer,java.util.function.BiFunction<FromServer,java.lang.Object,?>>	getByCode()
protected abstract java.util.function.BiFunction<FromServer,java.lang.Object,?>	getFailure()
ChainedHttpConfig.ChainedResponse	getParent()
protected abstract java.util.Map<java.lang.String,java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>>	getParserMap()
protected abstract java.util.function.BiFunction<FromServer,java.lang.Object,?>	getSuccess()
void	parser(java.lang.Iterable<java.lang.String> contentTypes, java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object> val) Used to specify a response parser (FromServer instance) for the specified content types, wrapped in a BiFunction.
java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object>	parser(java.lang.String contentType) Used to retrieve the parser configured for the specified content type.
void	parser(java.lang.String contentType, java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object> val) Used to specify a response parser (FromServer instance) for the specified content type, wrapped in a BiFunction.
abstract void	setType(java.lang.Class<?> type)
void	when(HttpConfig.Status status, java.util.function.BiFunction<FromServer,java.lang.Object,?> closure) Configures the execution of the provided function "when" the given status occurs in the response.
java.util.function.BiFunction<FromServer,java.lang.Object,?>	when(java.lang.Integer code) Used to retrieve the "when" function associated with the given status code.
void	when(java.lang.Integer code, java.util.function.BiFunction<FromServer,java.lang.Object,?> closure) Configures the execution of the provided function "when" the given status code occurs in the response.
void	when(java.lang.String code, java.util.function.BiFunction<FromServer,java.lang.Object,?> closure) Configures the execution of the provided function "when" the given status code (as a String) occurs in the response.

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, getException, getType

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

exception, exception, failure, failure, success, success, when, when, when

Constructor Detail

BaseResponse

protected BaseResponse(ChainedHttpConfig.ChainedResponse parent)

Method Detail

getByCode

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

getSuccess

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

getFailure

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

getParserMap

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

getParent

public ChainedHttpConfig.ChainedResponse getParent()

Specified by:

getParent in interface ChainedHttpConfig.ChainedResponse

when

public void when(java.lang.String code,
                 java.util.function.BiFunction<FromServer,java.lang.Object,?> closure)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function "when" the given status code (as a String) occurs in the response. The function will be called with an instance of the response as a FromServer instance and the response body as an Object (if there is one). 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-based configuration.

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

Specified by:

when in interface HttpConfig.Response

Parameters:

code - the response code as a String

closure - the function to be executed

when

public void when(java.lang.Integer code,
                 java.util.function.BiFunction<FromServer,java.lang.Object,?> closure)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function "when" the given status code occurs in the response. The function will be called with an instance of the response as a FromServer instance and the response body as an Object (if there is one). The value returned from the closure will be used as the result value of the request; this allows the closure to modify the captured response.

This method is generally used for Java-based configuration.

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

This method is the same as calling either the success(BiFunction) or failure(BiFunction) methods. Only one function may be mapped to each status.

Specified by:

when in interface HttpConfig.Response

Parameters:

code - the response code

closure - the function to be executed

when

public void when(HttpConfig.Status status,
                 java.util.function.BiFunction<FromServer,java.lang.Object,?> closure)

Description copied from interface: HttpConfig.Response

Configures the execution of the provided function "when" the given status occurs in the response. The function will be called with an instance of the response as a FromServer instance and the response body as an Object (if there is one). The value returned from the closure will be used as the result value of the request; this allows the closure to modify the captured response.

This method is generally used for Java-based configuration.

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

This method is the same as calling either the success(BiFunction) or failure(BiFunction) methods. Only one function may be mapped to each status.

Specified by:

when in interface HttpConfig.Response

Parameters:

status - the response HttpConfig.Status enum

closure - the function to be executed

when

public java.util.function.BiFunction<FromServer,java.lang.Object,?> when(java.lang.Integer code)

Description copied from interface: HttpConfig.Response

Used to retrieve the "when" function associated with the given status code.

Specified by:

when in interface HttpConfig.Response

Parameters:

code - the status code

Returns:

the mapped closure

parser

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

Description copied from interface: HttpConfig.Response

Used to retrieve the parser configured for the specified content type.

Specified by:

parser in interface HttpConfig.Response

Parameters:

contentType - the content type

Returns:

the mapped parser as a FromServer instance wrapped in a function object

parser

public void parser(java.lang.String contentType,
                   java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object> val)

Description copied from interface: HttpConfig.Response

Used to specify a response parser (FromServer instance) for the specified content type, wrapped in a BiFunction.

Specified by:

parser in interface HttpConfig.Response

Parameters:

contentType - the content type where the parser will be applied

val - the parser wrapped in a function object

parser

public void parser(java.lang.Iterable<java.lang.String> contentTypes,
                   java.util.function.BiFunction<ChainedHttpConfig,FromServer,java.lang.Object> val)

Description copied from interface: HttpConfig.Response

Used to specify a response parser (FromServer instance) for the specified content types, wrapped in a BiFunction.

Specified by:

parser in interface HttpConfig.Response

Parameters:

contentTypes - the contents type where the parser will be applied

val - the parser wrapped in a function object

setType

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