com.box.androidsdk.preview.cache

Class PreviewStorage

java.lang.Object

com.box.androidsdk.preview.cache.PreviewStorage

All Implemented Interfaces:

LRUStorageManagedDirectory.DeleteHandler, java.io.Serializable

public class PreviewStorage
extends java.lang.Object
implements java.io.Serializable, LRUStorageManagedDirectory.DeleteHandler

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PreviewStorage.NotifyingFileOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_CACHE_AGE Max cache age in days - Redefine this constant to change the default policy.
static long	MAX_CACHE_SIZE Max cache size in bytes - Redefine this constant to change the default policy.
protected java.io.File	mMetadataDirectory
protected java.io.File	mPreviewDirectory
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Long>	mRecentlyWrittenFiles
protected java.io.File	mThumbnailDirectory
protected static java.util.concurrent.atomic.AtomicLong	TEMP_COUNTER
protected java.lang.String	TEMP_EXTENSION

Constructor Summary

Constructors

Constructor and Description
PreviewStorage(BoxSession session)
PreviewStorage(BoxSession session, long maxCacheSize, int expirationDays) Default implementation of Serializable PreviewStorage

Method Summary

Modifier and Type	Method and Description
void	cacheMetadata(BoxItem boxItem, java.lang.String tag) Caches BoxItem metadata by writing the given object in a file.
void	clearCacheForFile(BoxFile fileInfo) Clears the storage of all files associated with the provided BoxFile
java.io.OutputStream	createPreviewOutputStream(BoxFile boxFile) This stream must be flushed upon successful completion.
java.io.OutputStream	createPreviewOutputStream(BoxFile boxFile, java.lang.String tag)
java.io.OutputStream	createThumbnailOutputStream(BoxFile boxFile) Deprecated.
java.io.OutputStream	createThumbnailOutputStream(BoxFile boxFile, java.lang.String tag)
java.io.InputStream	getCachedPreview(BoxFile boxFile) Deprecated.
java.io.InputStream	getCachedPreview(BoxFile boxFile, java.lang.String tag)
java.io.File	getCachedPreviewFile(BoxFile boxFile, java.lang.String tag)
java.io.InputStream	getCachedThumbnail(BoxFile boxFile) Deprecated.
java.io.InputStream	getCachedThumbnail(BoxFile boxFile, java.lang.String tag)
java.io.File	getCachedThumbnailFile(BoxFile boxFile, java.lang.String tag)
protected java.lang.String	getCacheName(BoxItem boxItem, java.lang.String tag, java.lang.String ext)
<T extends BoxItem> T	getMetadata(BoxItem boxItem, java.lang.String tag) Gets cached metadata for the given BoxItem.
protected java.io.File	getMetadataFile(BoxFile boxFile, java.lang.String tag)
protected java.io.File	getMetadataFile(BoxFolder boxFolder, java.lang.String tag)
protected java.io.File	getPreviewFile(BoxFile boxFile, java.lang.String tag)
protected java.io.File	getThumbnailFile(BoxFile boxFile, java.lang.String tag)
protected void	init(BoxSession session)
boolean	isThumbnailFilePresent(BoxFile boxFile)
boolean	isThumbnailFilePresent(BoxFile boxFile, java.lang.String tag)
void	onFileDeleted(java.io.File file, boolean deleteSuccessful)
boolean	shouldDelete(java.io.File file)

Methods inherited from class java.lang.Object

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

Field Detail

TEMP_COUNTER

protected static transient java.util.concurrent.atomic.AtomicLong TEMP_COUNTER

TEMP_EXTENSION

protected final java.lang.String TEMP_EXTENSION

See Also:

Constant Field Values

MAX_CACHE_SIZE

public static long MAX_CACHE_SIZE

Max cache size in bytes - Redefine this constant to change the default policy.

MAX_CACHE_AGE

public static int MAX_CACHE_AGE

Max cache age in days - Redefine this constant to change the default policy.

mRecentlyWrittenFiles

protected java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Long> mRecentlyWrittenFiles

mThumbnailDirectory

protected java.io.File mThumbnailDirectory

mPreviewDirectory

protected java.io.File mPreviewDirectory

mMetadataDirectory

protected java.io.File mMetadataDirectory

Constructor Detail

PreviewStorage

