com.hannesdorfmann.httpkit.threading

Class HttpClientTask<T>

java.lang.Object

com.hannesdorfmann.httpkit.threading.HttpClientTask<T>

Type Parameters:

T - The type of the result, that will be retrieved from webserver and passed back as HttpResponse in the HttpResponseReceiver

All Implemented Interfaces:

HttpRequest.CanceledListener, HttpRequest.PriorityChangedListener, HttpTask<T>, Comparable<HttpTask<?>>, Runnable

public class HttpClientTask<T>
extends Object
implements HttpTask<T>

A HttpTask that uses apaches HttpClient for retrieving / transmitting data from / to the web server

It supports:

• Reading e-Tag< and write then to cache
• charset encoding of the Content-Type Header field

Author:

Hannes Dorfmann

Nested Class Summary

Nested classes/interfaces inherited from interface com.hannesdorfmann.httpkit.threading.HttpTask

HttpTask.HttpTaskCanceledListener, HttpTask.HttpTaskFinishedListener, HttpTask.HttpTaskPriorityChangedListener, HttpTask.HttpTaskStartedListner

Constructor Summary

Constructors

Constructor and Description
HttpClientTask(HttpRequest request, HttpResponseReceiver<T> responseReceiver, org.apache.http.client.HttpClient httpClient, Cache<String,Object> cache)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort()
int	compareTo(HttpTask<?> another)
protected org.apache.http.client.methods.HttpUriRequest	generateHttpUriRequest(HttpRequest request) Generates a HTTP compatible HttpUriRequest from an HttpRequest
HttpRequest	getHttpRequest() Get the HttpRequest that is executed with this HttpTask
HttpResponseReceiver<T>	getHttpResponseReceiver() Get the HttpResponseReceiver
void	onHttpRequestCanceled(HttpRequest request) This method will be called to inform, when an HttpRequest has been canceled
void	onHttpRequestPriorityChanged(HttpRequest request, int newPriority) This method will be called, when an HttpRequest has changed his priority
HttpResponse<T>	processHttpRequest()
void	removeAllListeners() Release all registered Listeners, by setting them to null.
void	run()
void	setHttpTaskCanceledListener(HttpTask.HttpTaskCanceledListener listener) Sets the HttpTask.HttpTaskCanceledListener
void	setHttpTaskFinishedListener(HttpTask.HttpTaskFinishedListener listener) Sets the HttpTask.HttpTaskFinishedListener
void	setHttpTaskPriorityChangedListener(HttpTask.HttpTaskPriorityChangedListener listener) Sets the HttpTask.HttpTaskPriorityChangedListener
void	setHttpTaskStartedListener(HttpTask.HttpTaskStartedListner listner) Sets the HttpTask.HttpTaskStartedListner

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientTask

public HttpClientTask(HttpRequest request,
              HttpResponseReceiver<T> responseReceiver,
              org.apache.http.client.HttpClient httpClient,
              Cache<String,Object> cache)

Method Detail

run

public void run()

Specified by:

run in interface Runnable

getHttpResponseReceiver

public HttpResponseReceiver<T> getHttpResponseReceiver()

Description copied from interface: HttpTask

Get the HttpResponseReceiver

Specified by:

getHttpResponseReceiver in interface HttpTask<T>

Returns:

compareTo

public int compareTo(HttpTask<?> another)

Specified by:

compareTo in interface Comparable<HttpTask<?>>

setHttpTaskFinishedListener

public void setHttpTaskFinishedListener(HttpTask.HttpTaskFinishedListener listener)

Description copied from interface: HttpTask

Sets the HttpTask.HttpTaskFinishedListener

Specified by:

setHttpTaskFinishedListener in interface HttpTask<T>

getHttpRequest

public HttpRequest getHttpRequest()

Description copied from interface: HttpTask

Get the HttpRequest that is executed with this HttpTask

Specified by:

getHttpRequest in interface HttpTask<T>

Returns:

setHttpTaskStartedListener

public void setHttpTaskStartedListener(HttpTask.HttpTaskStartedListner listner)

Description copied from interface: HttpTask

Sets the HttpTask.HttpTaskStartedListner

Specified by:

setHttpTaskStartedListener in interface HttpTask<T>

onHttpRequestCanceled

public void onHttpRequestCanceled(HttpRequest request)

Description copied from interface: HttpRequest.CanceledListener

This method will be called to inform, when an HttpRequest has been canceled

Specified by:

onHttpRequestCanceled in interface HttpRequest.CanceledListener

onHttpRequestPriorityChanged

public void onHttpRequestPriorityChanged(HttpRequest request,
                                int newPriority)

Description copied from interface: HttpRequest.PriorityChangedListener

This method will be called, when an HttpRequest has changed his priority

Specified by:

onHttpRequestPriorityChanged in interface HttpRequest.PriorityChangedListener

See Also:

HttpRequest.setPriority(int)

setHttpTaskPriorityChangedListener

public void setHttpTaskPriorityChangedListener(HttpTask.HttpTaskPriorityChangedListener listener)

Description copied from interface: HttpTask

Sets the HttpTask.HttpTaskPriorityChangedListener

Specified by:

setHttpTaskPriorityChangedListener in interface HttpTask<T>

setHttpTaskCanceledListener

public void setHttpTaskCanceledListener(HttpTask.HttpTaskCanceledListener listener)

Description copied from interface: HttpTask

Sets the HttpTask.HttpTaskCanceledListener

Specified by:

setHttpTaskCanceledListener in interface HttpTask<T>

removeAllListeners

public void removeAllListeners()

Description copied from interface: HttpTask

Release all registered Listeners, by setting them to null. HttpTask.HttpTaskCanceledListener, HttpTask.HttpTaskFinishedListener, HttpTask.HttpTaskPriorityChangedListener, HttpTask.HttpTaskStartedListner

Specified by:

removeAllListeners in interface HttpTask<T>

abort

public void abort()

Specified by:

abort in interface HttpTask<T>

processHttpRequest

public HttpResponse<T> processHttpRequest()
                                   throws Exception

Throws:

Exception

generateHttpUriRequest

protected org.apache.http.client.methods.HttpUriRequest generateHttpUriRequest(HttpRequest request)
                                                                        throws Exception

Generates a HTTP compatible HttpUriRequest from an HttpRequest

Throws:

UnsupportedEncodingException

Exception