public final class CachedDataService

Object
ConnectionRequest
CachedDataService

Simple service that allows downloading and caching data locally. When the data is requested again the server is queried with a conditional get query.

Methods

`public static void register()`	Makes sure the cached data class is properly registered as an externalizable.
`public static void updateData(CachedData d, ActionListener callback)`	Checks that the cached data is up to date and if a newer version exits it updates the data in place
`public boolean equals(Object o)`	Indicates whether some other object is “equal to” this one.
`public int hashCode()`	Returns a hash code value for the object.
`protected void handleException(Exception err)`	Handles an exception thrown when performing a network operation, the default implementation shows a retry dialog.
`protected void handleErrorResponseCode(int code,` `String message)`	Handles a server response code that is not 200 and not a redirect (unless redirect handling is disabled)
`protected void readHeaders(Object connection) throws IOException`	Allows reading the headers from the connection by calling the getHeader() method.
`protected void readResponse(InputStream input) throws IOException`	Callback for the server response with the input stream from the server.

Inherited nested types

From ConnectionRequest

ConnectionRequest.CachingMode, ConnectionRequest.SSLCertificate

Inherited fields

From ConnectionRequest

PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_NORMAL, PRIORITY_LOW, PRIORITY_REDUNDANT

Inherited methods

From ConnectionRequest

getDefaultCacheMode, setDefaultCacheMode, isReadResponseForErrorsDefault, setReadResponseForErrorsDefault, isHandleErrorCodesInGlobalErrorHandler, setHandleErrorCodesInGlobalErrorHandler, getCookieHeader, setCookieHeader, isCookiesEnabledDefault, setCookiesEnabledDefault, isDefaultFollowRedirects, setDefaultFollowRedirects, isReadTimeoutSupported, purgeCacheDirectory, getDefaultUserAgent, setDefaultUserAgent, setUseNativeCookieStore, isNativeCookieSharingSupported, fetchJSON, fetchJSONAsync, getCacheMode, setCacheMode, isCheckSSLCertificates, setCheckSSLCertificates, isInsecure, setInsecure, getResponseData, getHttpMethod, setHttpMethod, addRequestHeader, removeRequestHeader, removeRequestHeaderIfUnchanged, checkSSLCertificates, getReadTimeout, setReadTimeout, initConnection, getCachedData, purgeCache, cacheUnmodified, cookieReceived, cookieSent, initCookieHeader, getResponseCode, getResposeCode, shouldConvertPostToGetOnRedirect, readErrorCodeHeaders, getHeader, getHeaders, getHeaderFieldNames, getYield, shouldAutoCloseResponse, handleIOException, handleRuntimeException, canGetSSLCertificates, getSSLCertificates, retry, onRedirect, postResponse, createRequestURL, buildRequestBody, shouldWriteUTFAsGetBytes, kill, shouldStop, isPausable, pause, resume, isPost, setPost, addArgument, removeArgument, removeAllArguments, addArgumentNoEncoding, addArgumentNoEncoding, addArgumentNoEncodingArray, addArgument, addArgumentArray, addArgument, addArguments, getContentType, setContentType, isWriteRequest, setWriteRequest, isReadRequest, setReadRequest, isPaused, setPaused, isKilled, setKilled, getPriority, setPriority, getUserAgent, setUserAgent, isFollowRedirects, setFollowRedirects, getTimeout, setTimeout, getContentLength, ioStreamUpdate, getUrl, setUrl, addResponseListener, removeResponseListener, addResponseCodeListener, addExceptionListener, removeResponseCodeListener, removeExceptionListener, hasResponseListeners, fireResponseListener, isDuplicateSupported, setDuplicateSupported, validate, getDisposeOnCompletion, setDisposeOnCompletion, getShowOnInit, setShowOnInit, getSilentRetryCount, setSilentRetryCount, isFailSilently, setFailSilently, isReadResponseForErrors, setReadResponseForErrors, getResponseContentType, isRedirecting, getDestinationFile, setDestinationFile, getDestinationStorage, setDestinationStorage, isCookiesEnabled, setCookiesEnabled, setChunkedStreamingMode, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToStorage, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, downloadImageToFileSystem, getRequestBody, setRequestBody, setRequestBody, getRequestBodyData, getResponseErrorMessage

From Object

getClass, notify, notifyAll, toString, wait, wait, wait, clone

Method details

register

public static void register()

Makes sure the cached data class is properly registered as an externalizable. This must be invoked for caching to work

updateData

public static void updateData(CachedData d, ActionListener callback)

Checks that the cached data is up to date and if a newer version exits it updates the data in place

Parameters

d CachedData: the data to check
callback ActionListener: optional callback to be invoked on request completion

equals

public boolean equals(Object o)

Indicates whether some other object is “equal to” this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

hashCode

public int hashCode()

Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

handleException

protected void handleException(Exception err)

Handles an exception thrown when performing a network operation, the default implementation shows a retry dialog.

Parameters

err Exception: the exception thrown

handleErrorResponseCode

protected void handleErrorResponseCode(int code, String message)

Handles a server response code that is not 200 and not a redirect (unless redirect handling is disabled)

Parameters

code int: the response code from the server
message String: the response message from the server

readHeaders

protected void readHeaders(Object connection)
throws IOException

Allows reading the headers from the connection by calling the getHeader() method.

Parameters

connection Object: used when invoking getHeader

Throws

java.io.IOException: thrown on failure

readResponse

protected void readResponse(InputStream input)
throws IOException

Callback for the server response with the input stream from the server. This method is invoked on the network thread

Parameters

input InputStream: the input stream containing the response

Throws

IOException: when a read input occurs