public class CassandraBinaryStore extends AbstractBinaryStore
Modifier and Type | Class and Description |
---|---|
protected class |
CassandraBinaryStore.BufferedInputStream |
logger, MEDIUM_BUFFER_SIZE
Constructor and Description |
---|
CassandraBinaryStore(String address) |
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.
|
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 |
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.
|
bestBufferSize, detector, extractors, getMimeType, getMinimumBinarySizeInBytes, getText, hasBinary, setMimeTypeDetector, setMinimumBinarySizeInBytes, setTextExtractors, shutdown, storeValue
public CassandraBinaryStore(String address)
protected String getStoredMimeType(BinaryValue source) throws BinaryStoreException
AbstractBinaryStore
getStoredMimeType
in class AbstractBinaryStore
source
- a non-null
BinaryValue
String
if a stored mimetype exists, or null
if such a value doesn't exist yet.BinaryStoreException
- if there's a problem accessing the binary store or if the binary value cannot be found in the
storeprotected void storeMimeType(BinaryValue source, String mimeType) throws BinaryStoreException
AbstractBinaryStore
storeMimeType
in class AbstractBinaryStore
source
- a non-null
BinaryValue
mimeType
- a non-empty String
BinaryStoreException
- if there's a problem accessing the binary storepublic void storeExtractedText(BinaryValue source, String extractedText) throws BinaryStoreException
AbstractBinaryStore
storeExtractedText
in class AbstractBinaryStore
source
- a non-null
BinaryValue
instance from which the text was extractedextractedText
- a non-null
and non-blank
string representing the extracted textBinaryStoreException
- if the operation fails or if the extracted text cannot be stored for the given binary value
(regardless of the reason)public String getExtractedText(BinaryValue source) throws BinaryStoreException
AbstractBinaryStore
null
if such text hasn't been stored previously (but the binary
value can be found in the store)getExtractedText
in class AbstractBinaryStore
source
- a non-null
BinaryValue
instance from which the text was extractedString
representing the extracted text, or null
if such text hasn't been stored in this store
previously.BinaryStoreException
- if the binary value cannot be found in the store.public BinaryValue storeValue(InputStream stream, boolean markAsUnused) throws BinaryStoreException
BinaryStore
stream
- the stream containing the binary content to be stored; may not be nullmarkAsUnused
- 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.BinaryStoreException
- if there any unexpected problempublic InputStream getInputStream(BinaryKey key) throws BinaryStoreException
BinaryStore
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.key
- the key to the binary content; never nullnever null
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.public void markAsUsed(Iterable<BinaryKey> keys) throws BinaryStoreException
BinaryStore
keys
- a BinaryKey
Iterable
, may not be nullBinaryStoreException
- if anything unexpected fails.public void markAsUnused(Iterable<BinaryKey> keys) throws BinaryStoreException
BinaryStore
BinaryStore.removeValuesUnusedLongerThan(long, TimeUnit)
is called. This method ignores any keys for
values not stored within this store.keys
- the keys for the binary values that are no longer neededBinaryStoreException
- if there is a problem marking any of the supplied binary values as unusedpublic void removeValuesUnusedLongerThan(long minimumAge, TimeUnit unit) throws BinaryStoreException
BinaryStore
unused
for at least the specified amount of time.minimumAge
- the minimum time that a binary value has been unused
before it can be
removed; must be non-negativeunit
- the time unit for the minimum age; may not be nullBinaryStoreException
- if there is a problem removing the unused valuespublic Iterable<BinaryKey> getAllBinaryKeys() throws BinaryStoreException
BinaryStore
BinaryKey
s only as the iterator is used.BinaryStoreException
- if anything unexpected happens.public void start()
BinaryStore
start
in interface BinaryStore
start
in class AbstractBinaryStore
Copyright © 2008–2016 JBoss, a division of Red Hat. All rights reserved.