Package org.sturrock.cassette.cassettej

Class ContentAddressableStoreFileImpl

java.lang.Object

org.sturrock.cassette.cassettej.ContentAddressableStoreImpl

org.sturrock.cassette.cassettej.ContentAddressableStoreFileImpl

All Implemented Interfaces:

AutoCloseable, ContentAddressableStore

public final class ContentAddressableStoreFileImpl
extends ContentAddressableStoreImpl

A content-addressable store backed by the file system. Default implementation of ContentAddressableStore.

Field Summary

Fields

Modifier and Type	Field	Description
int	hashPrefixLength	The number of characters from the hash to use for the name of the top level subdirectories.
static String	rootPathPropertyName

Constructor Summary

Constructors

Constructor	Description
ContentAddressableStoreFileImpl(Properties properties)	Initialises the store.

Method Summary

Modifier and Type	Method	Description
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.
Path	getContentPath(String hashString)
List<Hash>	getHashes()	Get a list of all hashes in the store.
Path	getRootPath()
Path	getSubPath(String hashString)
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.
Hash	write(InputStream inputStream)	Write content to the store, returning its hash.
Hash	write(InputStream inputStream, List<ContentEncoding> encodings)	Write content to the store in raw format and also formats specified in the ContentEncodings.

Methods inherited from class org.sturrock.cassette.cassettej.ContentAddressableStoreImpl

addListener, notifyListenersContentAdded, notifyListenersContentRemoved, removeListener

Methods inherited from class java.lang.Object

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

Field Detail

hashPrefixLength

public final int hashPrefixLength

The number of characters from the hash to use for the name of the top level subdirectories.

See Also:

Constant Field Values

rootPathPropertyName

public static final String rootPathPropertyName

Constructor Detail

ContentAddressableStoreFileImpl

public ContentAddressableStoreFileImpl(Properties properties)
                                throws IOException

Initialises the store.

Parameters:

properties - Properties controlling construction. Currently supported properties are: ContentAddressableStoreFileImpl.class.getName() + ".rootPath" which specifies the path to the root directory of the storage.

Throws:

IOException

Method Detail

getRootPath

public Path getRootPath()

Returns:

the root path for all content within this store

write

public Hash write(InputStream inputStream)
           throws IOException

Description copied from interface: ContentAddressableStore

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:

inputStream - Content to be written

Returns:

hash of content

Throws:

IOException

write

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

Description copied from interface: ContentAddressableStore

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:

inputStream - Content to be written

Returns:

hash of (raw) content

Throws:

IOException

contains

public boolean contains(Hash hash)

Description copied from interface: ContentAddressableStore

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

public boolean contains(Hash hash,
                        ContentEncoding contentEncoding)

Description copied from interface: ContentAddressableStore

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

public InputStream read(Hash hash,
                        ContentEncoding contentEncoding)
                 throws IOException

Description copied from interface: ContentAddressableStore

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

read

public InputStream read(Hash hash)
                 throws IOException

Description copied from interface: ContentAddressableStore

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

getContentLength

public long getContentLength(Hash hash)
                      throws IOException

Description copied from interface: ContentAddressableStore

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

public long getContentLength(Hash hash,
                             ContentEncoding contentEncoding)
                      throws IOException

Description copied from interface: ContentAddressableStore

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

public List<Hash> getHashes()
                     throws IOException

Description copied from interface: ContentAddressableStore

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

public boolean delete(Hash hash)
               throws IOException

Description copied from interface: ContentAddressableStore

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

getContentPath

public Path getContentPath(String hashString)

getSubPath

public Path getSubPath(String hashString)

close

public void close()