ModeShape Distribution 3.0.0.Beta2

org.modeshape.jcr.value.binary
Class DatabaseBinaryStore

java.lang.Object
  extended by org.modeshape.jcr.value.binary.AbstractBinaryStore
      extended by org.modeshape.jcr.value.binary.DatabaseBinaryStore
All Implemented Interfaces:
BinaryStore

@ThreadSafe
public class DatabaseBinaryStore
extends AbstractBinaryStore

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


Field Summary
 
Fields inherited from class org.modeshape.jcr.value.binary.AbstractBinaryStore
logger, MEDIUM_BUFFER_SIZE
 
Fields inherited from interface org.modeshape.jcr.value.binary.BinaryStore
DEFAULT_MINIMUM_BINARY_SIZE_IN_BYTES
 
Constructor Summary
DatabaseBinaryStore(String datasourceJNDILocation)
          Create new store that uses the JDBC DataSource in the given JNDI location.
DatabaseBinaryStore(String driverClass, String connectionURL, String username, String password)
          Create new store.
 
Method Summary
protected  Database doCreateDatabase(Connection connection)
           
 String getExtractedText(BinaryValue source)
          Retrieves the extracted text of a binary value, which may or may not have been stored previously.
 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 key them in quarantine until needed again (at which point they're removed from quarantine) or until BinaryStore.removeValuesUnusedLongerThan(long, TimeUnit) is called.
 void removeValuesUnusedLongerThan(long minimumAge, TimeUnit unit)
          Remove binary values that have been unused for at least the specified amount of time.
 void shutdown()
           
 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)
          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, setMimeTypeDetector, setMinimumBinarySizeInBytes, setTextExtractors
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatabaseBinaryStore

public DatabaseBinaryStore(String driverClass,
                           String connectionURL,
                           String username,
                           String password)
Create new store.

Parameters:
driverClass - JDBC driver class name
connectionURL - database location
username - database user name
password - database password

DatabaseBinaryStore

public DatabaseBinaryStore(String datasourceJNDILocation)
Create new store that uses the JDBC DataSource in the given JNDI location.

Parameters:
datasourceJNDILocation - the JNDI name of the JDBC Data Source that should be used, or null
Method Detail

storeValue

public BinaryValue storeValue(InputStream stream)
                       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
Returns:
the binary value representing the stored binary value; never null
Throws:
BinaryStoreException

getInputStream

public InputStream getInputStream(BinaryKey key)
                           throws BinaryStoreException
Description copied from interface: BinaryStore
Get an InputStream to the binary content with the supplied key.

Parameters:
key - the key to the binary content; never null
Returns:
the input stream through which the content can be read
Throws:
BinaryStoreException - if there is a problem reading the content from the store

markAsUnused

public void markAsUnused(Iterable<BinaryKey> keys)
                  throws BinaryStoreException
Description copied from interface: BinaryStore
Mark the supplied binary keys as unused, but key 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
Throws:
BinaryStoreException - if there is a problem marking any of the supplied binary values as unused

removeValuesUnusedLongerThan

public void removeValuesUnusedLongerThan(long minimumAge,
                                         TimeUnit unit)
                                  throws BinaryStoreException
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
Throws:
BinaryStoreException - if there is a problem removing the unused values

getStoredMimeType

protected String getStoredMimeType(BinaryValue source)
                            throws BinaryStoreException
Description copied from class: AbstractBinaryStore
Returns the stored mime-type of a binary value.

Overrides:
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

storeMimeType

protected void storeMimeType(BinaryValue source,
                             String mimeType)
                      throws BinaryStoreException
Description copied from class: AbstractBinaryStore
Stores the given mime-type for a binary value.

Overrides:
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

getExtractedText

public String getExtractedText(BinaryValue source)
                        throws BinaryStoreException
Description copied from interface: BinaryStore
Retrieves the extracted text of a binary value, which may or may not have been stored previously.

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 operation fails

storeExtractedText

public void storeExtractedText(BinaryValue source,
                               String extractedText)
                        throws BinaryStoreException
Description copied from interface: BinaryStore
Stores the extracted text of a binary value into this store.

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 for whatever reason

start

public void start()
Description copied from class: AbstractBinaryStore
Initialize the store and get ready for use.

Overrides:
start in class AbstractBinaryStore

doCreateDatabase

protected Database doCreateDatabase(Connection connection)

shutdown

public void shutdown()
Overrides:
shutdown in class AbstractBinaryStore

ModeShape Distribution 3.0.0.Beta2

Copyright © 2008-2012 JBoss, a division of Red Hat. All Rights Reserved.