com.atlassian.plugin.cache.filecache

Interface Cache

All Known Implementing Classes:

FileCacheImpl, PassThroughCache

public interface Cache

Represents a file cache.

Since:

2.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Cache.StreamProvider Interface used by the file caching system.
static interface	Cache.TwoStreamProvider Interface used by the file caching system.

Method Summary

Modifier and Type	Method and Description
void	cache(String bucket, String key, OutputStream out, Cache.StreamProvider provider) Stream the contents identified by the key to the destination stream.
void	cacheTwo(String bucket, String key, OutputStream out1, OutputStream out2, Cache.TwoStreamProvider provider) Stream two contents identified by the key to the destination stream.
void	clear() Remove all entries in the cache.

Method Detail

cache

void cache(String bucket,
           String key,
           OutputStream out,
           Cache.StreamProvider provider)

Stream the contents identified by the key to the destination stream. Should the contents not exist in the cache a new entry should be created if the implementation is a caching implementation.

Parameters:

bucket - bucket to group keys

key - can not be null

out - where to write the cached item to

provider - provides the underlying item on a cache-miss

cacheTwo

void cacheTwo(String bucket,
              String key,
              OutputStream out1,
              OutputStream out2,
              Cache.TwoStreamProvider provider)

Stream two contents identified by the key to the destination stream. Should the contents not exist in the cache a new entry should be created if the implementation is a caching implementation.

Parameters:

bucket - bucket to group keys

key - can not be null

out1 - where to write the first cached item to

out2 - where to write the second cached item to

provider - provides the underlying item on a cache-miss

Since:

3.3

clear

void clear()

Remove all entries in the cache.