org.modeshape.jcr.value.binary

Class MongodbBinaryStore

java.lang.Object

org.modeshape.jcr.value.binary.AbstractBinaryStore

org.modeshape.jcr.value.binary.MongodbBinaryStore

All Implemented Interfaces:

BinaryStore

public class MongodbBinaryStore
extends AbstractBinaryStore

A BinaryStore implementation that uses a MongoDB for persisting binary values.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	chunkSize
protected static com.mongodb.BasicDBObject	DATA_CHUNK
protected static com.mongodb.BasicDBObject	HEADER

Fields inherited from class org.modeshape.jcr.value.binary.AbstractBinaryStore

logger, MEDIUM_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
MongodbBinaryStore(String host, int port, String database) Creates a new instance of the store, using a single MongoDB.
MongodbBinaryStore(String host, int port, String database, String username, String password, Set<String> replicaSet) Creates a new mongo binary store instance using the supplied params.

Method Summary

Modifier and Type	Method and Description
Iterable<BinaryKey>	getAllBinaryKeys() Obtain an iterable implementation containing all of the store's binary keys of those binaries that are in use.
int	getChunkSize() Gets the size of the chunk used to store content.
String	getExtractedText(BinaryValue source) Returns the extracted text of a binary value, or null if such text hasn't been stored previously (but the binary value can be found in the store)
InputStream	getInputStream(BinaryKey key) Get an InputStream to the binary content with the supplied key.
protected String	getStoredMimeType(BinaryValue source) Returns the stored mime-type of a binary value.
void	markAsUnused(Iterable<BinaryKey> keys) Mark the supplied binary keys as unused, but keep them in quarantine until needed again (at which point they're removed from quarantine) or until BinaryStore.removeValuesUnusedLongerThan(long, TimeUnit) is called.
void	markAsUsed(Iterable<BinaryKey> keys) Marks the binary with supplied keys as used.
void	removeValuesUnusedLongerThan(long minimumAge, TimeUnit unit) Remove binary values that have been unused for at least the specified amount of time.
void	setChunkSize(int chunkSize) Modifies chunk size used to store content.
void	start() Initialize the store and get ready for use.
void	storeExtractedText(BinaryValue source, String extractedText) Stores the extracted text of a binary value into this store.
protected void	storeMimeType(BinaryValue source, String mimeType) Stores the given mime-type for a binary value.
BinaryValue	storeValue(InputStream stream, boolean markAsUnused) Store the binary value and return the JCR representation.

Methods inherited from class org.modeshape.jcr.value.binary.AbstractBinaryStore

bestBufferSize, detector, extractors, getMimeType, getMinimumBinarySizeInBytes, getText, hasBinary, setMimeTypeDetector, setMinimumBinarySizeInBytes, setTextExtractors, shutdown, storeValue

Methods inherited from class java.lang.Object

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

Field Detail

HEADER

protected static final com.mongodb.BasicDBObject HEADER

DATA_CHUNK

protected static final com.mongodb.BasicDBObject DATA_CHUNK

chunkSize

protected int chunkSize

Constructor Detail

MongodbBinaryStore

public MongodbBinaryStore(String host,
                          int port,
                          String database)

Creates a new instance of the store, using a single MongoDB.

Parameters:

host -

port -

database -

MongodbBinaryStore

public MongodbBinaryStore(String host,
                          int port,
                          String database,
                          String username,
                          String password,
                          Set<String> replicaSet)

Creates a new mongo binary store instance using the supplied params.

Parameters:

host - the mongo host; may not be null

port - the port

database - the name of the database; may be null in which case a default will be used

username - the username; may be null

password - the password; may be null

replicaSet - a Set of (host:port) pairs representing multiple server addresses; may be null

Method Detail

getChunkSize

public int getChunkSize()

Gets the size of the chunk used to store content.

Returns:

chunk size in bytes.

setChunkSize

public void setChunkSize(int chunkSize)

Modifies chunk size used to store content.

Parameters:

chunkSize - chunk size in bytes.

storeValue

public BinaryValue storeValue(InputStream stream,
                              boolean markAsUnused)
                       throws BinaryStoreException

Description copied from interface: BinaryStore

Store the binary value and return the JCR representation. Note that if the binary content in the supplied stream is already persisted in the store, the store may simply return the binary value referencing the existing content.

Parameters:

stream - the stream containing the binary content to be stored; may not be null

markAsUnused - a boolean which indicates if the binary will be stored as unused or not. Binaries used from normal sessions (via properties) will normally be stored as unused and they will be marked as used only on tx commit.

Returns:

the binary value representing the stored binary value; never null

Throws:

BinaryStoreException - if there any unexpected problem

getInputStream

public InputStream getInputStream(BinaryKey key)
                           throws BinaryStoreException

Description copied from interface: BinaryStore

Get an InputStream to the binary content with the supplied key. The input stream will be returned as long as the binary value has not been removed, so expired binary values should be included here as well.

Parameters:

key - the key to the binary content; never null

Returns:

the input stream through which the content can be read, never null

Throws:

BinaryStoreException - if there is a problem reading the content from the store or if a valid, non-null InputStream cannot be returned for the given key.

markAsUsed

public void markAsUsed(Iterable<BinaryKey> keys)

Description copied from interface: BinaryStore

Marks the binary with supplied keys as used. This method should ignore any keys which are not present in the store.

Parameters:

keys - a BinaryKey Iterable, may not be null

markAsUnused

public void markAsUnused(Iterable<BinaryKey> keys)

Description copied from interface: BinaryStore

Mark the supplied binary keys as unused, but keep them in quarantine until needed again (at which point they're removed from quarantine) or until BinaryStore.removeValuesUnusedLongerThan(long, TimeUnit) is called. This method ignores any keys for values not stored within this store.

Parameters:

keys - the keys for the binary values that are no longer needed

removeValuesUnusedLongerThan

public void removeValuesUnusedLongerThan(long minimumAge,
                                         TimeUnit unit)

Description copied from interface: BinaryStore

Remove binary values that have been unused for at least the specified amount of time.

Parameters:

minimumAge - the minimum time that a binary value has been unused before it can be removed; must be non-negative

unit - the time unit for the minimum age; may not be null

storeMimeType

protected void storeMimeType(BinaryValue source,
                             String mimeType)
                      throws BinaryStoreException

Description copied from class: AbstractBinaryStore

Stores the given mime-type for a binary value.

Specified by:

storeMimeType in class AbstractBinaryStore

Parameters:

source - a non-null BinaryValue

mimeType - a non-empty String

Throws:

BinaryStoreException - if there's a problem accessing the binary store

getStoredMimeType

protected String getStoredMimeType(BinaryValue source)
                            throws BinaryStoreException

Description copied from class: AbstractBinaryStore

Returns the stored mime-type of a binary value.

Specified by:

getStoredMimeType in class AbstractBinaryStore

Parameters:

source - a non-null BinaryValue

Returns:

either a non-empty String if a stored mimetype exists, or null if such a value doesn't exist yet.

Throws:

BinaryStoreException - if there's a problem accessing the binary store or if the binary value cannot be found in the store

storeExtractedText

public void storeExtractedText(BinaryValue source,
                               String extractedText)
                        throws BinaryStoreException

Description copied from class: AbstractBinaryStore

Stores the extracted text of a binary value into this store.

Specified by:

storeExtractedText in class AbstractBinaryStore

Parameters:

source - a non-null BinaryValue instance from which the text was extracted

extractedText - a non-null and non-blank string representing the extracted text

Throws:

BinaryStoreException - if the operation fails or if the extracted text cannot be stored for the given binary value (regardless of the reason)

getExtractedText

public String getExtractedText(BinaryValue source)
                        throws BinaryStoreException

Description copied from class: AbstractBinaryStore

Returns the extracted text of a binary value, or null if such text hasn't been stored previously (but the binary value can be found in the store)

Specified by:

getExtractedText in class AbstractBinaryStore

Parameters:

source - a non-null BinaryValue instance from which the text was extracted

Returns:

a String representing the extracted text, or null if such text hasn't been stored in this store previously.

Throws:

BinaryStoreException - if the binary value cannot be found in the store.

getAllBinaryKeys

public Iterable<BinaryKey> getAllBinaryKeys()

Description copied from interface: BinaryStore

Obtain an iterable implementation containing all of the store's binary keys of those binaries that are in use. The resulting iterator may be lazy, in the sense that it may determine additional BinaryKeys only as the iterator is used.

Returns:

the iterable set of binary keys; never null

start

public void start()

Description copied from interface: BinaryStore

Initialize the store and get ready for use.

Specified by:

start in interface BinaryStore

Overrides:

start in class AbstractBinaryStore