org.modeshape.jcr.cache.document

Class LocalDocumentStore

java.lang.Object

org.modeshape.jcr.cache.document.LocalDocumentStore

All Implemented Interfaces:

DocumentStore

public class LocalDocumentStore
extends Object
implements DocumentStore

An implementation of DocumentStore which always uses the local cache to store/retrieve data and which provides some additional methods for exposing local cache information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalDocumentStore.DocumentOperationResults

Constructor Summary

Constructors

Constructor and Description
LocalDocumentStore(SchematicDb database, RepositoryEnvironment repoEnv) Creates a new local store with the given database

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(String key) Determine whether the database contains an entry with the supplied key.
String	createExternalProjection(String projectedNodeKey, String sourceName, String externalPath, String alias) Creates an external projection from the federated node with the given key, towards the external node from the given path, from a source.
String	databaseId() Returns the id of the database.
EditableDocument	edit(String key, boolean createIfMissing) Edit the existing document at the given key.
SchematicEntry	get(String key) Get the entry with the supplied key.
Document	getChildReference(String parentKey, String childKey) Returns a document representing a single child reference from the supplied parent to the supplied child.
Document	getChildrenBlock(String key) Returns a document representing a block of children, that has the given key.
ExternalBinaryValue	getExternalBinary(String sourceName, String id) Retrieves a binary value which has the given id and which is not stored by ModeShape.
String	getLocalSourceKey() Returns the value of the local repository source key.
List<String>	keys() Returns all the keys which are held by this store.
List<SchematicEntry>	load(Collection<String> keys) Loads a set of entries from the document store.
LocalDocumentStore	localStore() Returns a local store instance which is used to persist internal repository information.
boolean	lockDocuments(Collection<String> keys) Attempts to lock all of the documents with the given keys.
boolean	lockDocuments(String... keys) Attempts to lock all of the documents with the given keys.
String	newDocumentKey(String parentKey, Name documentName, Name documentPrimaryType) Generates a new key which will be assigned to a new child document when it is being added to its parent.
LocalDocumentStore.DocumentOperationResults	performOnEachDocument(BiFunction<String,EditableDocument,Boolean> operation) Perform the supplied operation on each stored document that is accessible within this process.
void	put(Document entryDocument) Store the supplied document in the local db
void	put(String key, Document document) Store the supplied document and metadata at the given key.
boolean	remove(String key) Remove the existing document at the given key.
void	removeAll() Removes all the contents of the document store (i.e. all the documents) Note that for this to work, it is expected that the caller will've already started a transaction.
<V> V	runInTransaction(Callable<V> operation, int retryCountOnLockTimeout, String... keysToLock) Runs the given operation within a transaction, after optionally locking some keys.
void	setLocalSourceKey(String sourceKey) Sets the value of the local repository source key.
SchematicEntry	storeIfAbsent(String key, Document document) Store the supplied document at the given key.
void	updateDocument(String key, Document document, SessionNode sessionNode) Updates the content of the document at the given key with the given document.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDocumentStore

public LocalDocumentStore(SchematicDb database,
                          RepositoryEnvironment repoEnv)

Creates a new local store with the given database

Parameters:

database - a SchematicDb instance which must be non-null.

repoEnv - a RepositoryEnvironment instance which must be non-null

Method Detail

containsKey

public boolean containsKey(String key)

Description copied from interface: DocumentStore

Determine whether the database contains an entry with the supplied key.

Specified by:

containsKey in interface DocumentStore

Parameters:

key - the key or identifier for the document

Returns:

true if the database contains an entry with this key, or false otherwise

See Also:

SchematicDb.containsKey(String)

keys

public List<String> keys()

Returns all the keys which are held by this store.

Returns:

a Set of keys, never null

load

public List<SchematicEntry> load(Collection<String> keys)

Description copied from interface: DocumentStore

Loads a set of entries from the document store. This should always return the latest persisted view of the entries.

Specified by:

load in interface DocumentStore

Parameters:

keys - a Set of document keys; may not be null

Returns:

a Collection of entries; never null

get

public SchematicEntry get(String key)

Description copied from interface: DocumentStore

Get the entry with the supplied key.

Specified by:

get in interface DocumentStore

Parameters:

