public class DBSCachingRepository extends Object implements DBSRepository
| Modifier and Type | Field and Description |
|---|---|
protected com.codahale.metrics.MetricRegistry |
registry |
| Constructor and Description |
|---|
DBSCachingRepository(DBSRepository repository,
DBSRepositoryDescriptor descriptor) |
| Modifier and Type | Method and Description |
|---|---|
void |
begin()
Called when created a transaction.
|
void |
clearLockManagerCaches()
Clears any cache held by the lock manager.
|
void |
closeLockManager()
Closes the lock manager and releases resources.
|
void |
commit()
Saves and flushes to database.
|
protected DBSClusterInvalidator |
createClusterInvalidator(DBSRepositoryDescriptor descriptor) |
void |
createState(State state)
Creates a document.
|
void |
createStates(List<State> states)
Creates documents.
|
void |
deleteStates(Set<String> ids)
Deletes a set of document.
|
String |
generateNewId()
Generates a new id for a document.
|
int |
getActiveSessionsCount() |
BlobManager |
getBlobManager()
Gets the blob manager.
|
Stream<State> |
getDescendants(String id,
Set<String> keys)
Returns a stream of descendants from a given root document, in no particular order.
|
Stream<State> |
getDescendants(String id,
Set<String> keys,
int limit)
Returns a stream of descendants from a given root document, in no particular order.
|
FulltextConfiguration |
getFulltextConfiguration()
Gets the fulltext configuration.
|
Lock |
getLock(String id)
Gets the lock on a document.
|
LockManager |
getLockManager()
Gets the lock manager for this repository.
|
String |
getName() |
String |
getRootId()
Gets the root id.
|
Session |
getSession() |
boolean |
hasChild(String parentId,
String name,
Set<String> ignored)
Checks if a document has a child with the given name
|
protected void |
initClusterInvalidator(DBSRepositoryDescriptor descriptor) |
boolean |
isChangeTokenEnabled()
Checks if database-managed document change tokens are enabled.
|
boolean |
isFulltextDisabled()
Checks if fulltext indexing is disabled.
|
void |
markReferencedBinaries()
Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
|
protected <T> com.google.common.cache.Cache<String,T> |
newCache(DBSRepositoryDescriptor descriptor) |
protected void |
processReceivedInvalidations() |
PartialList<Map<String,Serializable>> |
queryAndFetch(DBSExpressionEvaluator evaluator,
OrderByClause orderByClause,
boolean distinctDocuments,
int limit,
int offset,
int countUpTo)
Queries the repository for documents matching a NXQL query, and returns a projection of the documents.
|
List<State> |
queryKeyValue(String key,
Object value,
Set<String> ignored)
Queries the repository for documents having key = value.
|
List<State> |
queryKeyValue(String key1,
Object value1,
String key2,
Object value2,
Set<String> ignored)
Queries the repository for documents having key1 = value1 and key2 = value2.
|
boolean |
queryKeyValuePresence(String key,
String value,
Set<String> ignored)
Queries the repository to check if there are documents having key = value.
|
State |
readChildState(String parentId,
String name,
Set<String> ignored)
Reads the state of a child document.
|
State |
readPartialState(String id,
Collection<String> keys)
Reads the partial state of a document.
|
State |
readState(String id)
Reads the state of a document.
|
List<State> |
readStates(List<String> ids)
Reads the states of several documents.
|
Lock |
removeLock(String id,
String owner)
Removes the lock from a document.
|
void |
rollback()
Rolls back the save state by applying the undo log.
|
ScrollResult<String> |
scroll(DBSExpressionEvaluator evaluator,
int batchSize,
int keepAliveSeconds)
Executes the given query and returns the first batch of results containing id of documents, next batch must be
requested within the
keepAliveSeconds delay. |
ScrollResult<String> |
scroll(String scrollId)
Get the next batch of results containing id of documents, the
scrollId is part of the previous
ScrollResult response. |
protected void |
sendInvalidationsToOther() |
Lock |
setLock(String id,
Lock lock)
Sets a lock on a document.
|
void |
shutdown() |
void |
updateState(String id,
State.StateDiff diff,
DBSTransactionState.ChangeTokenUpdater changeTokenUpdater)
Updates a document.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcanLockBeRemovedprotected final com.codahale.metrics.MetricRegistry registry
public DBSCachingRepository(DBSRepository repository, DBSRepositoryDescriptor descriptor)
protected <T> com.google.common.cache.Cache<String,T> newCache(DBSRepositoryDescriptor descriptor)
protected void initClusterInvalidator(DBSRepositoryDescriptor descriptor)
protected DBSClusterInvalidator createClusterInvalidator(DBSRepositoryDescriptor descriptor)
public void begin()
DBSRepositorybegin in interface DBSRepositorypublic void commit()
DBSRepositorycommit in interface DBSRepositorypublic void rollback()
DBSRepositoryrollback in interface DBSRepositorypublic void shutdown()
shutdown in interface Repositorypublic State readState(String id)
DBSRepositoryreadState in interface DBSRepositoryid - the document idnull if not foundpublic State readPartialState(String id, Collection<String> keys)
DBSRepositoryreadPartialState in interface DBSRepositoryid - the document idkeys - the keys to readnull if not foundpublic List<State> readStates(List<String> ids)
DBSRepositoryThe returned states may be in a different order than the ids.
readStates in interface DBSRepositoryids - the document idsnull if not foundpublic void createState(State state)
DBSRepositorycreateState in interface DBSRepositorystate - the document statepublic void createStates(List<State> states)
DBSRepositorycreateStates in interface DBSRepositorystates - the document statespublic void updateState(String id, State.StateDiff diff, DBSTransactionState.ChangeTokenUpdater changeTokenUpdater)
DBSRepositoryupdateState in interface DBSRepositoryid - the document iddiff - the diff to applychangeTokenUpdater - how to get and update the change token (may be null)public void deleteStates(Set<String> ids)
DBSRepositorydeleteStates in interface DBSRepositoryids - the document idspublic State readChildState(String parentId, String name, Set<String> ignored)
DBSRepositoryreadChildState in interface DBSRepositoryparentId - the parent document idname - the name of the childignored - a set of document ids that should not be considerednull if not foundprotected void sendInvalidationsToOther()
protected void processReceivedInvalidations()
public BlobManager getBlobManager()
DBSRepositorygetBlobManager in interface DBSRepositorypublic FulltextConfiguration getFulltextConfiguration()
DBSRepositorygetFulltextConfiguration in interface DBSRepositorypublic boolean isFulltextDisabled()
DBSRepositoryisFulltextDisabled in interface DBSRepositorytrue if fulltext indexing is disabled, false if it is enabledpublic boolean isChangeTokenEnabled()
DBSRepositoryisChangeTokenEnabled in interface DBSRepositorytrue if the database maintains document change tokenspublic String getRootId()
DBSRepositorygetRootId in interface DBSRepositorypublic String generateNewId()
DBSRepositorygenerateNewId in interface DBSRepositorypublic boolean hasChild(String parentId, String name, Set<String> ignored)
DBSRepositoryhasChild in interface DBSRepositoryparentId - the parent document idname - the name of the childignored - a set of document ids that should not be consideredtrue if the child exists, false if notpublic List<State> queryKeyValue(String key, Object value, Set<String> ignored)
DBSRepositoryqueryKeyValue in interface DBSRepositorykey - the keyvalue - the valueignored - a set of document ids that should not be consideredpublic List<State> queryKeyValue(String key1, Object value1, String key2, Object value2, Set<String> ignored)
DBSRepositoryqueryKeyValue in interface DBSRepositorykey1 - the first keyvalue1 - the first valuekey2 - the second keyvalue2 - the second valueignored - a set of document ids that should not be consideredpublic Stream<State> getDescendants(String id, Set<String> keys)
DBSRepositoryTHE STREAM MUST BE CLOSED WHEN DONE to release resources.
getDescendants in interface DBSRepositoryid - the root document idkeys - what to collect about the descendants in addition to their idsStates; THE STREAM MUST BE CLOSED WHEN DONEpublic Stream<State> getDescendants(String id, Set<String> keys, int limit)
DBSRepositoryTHE STREAM MUST BE CLOSED WHEN DONE to release resources.
getDescendants in interface DBSRepositoryid - the root document idkeys - what to collect about the descendants in addition to their idslimit - the maximum number of descendants to returnStates; THE STREAM MUST BE CLOSED WHEN DONEpublic boolean queryKeyValuePresence(String key, String value, Set<String> ignored)
DBSRepositoryqueryKeyValuePresence in interface DBSRepositorykey - the keyvalue - the valueignored - a set of document ids that should not be consideredtrue if the query matches at least one document, false if the query matches nothingpublic PartialList<Map<String,Serializable>> queryAndFetch(DBSExpressionEvaluator evaluator, OrderByClause orderByClause, boolean distinctDocuments, int limit, int offset, int countUpTo)
DBSRepositoryqueryAndFetch in interface DBSRepositoryevaluator - the map-based evaluator for the queryorderByClause - an ORDER BY clausedistinctDocuments - true if the projection should return a maximum of one row per documentlimit - the limit on the number of documents to returnoffset - the offset in the list of documents to returncountUpTo - if -1, count the total size without offset/limit.0, don't count the total size, set it to -1 .n, count the total number if there are less than n documents otherwise set the total size
to -2.public LockManager getLockManager()
DBSRepositorygetLockManager in interface DBSRepositorypublic ScrollResult<String> scroll(DBSExpressionEvaluator evaluator, int batchSize, int keepAliveSeconds)
DBSRepositorykeepAliveSeconds delay.scroll in interface DBSRepositorypublic ScrollResult<String> scroll(String scrollId)
DBSRepositoryscrollId is part of the previous
ScrollResult response.scroll in interface DBSRepositorypublic Lock getLock(String id)
LockManager
If the document does not exist, null is returned.
getLock in interface LockManagerid - the document idnull when there is no lockpublic Lock setLock(String id, Lock lock)
LockManager
If the document is already locked, returns its existing lock status (there is no re-locking, LockManager.removeLock(java.lang.String, java.lang.String)
must be called first).
setLock in interface LockManagerid - the document idlock - the lock to setnull if locking succeeded, or the existing lock if locking failedpublic Lock removeLock(String id, String owner)
LockManagerThe previous lock is returned.
If owner is null then the lock is unconditionally removed.
If owner is not null, it must match the existing lock owner for the lock to be removed. If it
doesn't match, the returned lock will return true for Lock.getFailed().
removeLock in interface LockManagerid - the document idnull), with a failed flag if locking failedpublic void closeLockManager()
LockManagercloseLockManager in interface LockManagerpublic void clearLockManagerCaches()
LockManagerclearLockManagerCaches in interface LockManagerpublic String getName()
getName in interface Repositorypublic Session getSession()
getSession in interface Repositorypublic int getActiveSessionsCount()
getActiveSessionsCount in interface Repositorypublic void markReferencedBinaries()
RepositorymarkReferencedBinaries in interface RepositoryCopyright © 2018 Nuxeo. All rights reserved.