public PreviewStorage(BoxSession session,
                      long maxCacheSize,
                      int expirationDays)

Default implementation of Serializable PreviewStorage

Parameters:

session - - BoxSession from the content sdk after the user is authenticated

maxCacheSize - - Maximum size of the cache in bytes.

expirationDays - - Days beyond which files in cache can be cleared

PreviewStorage

public PreviewStorage(BoxSession session)

Method Detail

init

protected void init(BoxSession session)

shouldDelete

public boolean shouldDelete(java.io.File file)

Specified by:

shouldDelete in interface LRUStorageManagedDirectory.DeleteHandler

Parameters:

file - the file this class is planning to delete.

Returns:

true if the class should delete the file, false otherwise.

onFileDeleted

public void onFileDeleted(java.io.File file,
                          boolean deleteSuccessful)

Specified by:

onFileDeleted in interface LRUStorageManagedDirectory.DeleteHandler

Parameters:

file - the file this class attempted to delete.

deleteSuccessful - true if the file was successfully deleted, false if the delete failed.

getCachedPreview

@Deprecated
public java.io.InputStream getCachedPreview(BoxFile boxFile)

Deprecated.

getCachedPreview

public java.io.InputStream getCachedPreview(BoxFile boxFile,
                                            java.lang.String tag)

getCachedPreviewFile

public java.io.File getCachedPreviewFile(BoxFile boxFile,
                                         java.lang.String tag)

getCachedThumbnail

@Deprecated
public java.io.InputStream getCachedThumbnail(BoxFile boxFile)

Deprecated.

isThumbnailFilePresent

public boolean isThumbnailFilePresent(BoxFile boxFile)

isThumbnailFilePresent

public boolean isThumbnailFilePresent(BoxFile boxFile,
                                      java.lang.String tag)

getCachedThumbnail

public java.io.InputStream getCachedThumbnail(BoxFile boxFile,
                                              java.lang.String tag)

getCachedThumbnailFile

public java.io.File getCachedThumbnailFile(BoxFile boxFile,
                                           java.lang.String tag)

getPreviewFile

protected java.io.File getPreviewFile(BoxFile boxFile,
                                      java.lang.String tag)

getThumbnailFile

protected java.io.File getThumbnailFile(BoxFile boxFile,
                                        java.lang.String tag)

getMetadataFile

protected java.io.File getMetadataFile(BoxFile boxFile,
                                       java.lang.String tag)

getMetadataFile

protected java.io.File getMetadataFile(BoxFolder boxFolder,
                                       java.lang.String tag)

getCacheName

protected java.lang.String getCacheName(BoxItem boxItem,
                                        java.lang.String tag,
                                        java.lang.String ext)

createThumbnailOutputStream

@Deprecated
public java.io.OutputStream createThumbnailOutputStream(BoxFile boxFile)

Deprecated.

This stream must be flushed upon successful completion.

Parameters:

boxFile - the box file to get stream for.

Returns:

an outputstream that writes to a file associated with the given boxFile. Until flushed it cannot be retrieved.

createThumbnailOutputStream

public java.io.OutputStream createThumbnailOutputStream(BoxFile boxFile,
                                                        java.lang.String tag)

createPreviewOutputStream

public java.io.OutputStream createPreviewOutputStream(BoxFile boxFile)

This stream must be flushed upon successful completion.

Parameters:

boxFile - the box file to get stream for.

Returns:

an outputstream that writes to a file associated with the given boxFile. Until flushed it cannot be retrieved.

createPreviewOutputStream

public java.io.OutputStream createPreviewOutputStream(BoxFile boxFile,
                                                      java.lang.String tag)

cacheMetadata

public void cacheMetadata(BoxItem boxItem,
                          java.lang.String tag)

Caches BoxItem metadata by writing the given object in a file.

Parameters:

boxItem - Given BoxItem object

tag - Metadata identifier

getMetadata

public <T extends BoxItem> T getMetadata(BoxItem boxItem,
                                         java.lang.String tag)

Gets cached metadata for the given BoxItem.

Parameters:

boxItem - Input Box item

tag - Metadata identifier

Returns:

Metadata

clearCacheForFile

public void clearCacheForFile(BoxFile fileInfo)

Clears the storage of all files associated with the provided BoxFile

Parameters:

fileInfo - The BoxFile of the files that should be removed