org.aerogear.mobile.core.http

Interface HttpResponse

public interface HttpResponse

Generic interface for responses from HTTP Services. Concrete classes will have the handle Android's threading mechanisms.

Method Summary

Modifier and Type	Method and Description
java.lang.Exception	getError() Returns the request error if it failed
int	getStatus() Returns the HTTP status code of the response.
HttpResponse	onComplete(java.lang.Runnable runnable) Creates a callback to be called when the response is finished (successful or unsuccessful).
HttpResponse	onError(java.lang.Runnable runnable) Creates a callback to be called when the request has failed.
HttpResponse	onSuccess(java.lang.Runnable runnable) Creates a callback to be called when the request has succeeded.
java.lang.String	stringBody() Blocks and then returns the response from the server
void	waitForCompletionAndClose() This is a terminal method that will block the thread called on until the http request has been processed.

Method Detail

onComplete

HttpResponse onComplete(java.lang.Runnable runnable)

Creates a callback to be called when the response is finished (successful or unsuccessful). This will be called, even if success and error handlers are registered. onComplete will be called last. The response is delivered immediately if the request has already been finished.

Parameters:

runnable - a callback method

Returns:

the instance of the HttpResponse for API chaining

onError

HttpResponse onError(java.lang.Runnable runnable)

Creates a callback to be called when the request has failed. This will be triggered when the request could not be sent or no response can be received.

Parameters:

runnable - a callback method

Returns:

the instance of the HttpResponse for API chaining

onSuccess

HttpResponse onSuccess(java.lang.Runnable runnable)

Creates a callback to be called when the request has succeeded. This will be triggered when the request succeeded and received a non-error status code.

Parameters:

runnable - a callback method

Returns:

the instance of the HttpResponse for API chaining

getStatus

int getStatus()

Returns the HTTP status code of the response.

Returns:

the status code.

waitForCompletionAndClose

void waitForCompletionAndClose()

This is a terminal method that will block the thread called on until the http request has been processed.

stringBody

java.lang.String stringBody()

Blocks and then returns the response from the server

Returns:

the body as a string.

getError

java.lang.Exception getError()

Returns the request error if it failed

Returns:

Exception request error or null