com.jdroid.java.http.cache

Class CachedHttpService

java.lang.Object

com.jdroid.java.http.cache.CachedHttpService

All Implemented Interfaces:

HttpService, BodyEnclosingHttpService

public abstract class CachedHttpService
extends java.lang.Object
implements BodyEnclosingHttpService

Field Summary

Fields inherited from interface com.jdroid.java.http.HttpService

ACCEPT_ENCODING_HEADER, ACCEPT_HEADER, ACCEPT_LANGUAGE_HEADER, AMPERSAND, CONTENT_ENCODING_HEADER, CONTENT_TYPE_HEADER, EQUALS, GZIP_ENCODING, HTTP_PROTOCOL, HTTP_SCHEME, HTTPS_PROTOCOL, QUESTION_MARK, USER_AGENT_HEADER

Constructor Summary

Constructors

Constructor and Description
CachedHttpService(HttpService httpService, Cache cache)
CachedHttpService(HttpService httpService, Cache cache, CachingStrategy cachingStrategy)
CachedHttpService(HttpService httpService, Cache cache, CachingStrategy cachingStrategy, java.lang.Long timeToLive)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(java.lang.String name, java.lang.String value)
void	addHttpServiceProcessor(HttpServiceProcessor httpServiceProcessor)
void	addQueryParameter(java.lang.String name, java.util.Collection<?> values)
void	addQueryParameter(java.lang.String name, java.lang.Object value)
void	addUrlSegment(java.lang.Object segment)
void	execute()
<T> T	execute(Parser parser)
<T> T	executeRequest(Parser parser)
protected java.lang.String	generateCacheFileName()
static java.lang.String	generateCacheFileName(java.lang.String key)
java.lang.String	getHeaderValue(java.lang.String key)
protected abstract java.io.File	getHttpCacheDirectory(Cache cache)
HttpResponseWrapper	getHttpResponseWrapper()
java.lang.Long	getTimeToLive()
java.lang.String	getUrl()
java.lang.String	getUrlSuffix()
<T> T	readFromCache(Parser parser)
void	setBody(java.lang.String body)
void	setConnectionTimeout(java.lang.Integer connectionTimeout)
void	setReadTimeout(java.lang.Integer readTimeout)
void	setSsl(java.lang.Boolean ssl)
void	setTimeToLive(java.lang.Long timeToLive)
void	setUserAgent(java.lang.String userAgent)
void	setWriteTimeout(java.lang.Integer writeTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedHttpService

public CachedHttpService(HttpService httpService,
                 Cache cache)

CachedHttpService

public CachedHttpService(HttpService httpService,
                 Cache cache,
                 CachingStrategy cachingStrategy)

CachedHttpService

public CachedHttpService(HttpService httpService,
                 Cache cache,
                 CachingStrategy cachingStrategy,
                 java.lang.Long timeToLive)

Method Detail

execute

public <T> T execute(Parser parser)

Specified by:

execute in interface HttpService

See Also:

HttpService.execute(Parser)

getHttpCacheDirectory

protected abstract java.io.File getHttpCacheDirectory(Cache cache)

execute

public void execute()

Specified by:

execute in interface HttpService

readFromCache

public <T> T readFromCache(Parser parser)

executeRequest

public <T> T executeRequest(Parser parser)

generateCacheFileName

protected java.lang.String generateCacheFileName()

generateCacheFileName

public static java.lang.String generateCacheFileName(java.lang.String key)

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

Specified by:

addHeader in interface HttpService

Parameters:

name - The header name.

value - The header value.

See Also:

HttpService.addHeader(java.lang.String, java.lang.String)

addQueryParameter

public void addQueryParameter(java.lang.String name,
                     java.lang.Object value)

Specified by:

addQueryParameter in interface HttpService

Parameters:

name - The parameter name.

value - The parameter value.

See Also:

HttpService.addQueryParameter(java.lang.String, java.lang.Object)

addQueryParameter

public void addQueryParameter(java.lang.String name,
                     java.util.Collection<?> values)

Specified by:

addQueryParameter in interface HttpService

Parameters:

name - The parameter name.

values - The parameter values.

See Also:

HttpService.addQueryParameter(java.lang.String, java.util.Collection)

addUrlSegment

public void addUrlSegment(java.lang.Object segment)

Specified by:

addUrlSegment in interface HttpService

Parameters:

segment - The segment name

See Also:

HttpService.addUrlSegment(java.lang.Object)

addHttpServiceProcessor

public void addHttpServiceProcessor(HttpServiceProcessor httpServiceProcessor)

Specified by:

addHttpServiceProcessor in interface HttpService

See Also:

HttpService.addHttpServiceProcessor(HttpServiceProcessor)

setConnectionTimeout

public void setConnectionTimeout(java.lang.Integer connectionTimeout)

Specified by:

setConnectionTimeout in interface HttpService

Parameters:

connectionTimeout - The connection timeout in milliseconds.

See Also:

HttpService.setConnectionTimeout(java.lang.Integer)

setReadTimeout

public void setReadTimeout(java.lang.Integer readTimeout)

Specified by:

setReadTimeout in interface HttpService

setWriteTimeout

public void setWriteTimeout(java.lang.Integer writeTimeout)

Specified by:

setWriteTimeout in interface HttpService

setUserAgent

public void setUserAgent(java.lang.String userAgent)

Specified by:

setUserAgent in interface HttpService

Parameters:

userAgent - The user agent

See Also:

HttpService.setUserAgent(java.lang.String)

setSsl

public void setSsl(java.lang.Boolean ssl)

Specified by:

setSsl in interface HttpService

See Also:

HttpService.setSsl(java.lang.Boolean)

getUrl

public java.lang.String getUrl()

Specified by:

getUrl in interface HttpService

See Also:

HttpService.getUrl()

getUrlSuffix

public java.lang.String getUrlSuffix()

Specified by:

getUrlSuffix in interface HttpService

See Also:

HttpService.getUrlSuffix()

setBody

public void setBody(java.lang.String body)

Specified by:

setBody in interface BodyEnclosingHttpService

See Also:

BodyEnclosingHttpService.setBody(String)

setTimeToLive

public void setTimeToLive(java.lang.Long timeToLive)

Parameters:

timeToLive - the timeToLive to set

getTimeToLive

public java.lang.Long getTimeToLive()

Returns:

the timeToLive

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String key)

Specified by:

getHeaderValue in interface HttpService

getHttpResponseWrapper

public HttpResponseWrapper getHttpResponseWrapper()

Specified by:

getHttpResponseWrapper in interface HttpService