com.jdroid.java.http.cache

Class CachedWebService

java.lang.Object

com.jdroid.java.http.cache.CachedWebService

All Implemented Interfaces:

EntityEnclosingWebService, WebService

public abstract class CachedWebService
extends Object
implements EntityEnclosingWebService

Field Summary

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

ACCEPT_ENCODING_HEADER, ACCEPT_HEADER, AMPERSAND, CONTENT_ENCODING_HEADER, CONTENT_TYPE_HEADER, EQUALS, GZIP_ENCODING, HTTP_PROTOCOL, HTTPS_PROTOCOL, QUESTION_MARK

Constructor Summary

Constructors

Constructor and Description
CachedWebService(WebService webService, Cache cache)
CachedWebService(WebService webService, Cache cache, CachingStrategy cachingStrategy)
CachedWebService(WebService webService, Cache cache, CachingStrategy cachingStrategy, Long timeToLive)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value)
void	addHttpWebServiceProcessor(HttpWebServiceProcessor httpWebServiceProcessor)
void	addQueryParameter(String name, Collection<?> values)
void	addQueryParameter(String name, Object value)
void	addUrlSegment(Object segment)
<T> T	execute()
<T> T	execute(Parser parser)
<T> T	executeRequest(Parser parser)
protected String	generateCacheFileName()
static String	generateCacheFileName(String key)
protected abstract File	getHttpCacheDirectory(Cache cache)
Long	getTimeToLive()
String	getUrl()
String	getUrlSuffix()
<T> T	readFromCache(Parser parser)
void	setConnectionTimeout(Integer connectionTimeout)
void	setEntity(String content)
void	setSsl(Boolean ssl)
void	setTimeToLive(Long timeToLive)
void	setUserAgent(String userAgent)

Methods inherited from class java.lang.Object

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

Constructor Detail

CachedWebService

public CachedWebService(WebService webService,
                Cache cache)

CachedWebService

public CachedWebService(WebService webService,
                Cache cache,
                CachingStrategy cachingStrategy)

CachedWebService

public CachedWebService(WebService webService,
                Cache cache,
                CachingStrategy cachingStrategy,
                Long timeToLive)

Method Detail

execute

public <T> T execute(Parser parser)

Specified by:

execute in interface WebService

Returns:

WebServiceResponse

See Also:

WebService.execute(com.jdroid.java.parser.Parser)

getHttpCacheDirectory

protected abstract File getHttpCacheDirectory(Cache cache)

execute

public <T> T execute()

Specified by:

execute in interface WebService

Returns:

WebServiceResponse

See Also:

WebService.execute()

readFromCache

public <T> T readFromCache(Parser parser)

executeRequest

public <T> T executeRequest(Parser parser)

generateCacheFileName

protected String generateCacheFileName()

generateCacheFileName

public static String generateCacheFileName(String key)

addHeader

public void addHeader(String name,
             String value)

Specified by:

addHeader in interface WebService

Parameters:

name - The header name.

value - The header value.

See Also:

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

addQueryParameter

public void addQueryParameter(String name,
                     Object value)

Specified by:

addQueryParameter in interface WebService

Parameters:

name - The parameter name.

value - The parameter value.

See Also:

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

addQueryParameter

public void addQueryParameter(String name,
                     Collection<?> values)

Specified by:

addQueryParameter in interface WebService

Parameters:

name - The parameter name.

values - The parameter values.

See Also:

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

addUrlSegment

public void addUrlSegment(Object segment)

Specified by:

addUrlSegment in interface WebService

Parameters:

segment - The segment name

See Also:

WebService.addUrlSegment(java.lang.Object)

addHttpWebServiceProcessor

public void addHttpWebServiceProcessor(HttpWebServiceProcessor httpWebServiceProcessor)

Specified by:

addHttpWebServiceProcessor in interface WebService

See Also:

WebService.addHttpWebServiceProcessor(com.jdroid.java.http.HttpWebServiceProcessor)

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

Specified by:

setConnectionTimeout in interface WebService

Parameters:

connectionTimeout - The connection timeout in milliseconds.

See Also:

WebService.setConnectionTimeout(java.lang.Integer)

setUserAgent

public void setUserAgent(String userAgent)

Specified by:

setUserAgent in interface WebService

Parameters:

userAgent - The user agent

See Also:

WebService.setUserAgent(java.lang.String)

setSsl

public void setSsl(Boolean ssl)

Specified by:

setSsl in interface WebService

See Also:

WebService.setSsl(java.lang.Boolean)

getUrl

public String getUrl()

Specified by:

getUrl in interface WebService

See Also:

WebService.getUrl()

getUrlSuffix

public String getUrlSuffix()

Specified by:

getUrlSuffix in interface WebService

See Also:

WebService.getUrlSuffix()

setEntity

public void setEntity(String content)

Specified by:

setEntity in interface EntityEnclosingWebService

See Also:

EntityEnclosingWebService.setEntity(java.lang.String)

setTimeToLive

public void setTimeToLive(Long timeToLive)

Parameters:

timeToLive - the timeToLive to set

getTimeToLive

public Long getTimeToLive()

Returns:

the timeToLive