key - the key or identifier for the document

Returns:

the entry, or null if there was no document with the supplied key

See Also:

SchematicDb.get(String)

storeIfAbsent

public SchematicEntry storeIfAbsent(String key,
                                    Document document)

Description copied from interface: DocumentStore

Store the supplied document at the given key.

Specified by:

storeIfAbsent in interface DocumentStore

Parameters:

key - the key or identifier for the document

document - the document that is to be stored

Returns:

the existing entry for the supplied key, or null if there was no entry and the put was successful

See Also:

SchematicDb.putIfAbsent(String, Document)

updateDocument

public void updateDocument(String key,
                           Document document,
                           SessionNode sessionNode)

Description copied from interface: DocumentStore

Updates the content of the document at the given key with the given document.

Specified by:

updateDocument in interface DocumentStore

Parameters:

key - the key or identifier for the document

document - the content with which the existing document should be updated

sessionNode - the SessionNode instance which contains the changes that caused the update

newDocumentKey

public String newDocumentKey(String parentKey,
                             Name documentName,
                             Name documentPrimaryType)

Description copied from interface: DocumentStore

Generates a new key which will be assigned to a new child document when it is being added to its parent.

Specified by:

newDocumentKey in interface DocumentStore

Parameters:

parentKey - a non-null String, the key of the existing parent

documentName - non-null Name, the name of the new child document.

documentPrimaryType - non-null Name, the name of the primary type of the new child document

Returns:

a String which will be assigned as key to the new child, or null indicating that no preferred key is to be used. If this is the case, the repository will assign a random key.

put

@RequiresTransaction
public void put(String key,
                                      Document document)

Store the supplied document and metadata at the given key.

Parameters:

key - the key or identifier for the document

document - the document that is to be stored

See Also:

SchematicDb.put(String, Document)

put

@RequiresTransaction
public void put(Document entryDocument)

Store the supplied document in the local db

Parameters:

entryDocument - the document that contains the metadata document, content document, and key

remove

public boolean remove(String key)

Description copied from interface: DocumentStore

Remove the existing document at the given key.

NOTE: This method does not perform any locking on that key. As such, the caller code should make sure DocumentStore.lockDocuments(java.util.Collection<java.lang.String>) is called first on all the keys that are about to be changed if the operation can be performed from a concurrent context.

Specified by:

remove in interface DocumentStore

Parameters:

key - the key or identifier for the document

Returns:

true if a document was removed, or false if there was no document with that key

See Also:

SchematicDb.remove(String)

removeAll

@RequiresTransaction
public void removeAll()

Removes all the contents of the document store (i.e. all the documents) Note that for this to work, it is expected that the caller will've already started a transaction.

lockDocuments

public boolean lockDocuments(Collection<String> keys)

Description copied from interface: DocumentStore

Attempts to lock all of the documents with the given keys.

NOTE: This should only be called within an existing transaction. If this operation succeeds, all the locked keys will be released automatically when the transaction completes (regardless whether successfully or not).

Specified by:

lockDocuments in interface DocumentStore

Parameters:

keys - the set of keys identifying the documents that are to be updated via DocumentStore.updateDocument(String, Document, SessionNode) or via DocumentStore.edit(String,boolean).

Returns:

true if the documents were locked, or false if not all of the documents could be locked

lockDocuments

public boolean lockDocuments(String... keys)

Description copied from interface: DocumentStore

Attempts to lock all of the documents with the given keys.

NOTE: This should only be called within an existing transaction. If this operation succeeds, all the locked keys will be released automatically when the transaction completes (regardless whether successfully or not)

Specified by:

lockDocuments in interface DocumentStore

Parameters:

keys - the set of keys identifying the documents that are to be updated via DocumentStore.updateDocument(String, Document, SessionNode) or via DocumentStore.edit(String,boolean).

Returns:

true if the documents were locked, or false if not all of the documents could be locked

edit

public EditableDocument edit(String key,
                             boolean createIfMissing)

Description copied from interface: DocumentStore

Edit the existing document at the given key.

NOTE: This method does not perform any locking on that key. As such, the caller code should make sure DocumentStore.lockDocuments(java.util.Collection<java.lang.String>) is called first on all the keys that are about to be changed if the operation can be performed from a concurrent context.

