Package org.sturrock.cassette.cassettej

Interface ContentAddressableStore

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ContentAddressableStoreFileImpl, ContentAddressableStoreImpl, ContentAddressableStoreInfinispanImpl

public interface ContentAddressableStore
extends AutoCloseable

Defines a content-addressable store

Method Summary

Modifier and Type	Method	Description
void	addListener(ContentAddressableStoreListener contentAddressableStoreListener)	Add a listener to this store.
void	close()
boolean	contains(Hash hash)	Check whether content exists in the store with the specified hash
boolean	contains(Hash hash, ContentEncoding contentEncoding)	Check whether content exists in the store with the specified hash with the specified encoding
boolean	delete(Hash hash)	Delete content from the store.
long	getContentLength(Hash hash)	Get the length of the content with the specified hash
long	getContentLength(Hash hash, ContentEncoding contentEncoding)	Get the length of the encoded content with the specified hash.
List<Hash>	getHashes()	Get a list of all hashes in the store.
InputStream	read(Hash hash)	Read content from the store.
InputStream	read(Hash hash, ContentEncoding contentEncoding)	Read content from the store, returning using the given encoding.
void	removeListener(ContentAddressableStoreListener contentAddressableStoreListener)	Remove a listener to this store.
Hash	write(InputStream stream)	Write content to the store, returning its hash.
Hash	write(InputStream stream, List<ContentEncoding> encodings)	Write content to the store in raw format and also formats specified in the ContentEncodings.

Method Detail

write

Hash write(InputStream stream)
    throws IOException

Write content to the store, returning its hash. If the store already contains this content, the write is discarded but the hash is returned as normal.

Parameters:

stream - Content to be written

Returns:

hash of content

Throws:

IOException

write

Hash write(InputStream stream,
           List<ContentEncoding> encodings)
    throws IOException

Write content to the store in raw format and also formats specified in the ContentEncodings. If encodings is null or an empty list then no encodings are used.

Parameters:

stream - Content to be written

Returns:

hash of (raw) content

Throws:

IOException

contains

boolean contains(Hash hash)

Check whether content exists in the store with the specified hash

Parameters:

hash - Hash of content to check

Returns:

true if content exists in the store with specified hash

contains

boolean contains(Hash hash,
                 ContentEncoding contentEncoding)

Check whether content exists in the store with the specified hash with the specified encoding

Parameters:

hash - Hash of content to check

contentEncoding - Type of encoding to use.

Returns:

true if content exists in the store with specified hash and specified encoding.

read

InputStream read(Hash hash)
          throws IOException

Read content from the store.

Parameters:

hash - The hash of the content to read.

Returns:

InputStream of content if content exists; otherwise null.

Throws:

IOException

read

InputStream read(Hash hash,
                 ContentEncoding contentEncoding)
          throws IOException

Read content from the store, returning using the given encoding.

Parameters:

hash - The hash of the (raw) content to read.

contentEncoding - Type of encoding to use to return the stream. If null then no encoding is used.

Returns:

InputStream of content if content exists; otherwise null.

Throws:

IOException

getContentLength

long getContentLength(Hash hash)
               throws IOException

Get the length of the content with the specified hash

Parameters:

hash - The hash of the content

Returns:

The length of the content, or -1 if no content with the specified hash exists.

Throws:

IOException

getContentLength

long getContentLength(Hash hash,
                      ContentEncoding contentEncoding)
               throws IOException

Get the length of the encoded content with the specified hash.

Parameters:

hash - The hash of the content

contentEncoding - The encoding type to use. If null then no encoding is used and the raw content is assumed.

Returns:

The length of the content, or -1 if no content with the specified hash exists.

Throws:

IOException

getHashes

List<Hash> getHashes()
              throws IOException

Get a list of all hashes in the store. The list is generated lazily by querying the filesystem, and thus will not behave deterministically if more content is added while this function is called.

Returns:

List of hashes in the store.

Throws:

IOException

delete

boolean delete(Hash hash)
        throws IOException

Delete content from the store.

Parameters:

hash - Hash of content to delete

Returns:

true if the content existed and was deleted; otherwise false.

Throws:

IOException

addListener

void addListener(ContentAddressableStoreListener contentAddressableStoreListener)

Add a listener to this store.

Parameters:

contentAddressableStoreListener -

removeListener

void removeListener(ContentAddressableStoreListener contentAddressableStoreListener)

Remove a listener to this store.

Parameters:

contentAddressableStoreListener -

close

void close()

Specified by:

close in interface AutoCloseable