com.hannesdorfmann.httpkit.request.multi

Class HttpMultiRequest

java.lang.Object

com.hannesdorfmann.httpkit.request.multi.HttpMultiRequest

All Implemented Interfaces:

HttpResponseReceiver<Object>

Direct Known Subclasses:

HttpMultiResponseWorker

public class HttpMultiRequest
extends Object
implements HttpResponseReceiver<Object>

A HttpMultiRequest executes arbitrary many (but more than 1 required) HttpRequests and waits for therer responses before the HttpMultiResponseReceiver gets notified about the success by calling HttpMultiResponseReceiver.onSuccessful(HttpResponse...). The order of the responses is equivalent to the order of HttpRequests. If one HttpRequest will fail then the complete HttpMultiRequest will fail by calling HttpMultiResponseReceiver.onFailure(HttpRequest, Exception)

Author:

Hannes Dorfmann

Constructor Summary

Constructors

Constructor and Description
HttpMultiRequest(HttpKit httpKit) Creates a new HttpMultiRequest but does not start it
HttpMultiRequest(HttpKit httpKit, HttpMultiResponseReceiver receiver, HttpRequest... requests) Creates a new HttpMultiRequest with the given parameters and starts it
HttpMultiRequest(HttpKit httpKit, HttpMultiResponseReceiver receiver, List<HttpRequest> requests) Creates a new HttpMultiRequest with the given parameters and starts it

Method Summary

Methods

Modifier and Type	Method and Description
<T> HttpResponse<T>	getResponse(int index) Get the responses according the index (0...n), where the index is equivalent to the order of the requ
void	onFailure(HttpRequest req, Exception e) Called when the http request could not be executed successfully, because an Exception has occurred while sending the http request
void	onSuccess(HttpResponse<Object> res) Called when the Http request has returned a result
HttpMultiRequest	setResponseReceiver(HttpMultiResponseReceiver receiver)
void	start(HttpRequest... requests)
void	start(List<HttpRequest> requests) Start

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpMultiRequest

public HttpMultiRequest(HttpKit httpKit,
                HttpMultiResponseReceiver receiver,
                HttpRequest... requests)

Creates a new HttpMultiRequest with the given parameters and starts it

HttpMultiRequest

public HttpMultiRequest(HttpKit httpKit,
                HttpMultiResponseReceiver receiver,
                List<HttpRequest> requests)

Creates a new HttpMultiRequest with the given parameters and starts it

HttpMultiRequest

public HttpMultiRequest(HttpKit httpKit)

Creates a new HttpMultiRequest but does not start it

Method Detail

setResponseReceiver

public HttpMultiRequest setResponseReceiver(HttpMultiResponseReceiver receiver)

start

public void start(HttpRequest... requests)

start

public void start(List<HttpRequest> requests)

Start

getResponse

public <T> HttpResponse<T> getResponse(int index)

Get the responses according the index (0...n), where the index is equivalent to the order of the requ

onSuccess

public void onSuccess(HttpResponse<Object> res)

Description copied from interface: HttpResponseReceiver

Called when the Http request has returned a result

Specified by:

onSuccess in interface HttpResponseReceiver<Object>

onFailure

public void onFailure(HttpRequest req,
             Exception e)

Description copied from interface: HttpResponseReceiver

Called when the http request could not be executed successfully, because an Exception has occurred while sending the http request

Specified by:

onFailure in interface HttpResponseReceiver<Object>

Parameters:

req - The HttpRequest that have caused the error

e - The exception that was thrown while executing the HttpRequest