Specified by:

edit in interface DocumentStore

Parameters:

key - the key or identifier for the document

createIfMissing - true if a new entry should be created and added to the database if an existing entry does not exist

Returns:

a EditableDocument instance if either a document exists at the given key or a new one was created and added successfully. If a document does not already exist and cannot be created, then this will return null

See Also:

SchematicDb.editContent(String, boolean)

localStore

public LocalDocumentStore localStore()

Description copied from interface: DocumentStore

Returns a local store instance which is used to persist internal repository information.

Specified by:

localStore in interface DocumentStore

Returns:

a non-null LocalDocumentStore instance.

setLocalSourceKey

public void setLocalSourceKey(String sourceKey)

Description copied from interface: DocumentStore

Sets the value of the local repository source key.

Specified by:

setLocalSourceKey in interface DocumentStore

Parameters:

sourceKey - a non-null string

getLocalSourceKey

public String getLocalSourceKey()

Description copied from interface: DocumentStore

Returns the value of the local repository source key.

Specified by:

getLocalSourceKey in interface DocumentStore

Returns:

a non-null string

createExternalProjection

public String createExternalProjection(String projectedNodeKey,
                                       String sourceName,
                                       String externalPath,
                                       String alias)

Description copied from interface: DocumentStore

Creates an external projection from the federated node with the given key, towards the external node from the given path, from a source.

Specified by:

createExternalProjection in interface DocumentStore

Parameters:

projectedNodeKey - a non-null string, the key of the federated node which will contain the projection

sourceName - a non-null string, the name of an external source.

externalPath - a non-null string, representing a path towards a node from the source

alias - a non-null string, representing the alias given to the projection.

Returns:

a non-null string representing the node key of the external node located at externalPath.

getChildrenBlock

public Document getChildrenBlock(String key)

Description copied from interface: DocumentStore

Returns a document representing a block of children, that has the given key.

Specified by:

getChildrenBlock in interface DocumentStore

Parameters:

key - a non-null String the key of the block

Returns:

either a Document with children and possibly a pointer to the next block, or null if there isn't a block with such a key.

getChildReference

public Document getChildReference(String parentKey,
                                  String childKey)

Description copied from interface: DocumentStore

Returns a document representing a single child reference from the supplied parent to the supplied child. This method is called when it is too expensive to find the child reference within the child references.

Specified by:

getChildReference in interface DocumentStore

Parameters:

parentKey - the key for the parent

childKey - the key for the child

Returns:

the document representation of a child reference, or null if the implementation doesn't support this method or the parent does not contain a child with the given key

getExternalBinary

public ExternalBinaryValue getExternalBinary(String sourceName,
                                             String id)

Description copied from interface: DocumentStore

Retrieves a binary value which has the given id and which is not stored by ModeShape.

Specified by:

getExternalBinary in interface DocumentStore

Parameters:

sourceName - a non-null String; the name of an external source

id - a non-null String; the id of an external binary value

Returns:

either an ExternalBinaryValue implementation or null

databaseId

public String databaseId()

Returns the id of the database.

Returns:

an identifier string, never null

performOnEachDocument

public LocalDocumentStore.DocumentOperationResults performOnEachDocument(BiFunction<String,EditableDocument,Boolean> operation)

Perform the supplied operation on each stored document that is accessible within this process. Each document will be operated upon in a separate transaction, which will be committed if the operation is successful or rolledback if the operation cannot be complete successfully.

Generally, this method executes the operation upon all documents. If there is an error processing a single document, that document is skipped and the execution will continue with the next document(s). However, if there is an exception with the transactions or another system failure, this method will terminate with an exception.

Parameters:

operation - the operation to be performed

Returns:

the summary of the number of documents that were affected

runInTransaction

public <V> V runInTransaction(Callable<V> operation,
                              int retryCountOnLockTimeout,
                              String... keysToLock)

Runs the given operation within a transaction, after optionally locking some keys.

Type Parameters:

V - the return type of the operation

Parameters:

operation - a Callable instance; may not be null

retryCountOnLockTimeout - the number of times the operation should be retried if a timeout occurs while trying to obtain the locks

keysToLock - an optional String[] representing the keys to lock before performing the operation

Returns:

the result of operation