com.ning.http.client

Class AsyncCompletionHandler<T>

java.lang.Object

com.ning.http.client.AsyncCompletionHandler<T>

Type Parameters:

T - Type of the value that will be returned by the associated Future

All Implemented Interfaces:

com.ning.http.client.AsyncHandler<T>, com.ning.http.client.ProgressAsyncHandler<T>

Direct Known Subclasses:

AsyncCompletionHandlerBase

public abstract class AsyncCompletionHandler<T>
extends Object
implements com.ning.http.client.AsyncHandler<T>, com.ning.http.client.ProgressAsyncHandler<T>

An AsyncHandler augmented with an onCompleted(Response) convenience method which gets called when the Response processing is finished. This class also implement the ProgressAsyncHandler callback, all doing nothing except returning AsyncHandler.STATE.CONTINUE

This is a modified version from the original file from AHC, where the only change is making the logger static.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ning.http.client.AsyncHandler

com.ning.http.client.AsyncHandler.STATE

Constructor Summary

Constructors

Constructor and Description
AsyncCompletionHandler()

Method Summary

Methods

Modifier and Type	Method and Description
com.ning.http.client.AsyncHandler.STATE	onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart content)
T	onCompleted()
abstract T	onCompleted(com.ning.http.client.Response response) Invoked once the HTTP response processing is finished.
com.ning.http.client.AsyncHandler.STATE	onContentWriteCompleted() Invoked when the content (a File, String or FileInputStream has been fully written on the I/O socket.
com.ning.http.client.AsyncHandler.STATE	onContentWriteProgress(long amount, long current, long total) Invoked when the I/O operation associated with the Request body as been progressed.
com.ning.http.client.AsyncHandler.STATE	onHeadersReceived(com.ning.http.client.HttpResponseHeaders headers)
com.ning.http.client.AsyncHandler.STATE	onHeaderWriteCompleted() Invoked when the content (a File, String or FileInputStream has been fully written on the I/O socket.
com.ning.http.client.AsyncHandler.STATE	onStatusReceived(com.ning.http.client.HttpResponseStatus status)
void	onThrowable(Throwable t)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCompletionHandler

public AsyncCompletionHandler()

Method Detail

onBodyPartReceived

public com.ning.http.client.AsyncHandler.STATE onBodyPartReceived(com.ning.http.client.HttpResponseBodyPart content)
                                                           throws Exception

Specified by:

onBodyPartReceived in interface com.ning.http.client.AsyncHandler<T>

Throws:

Exception

onStatusReceived

public com.ning.http.client.AsyncHandler.STATE onStatusReceived(com.ning.http.client.HttpResponseStatus status)
                                                         throws Exception

Specified by:

onStatusReceived in interface com.ning.http.client.AsyncHandler<T>

Throws:

Exception

onHeadersReceived

public com.ning.http.client.AsyncHandler.STATE onHeadersReceived(com.ning.http.client.HttpResponseHeaders headers)
                                                          throws Exception

Specified by:

onHeadersReceived in interface com.ning.http.client.AsyncHandler<T>

Throws:

Exception

onCompleted

public final T onCompleted()
                    throws Exception

Specified by:

onCompleted in interface com.ning.http.client.AsyncHandler<T>

Throws:

Exception

onThrowable

public void onThrowable(Throwable t)

Specified by:

onThrowable in interface com.ning.http.client.AsyncHandler<T>

onCompleted

public abstract T onCompleted(com.ning.http.client.Response response)
                       throws Exception

Invoked once the HTTP response processing is finished.

Gets always invoked as last callback method.

Parameters:

response - The Response

Returns:

T Value that will be returned by the associated Future

Throws:

Exception - if something wrong happens

onHeaderWriteCompleted

public com.ning.http.client.AsyncHandler.STATE onHeaderWriteCompleted()

Invoked when the content (a File, String or FileInputStream has been fully written on the I/O socket.

Specified by:

onHeaderWriteCompleted in interface com.ning.http.client.ProgressAsyncHandler<T>

Returns:

a AsyncHandler.STATE telling to CONTINUE or ABORT the current processing.

onContentWriteCompleted

public com.ning.http.client.AsyncHandler.STATE onContentWriteCompleted()

Invoked when the content (a File, String or FileInputStream has been fully written on the I/O socket.

Specified by:

onContentWriteCompleted in interface com.ning.http.client.ProgressAsyncHandler<T>

Returns:

a AsyncHandler.STATE telling to CONTINUE or ABORT the current processing.

onContentWriteProgress

public com.ning.http.client.AsyncHandler.STATE onContentWriteProgress(long amount,
                                                             long current,
                                                             long total)

Invoked when the I/O operation associated with the Request body as been progressed.

Specified by:

onContentWriteProgress in interface com.ning.http.client.ProgressAsyncHandler<T>

Parameters:

amount - The amount of bytes to transfer.

current - The amount of bytes transferred

total - The total number of bytes transferred

Returns:

a AsyncHandler.STATE telling to CONTINUE or ABORT the current processing.