com.github.leonardoxh.asyncokhttpclient

Class AsyncHttpResponse

java.lang.Object

com.github.leonardoxh.asyncokhttpclient.AsyncHttpResponse

Direct Known Subclasses:

JsonAsyncHttpResponse

public class AsyncHttpResponse
extends java.lang.Object

Retrive the response from the HttpURLConnection and send it to the relative callback like onSuccess, onError

See Also:

onSuccess(int, String), onError(Throwable, String), onStart(), onFinish()

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	FAIL Indicate the response has failed
protected static int	FINISH Indicate the response has finished (after onSuccess or onError)
protected static int	START Indicate the response has started
protected static int	SUCCESS Indicate the response has finished with success

Constructor Summary

Constructors

Constructor and Description
AsyncHttpResponse() Construct a new instance of AsyncHttpResponse

Method Summary

Methods

Modifier and Type	Method and Description
protected void	handleFailMessage(java.lang.Throwable error, java.lang.String responseBody) Handle the fail message and call the relative callback
boolean	handleMessage(Message message)
protected void	handleSuccessMessage(int statusCode, java.lang.String responseBody) Handle the success message and call the relative callback
protected Message	obtainMessage(int responseMessage, java.lang.Object response) Obtain a handler thread message to verify the results this method will always return a valid message
void	onError(java.lang.Throwable error, java.lang.String content) Callback that indicate the request has return error
void	onFinish() Callback that indicate the request has finished
void	onStart() Callback that indicate the request has started
void	onSuccess(int statusCode, java.lang.String content) Callback that indicate the request has this method returns the content of the response
protected void	sendEndMessage() Send the handle message that indicate the request has finished
protected void	sendFailMessage(java.lang.Throwable error, java.lang.String content) Send the fail message to the handler
protected void	sendMessage(Message message) Send a message over the handler, if the handler is null no problems it will recreate it
protected void	sendStartMessage() Send the handle message that indicate the request has started
protected void	sendSuccessMessage(int statusCode, java.lang.String responseBody) Send the success message to the handler

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

protected static final int SUCCESS

Indicate the response has finished with success

See Also:

Constant Field Values

FAIL

protected static final int FAIL

Indicate the response has failed

See Also:

Constant Field Values

START

protected static final int START

Indicate the response has started

See Also:

Constant Field Values

FINISH

protected static final int FINISH

Indicate the response has finished (after onSuccess or onError)

See Also:

Constant Field Values

Constructor Detail

AsyncHttpResponse

public AsyncHttpResponse()

Construct a new instance of AsyncHttpResponse

Method Detail

onStart

public void onStart()

Callback that indicate the request has started

onFinish

public void onFinish()

Callback that indicate the request has finished

onSuccess

public void onSuccess(int statusCode,
             java.lang.String content)

Callback that indicate the request has this method returns the content of the response

Parameters:

statusCode - the request status code normally 200 or 202

content - the request response body

onError

public void onError(java.lang.Throwable error,
           java.lang.String content)

Callback that indicate the request has return error

Parameters:

error - a Exception class that indicate the error

content - the page error content if available or null

See Also:

HttpRetryException

sendSuccessMessage

protected void sendSuccessMessage(int statusCode,
                      java.lang.String responseBody)

Send the success message to the handler

Parameters:

statusCode - the success request status code (normally 200 or 202)

responseBody - the response body of the request (if any) or null

sendFailMessage

protected void sendFailMessage(java.lang.Throwable error,
                   java.lang.String content)

Send the fail message to the handler

Parameters:

error - the detail exception error

content - the request response body (if any) or null

sendStartMessage

protected void sendStartMessage()

Send the handle message that indicate the request has started

sendEndMessage

protected void sendEndMessage()

Send the handle message that indicate the request has finished

handleSuccessMessage

protected void handleSuccessMessage(int statusCode,
                        java.lang.String responseBody)

Handle the success message and call the relative callback

Parameters:

statusCode - the request response status code

responseBody - the request response body (if any) or null

handleFailMessage

protected void handleFailMessage(java.lang.Throwable error,
                     java.lang.String responseBody)

Handle the fail message and call the relative callback

Parameters:

error - the detail exception

responseBody - the response body of the request (if any) or null

See Also:

onError(Throwable, String)

handleMessage

public boolean handleMessage(Message message)

sendMessage

protected void sendMessage(Message message)

Send a message over the handler, if the handler is null no problems it will recreate it

Parameters:

message - the message for send, can't be null

obtainMessage

protected Message obtainMessage(int responseMessage,
                    java.lang.Object response)

Obtain a handler thread message to verify the results this method will always return a valid message

Parameters:

responseMessage - the response message identifier

response - the response object to describle this message

Returns:

a valid thread message based on the given parameters