DefaultHttpKit (HttpKit 1.5.6 API)

java.lang.Object
- com.hannesdorfmann.httpkit.DefaultHttpKit

All Implemented Interfaces:

HttpKit
```
public class DefaultHttpKit
extends Object
implements HttpKit
```
This is the basic HttpKit implementation.

Restrictions:
- The DefaultHttpKit uses the same ParserWriters to parse data as the cache. Therefore DefaultHttpKit has not a own mime type - parser map, but uses Cache.getParserWriterPool()
- The DefaultHttpKit expects that every http response contains a correct mime type as content type. This mime type is used to find the correct parser for this
- CookieManager is only available for Android 9 (Gingerbread) and above. So Froyo will NOT use cookies.
- Permissions: INTERNET, ACCESS_NETWORK_STATE. If you use an DiskCache (like HybridCache does) you need also WRITE_EXTERNAL_STORAGE
Author:

Hannes Dorfmann

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class DefaultHttpKit.DefaultCacheRetriever<T>
This Runnable is responsible to load data from cache.

Nested Classes
Modifier and Type	Class and Description
`class`	`DefaultHttpKit.DefaultCacheRetriever<T>` This `Runnable` is responsible to load data from cache.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Cache<String,Object>`	`cache` The cache
`protected CacheRetrieverExecutor`	`cacheExecutor` The cache executor, that retrieve data from the cache asynchronously
`protected android.net.ConnectivityManager`	`connectivityManager`
`protected android.content.Context`	`context`
`protected org.apache.http.impl.client.AbstractHttpClient`	`httpClient` Apaches `HttpClient`
`protected HttpExecutor`	`httpExecutor` The http Executor, that will execute the `HttpRequest`s asynchronously
`protected android.os.Handler`	`uiThreadHandler` The handler to send the result back to the ui thread

Constructor Summary

Constructors
Constructor and Description

DefaultHttpKit(android.content.Context context)

DefaultHttpKit(android.content.Context context, String userAgent)

Constructors
Constructor and Description
`DefaultHttpKit(android.content.Context context)`
`DefaultHttpKit(android.content.Context context, String userAgent)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addParserWriter(String mimeType, ParserWriter<?> parser)` Adds a parser for the given mime type
`void`	`cancelAllOfOwner(Object owner)` Cancels all pending `HttpRequest` that were tagged
`<T> void`	`execute(HttpRequest request, HttpResponseReceiver<T> receiver)` Executes a `HttpRequest` with parsing the result according the returned mime type.
`android.content.Context`	`getApplicationContext()`
`Cache<String,Object>`	`getCache()` Get the cache that is uses
`org.apache.http.client.HttpClient`	`getHttpClient()`
`boolean`	`isNetworkAvailable()`
`void`	`removeParserWriter(String mimeType)` Removes the parser for the given mime type
`protected <T> void`	`scheduleHttpRequest(HttpRequest request, HttpResponseReceiver<T> receiver)` Schedules a HttpRequest to be executed to check the cache
`void`	`setCache(Cache<String,Object> cache)` Sets the internal cache
`void`	`setHttpExecutor(HttpExecutor executor)` Set the `HttpExecutor` for async http data transfer
`protected <T> void`	`startHttpRequestAsync(HttpRequest request, HttpResponseReceiver<T> receiver)` Starts the http request asynchronously in a new thread.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - cache
```
protected Cache<String,Object> cache
```
    The cache
  - context
```
protected final android.content.Context context
```
  - httpClient
```
protected final org.apache.http.impl.client.AbstractHttpClient httpClient
```
    Apaches HttpClient
  - uiThreadHandler
```
protected final android.os.Handler uiThreadHandler
```
    The handler to send the result back to the ui thread
  - httpExecutor
```
protected HttpExecutor httpExecutor
```
    The http Executor, that will execute the HttpRequests asynchronously
  - cacheExecutor
```
protected final CacheRetrieverExecutor cacheExecutor
```
    The cache executor, that retrieve data from the cache asynchronously
  - connectivityManager
```
protected final android.net.ConnectivityManager connectivityManager
```
- Constructor Detail
  - DefaultHttpKit
```
public DefaultHttpKit(android.content.Context context)
```
  - DefaultHttpKit
```
public DefaultHttpKit(android.content.Context context,
              String userAgent)
```
- Method Detail
  - setCache
```
public void setCache(Cache<String,Object> cache)
```
    Description copied from interface: HttpKit
    
    Sets the internal cache
    
    Specified by:
    
    setCache in interface HttpKit
  - getCache
```
public Cache<String,Object> getCache()
```
    Description copied from interface: HttpKit
    
    Get the cache that is uses
    
    Specified by:
    
    getCache in interface HttpKit
    
    Returns:
  - getHttpClient
```
public org.apache.http.client.HttpClient getHttpClient()
```
  - scheduleHttpRequest
```
protected <T> void scheduleHttpRequest(HttpRequest request,
                           HttpResponseReceiver<T> receiver)
```
    Schedules a HttpRequest to be executed to check the cache
  - addParserWriter
```
public void addParserWriter(String mimeType,
                   ParserWriter<?> parser)
```
    Description copied from interface: HttpKit
    
    Adds a parser for the given mime type
    
    Specified by:
    
    addParserWriter in interface HttpKit
    
    Parameters:
    mimeType - The mimetype. The passed parser will be used for this mime type
    parser - The parser
  - removeParserWriter
```
public void removeParserWriter(String mimeType)
```
    Description copied from interface: HttpKit
    
    Removes the parser for the given mime type
    
    Specified by:
    
    removeParserWriter in interface HttpKit
  - execute
```
public <T> void execute(HttpRequest request,
               HttpResponseReceiver<T> receiver)
```
    Description copied from interface: HttpKit
    
    Executes a HttpRequest with parsing the result according the returned mime type. To make this work it's necessary, that the server returns a correct mime type or was setted in the HttpRequest and that a parser has been added to this HttpKit for the returned mime type
    
    Specified by:
    
    execute in interface HttpKit
    
    See Also:
    HttpKit.addParserWriter(String, ParserWriter)
  - isNetworkAvailable
```
public boolean isNetworkAvailable()
```
  - setHttpExecutor
```
public void setHttpExecutor(HttpExecutor executor)
```
    Description copied from interface: HttpKit
    
    Set the HttpExecutor for async http data transfer
    
    Specified by:
    
    setHttpExecutor in interface HttpKit
  - startHttpRequestAsync
```
protected <T> void startHttpRequestAsync(HttpRequest request,
                             HttpResponseReceiver<T> receiver)
```
    Starts the http request asynchronously in a new thread. The http request will not be processed imidiatly, but will be submitted to the HttpExecutor
  - cancelAllOfOwner
```
public void cancelAllOfOwner(Object owner)
```
    Description copied from interface: HttpKit
    
    Cancels all pending HttpRequest that were tagged
    
    Specified by:
    
    cancelAllOfOwner in interface HttpKit
  - getApplicationContext
```
public android.content.Context getApplicationContext()
```

Class DefaultHttpKit

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cache

context

httpClient

uiThreadHandler

httpExecutor

cacheExecutor

connectivityManager

Constructor Detail

DefaultHttpKit

DefaultHttpKit

Method Detail

setCache

getCache

getHttpClient

scheduleHttpRequest

addParserWriter

removeParserWriter

execute

isNetworkAvailable

setHttpExecutor

startHttpRequestAsync

cancelAllOfOwner

getApplicationContext