org.nuxeo.ecm.core.storage.marklogic

Class MarkLogicRepository

java.lang.Object

org.nuxeo.ecm.core.storage.dbs.DBSRepositoryBase

org.nuxeo.ecm.core.storage.marklogic.MarkLogicRepository

All Implemented Interfaces:

LockManager, Repository, DBSRepository

public class MarkLogicRepository
extends DBSRepositoryBase

MarkLogic implementation of a Repository.

Since:

8.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MarkLogicRepository.MarkLogicBlobFinder

Nested classes/interfaces inherited from class org.nuxeo.ecm.core.storage.dbs.DBSRepositoryBase

DBSRepositoryBase.BlobFinder, DBSRepositoryBase.DBSSessionInvoker, DBSRepositoryBase.IdType, DBSRepositoryBase.TransactionContext

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	binaryPaths
protected CursorService<com.marklogic.xcc.ResultSequence,com.marklogic.xcc.ResultItem,String>	cursorService
static String	DB_DEFAULT
protected static Collector<CharSequence,?,String>	PATH_COLLECTOR
protected static String	PATH_COLLECTOR_BEGIN
protected static String	PATH_COLLECTOR_END
protected static String	PATH_COLLECTOR_SEP
protected List<MarkLogicRangeElementIndexDescriptor>	rangeElementIndexes
protected long	sequenceLastValue Last value used from the in-memory sequence.
protected com.marklogic.xcc.ContentSource	xccContentSource

Fields inherited from class org.nuxeo.ecm.core.storage.dbs.DBSRepositoryBase

blobManager, changeTokenEnabled, cm, DEBUG_UUIDS, fulltextConfiguration, idType, lockManager, repositoryName, selfRegisteredLockManager, transactionContexts, TYPE_ROOT

Constructor Summary

Constructors

Constructor and Description
MarkLogicRepository(javax.resource.spi.ConnectionManager cm, MarkLogicRepositoryDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
void	clearLockManagerCaches() Clears any cache held by the lock manager.
void	closeLockManager() Closes the lock manager and releases resources.
void	createState(State state) Creates a document.
void	createStates(List<State> states) Creates documents.
void	deleteStates(Set<String> ids) Deletes a set of document.
protected Stream<State>	findAll(String ctsQuery, String... selects)
String	generateNewId() Generates a new id for a document.
List<DBSRepositoryBase.IdType>	getAllowedIdTypes() Gets the allowed id types for this DBS repository.
Stream<State>	getDescendants(String rootId, Set<String> keys) Returns a stream of descendants from a given root document, in no particular order.
Stream<State>	getDescendants(String rootId, Set<String> keys, int limit) Returns a stream of descendants from a given root document, in no particular order.
Lock	getLock(String id) Gets the lock on a document.
protected Long	getNextSequenceId()
protected String	getProjectedQuery(String query, Collection<String> keys)
boolean	hasChild(String parentId, String name, Set<String> ignored) Checks if a document has a child with the given name
protected void	initBlobsPaths()
protected void	initRepository()
void	markReferencedBinaries() Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.
protected void	markReferencedBinaries(State state, DocumentBlobManager blobManager)
protected void	markReferencedBinary(Object value, DocumentBlobManager blobManager)
static com.marklogic.xcc.ContentSource	newMarkLogicContentSource(MarkLogicRepositoryDescriptor descriptor)
protected static com.marklogic.xcc.SecurityOptions	newTrustOptions()
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.
ScrollResult<String>	scroll(DBSExpressionEvaluator evaluator, int batchSize, int keepAliveInSecond) 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.
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.

Methods inherited from class org.nuxeo.ecm.core.storage.dbs.DBSRepositoryBase

getActiveSessionsCount, getBlobManager, getFulltextConfiguration, getLockManager, getLockManagerName, getName, getRootId, getSession, getSession, initLockManager, initRoot, isChangeTokenEnabled, isFulltextDisabled, newSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.core.storage.dbs.DBSRepository

begin, commit, rollback

Methods inherited from interface org.nuxeo.ecm.core.model.LockManager

canLockBeRemoved

Field Detail

DB_DEFAULT

public static final String DB_DEFAULT

See Also:

Constant Field Values

xccContentSource

protected com.marklogic.xcc.ContentSource xccContentSource

sequenceLastValue

protected long sequenceLastValue

Last value used from the in-memory sequence. Used by unit tests.

rangeElementIndexes

protected final List<MarkLogicRangeElementIndexDescriptor> rangeElementIndexes

cursorService

protected final CursorService<com.marklogic.xcc.ResultSequence,com.marklogic.xcc.ResultItem,String> cursorService

binaryPaths

protected List<String> binaryPaths

PATH_COLLECTOR_BEGIN

protected static final String PATH_COLLECTOR_BEGIN

See Also:

Constant Field Values

PATH_COLLECTOR_END

protected static final String PATH_COLLECTOR_END

See Also:

Constant Field Values

PATH_COLLECTOR_SEP

protected static final String PATH_COLLECTOR_SEP

See Also:

Constant Field Values

PATH_COLLECTOR

protected static final Collector<CharSequence,?,String> PATH_COLLECTOR

Constructor Detail

MarkLogicRepository

public MarkLogicRepository(javax.resource.spi.ConnectionManager cm,
                           MarkLogicRepositoryDescriptor descriptor)

Method Detail

getAllowedIdTypes

public List<DBSRepositoryBase.IdType> getAllowedIdTypes()

Description copied from class: DBSRepositoryBase

Gets the allowed id types for this DBS repository. The first one is the default.

Specified by:

getAllowedIdTypes in class DBSRepositoryBase

newMarkLogicContentSource

public static com.marklogic.xcc.ContentSource newMarkLogicContentSource(MarkLogicRepositoryDescriptor descriptor)

newTrustOptions

protected static com.marklogic.xcc.SecurityOptions newTrustOptions()

initRepository

protected void initRepository()

generateNewId

public String generateNewId()

Description copied from interface: DBSRepository

Generates a new id for a document.

Returns:

the new id

getNextSequenceId

protected Long getNextSequenceId()

shutdown

public void shutdown()

Specified by:

shutdown in interface Repository

Overrides:

shutdown in class DBSRepositoryBase

readState

public State readState(String id)

Description copied from interface: DBSRepository

Reads the state of a document.

Parameters:

id - the document id

Returns:

the document state, or null if not found

readPartialState

public State readPartialState(String id,
                              Collection<String> keys)

Description copied from interface: DBSRepository

Reads the partial state of a document.

Parameters:

id - the document id

keys - the keys to read

Returns:

the document partial state, or null if not found

readStates

public List<State> readStates(List<String> ids)

Description copied from interface: DBSRepository

Reads the states of several documents.

The returned states may be in a different order than the ids.

Parameters:

ids - the document ids

Returns:

the document states, an element by be null if not found

createState

public void createState(State state)

Description copied from interface: DBSRepository

Creates a document.

Parameters:

state - the document state

createStates

public void createStates(List<State> states)

Description copied from interface: DBSRepository

Creates documents.

Parameters:

states - the document states

updateState

public void updateState(String id,
                        State.StateDiff diff,
                        DBSTransactionState.ChangeTokenUpdater changeTokenUpdater)

Description copied from interface: DBSRepository

Updates a document.

Parameters:

id - the document id

diff - the diff to apply

changeTokenUpdater - how to get and update the change token (may be null)

deleteStates

public void deleteStates(Set<String> ids)

Description copied from interface: DBSRepository

Deletes a set of document.

Parameters:

ids - the document ids

readChildState

public State readChildState(String parentId,
                            String name,
                            Set<String> ignored)

Description copied from interface: DBSRepository

Reads the state of a child document.

Parameters:

parentId - the parent document id

name - the name of the child

ignored - a set of document ids that should not be considered

Returns:

the state of the child document, or null if not found

hasChild

public boolean hasChild(String parentId,
                        String name,
                        Set<String> ignored)

Description copied from interface: DBSRepository

Checks if a document has a child with the given name

Parameters:

parentId - the parent document id

name - the name of the child

ignored - a set of document ids that should not be considered

Returns:

true if the child exists, false if not

queryKeyValue

public List<State> queryKeyValue(String key,
                                 Object value,
                                 Set<String> ignored)

Description copied from interface: DBSRepository

Queries the repository for documents having key = value.

Parameters:

key - the key

value - the value

ignored - a set of document ids that should not be considered

Returns:

the document states matching the query

queryKeyValue

public List<State> queryKeyValue(String key1,
                                 Object value1,
                                 String key2,
                                 Object value2,
                                 Set<String> ignored)

Description copied from interface: DBSRepository

Queries the repository for documents having key1 = value1 and key2 = value2.

Parameters:

key1 - the first key

value1 - the first value

key2 - the second key

value2 - the second value

ignored - a set of document ids that should not be considered

Returns:

the document states matching the query

getDescendants

public Stream<State> getDescendants(String rootId,
                                    Set<String> keys)

Description copied from interface: DBSRepository

Returns a stream of descendants from a given root document, in no particular order. This does not include information about the root document itself.

THE STREAM MUST BE CLOSED WHEN DONE to release resources.

Parameters:

rootId - the root document id

keys - what to collect about the descendants in addition to their ids

Returns:

a stream of States; THE STREAM MUST BE CLOSED WHEN DONE

getDescendants

public Stream<State> getDescendants(String rootId,
                                    Set<String> keys,
                                    int limit)

Description copied from interface: DBSRepository

Returns a stream of descendants from a given root document, in no particular order. This does not include information about the root document itself.

THE STREAM MUST BE CLOSED WHEN DONE to release resources.

Parameters:

rootId - the root document id

keys - what to collect about the descendants in addition to their ids

limit - the maximum number of descendants to return

Returns:

a stream of States; THE STREAM MUST BE CLOSED WHEN DONE

queryKeyValuePresence

public boolean queryKeyValuePresence(String key,
                                     String value,
                                     Set<String> ignored)

Description copied from interface: DBSRepository

Queries the repository to check if there are documents having key = value.

Parameters:

key - the key

value - the value

ignored - a set of document ids that should not be considered

Returns:

true if the query matches at least one document, false if the query matches nothing

queryAndFetch

public PartialList<Map<String,Serializable>> queryAndFetch(DBSExpressionEvaluator evaluator,
                                                           OrderByClause orderByClause,
                                                           boolean distinctDocuments,
                                                           int limit,
                                                           int offset,
                                                           int countUpTo)

Description copied from interface: DBSRepository

Queries the repository for documents matching a NXQL query, and returns a projection of the documents.

Parameters:

evaluator - the map-based evaluator for the query

orderByClause - an ORDER BY clause

distinctDocuments - true if the projection should return a maximum of one row per document

limit - the limit on the number of documents to return

offset - the offset in the list of documents to return

countUpTo - if -1, count the total size without offset/limit.
If 0, don't count the total size, set it to -1 .
If n, count the total number if there are less than n documents otherwise set the total size to -2.

Returns:

a partial list of maps containing the NXQL projections requested, and the total size according to countUpTo

scroll

public ScrollResult<String> scroll(DBSExpressionEvaluator evaluator,
                                   int batchSize,
                                   int keepAliveInSecond)

Description copied from interface: DBSRepository

Executes the given query and returns the first batch of results containing id of documents, next batch must be requested within the keepAliveSeconds delay.

scroll

public ScrollResult<String> scroll(String scrollId)

Description copied from interface: DBSRepository

Get the next batch of results containing id of documents, the scrollId is part of the previous ScrollResult response.

getLock

public Lock getLock(String id)

Description copied from interface: LockManager

Gets the lock on a document.

If the document does not exist, null is returned.

Parameters:

id - the document id

Returns:

the existing lock, or null when there is no lock

setLock

public Lock setLock(String id,
                    Lock lock)

Description copied from interface: LockManager

Sets a lock on a document.

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).

Parameters:

id - the document id

lock - the lock to set

Returns:

null if locking succeeded, or the existing lock if locking failed

removeLock

public Lock removeLock(String id,
                       String owner)

Description copied from interface: LockManager

Removes the lock from a document.

The 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().

Parameters:

id - the document id

Returns:

the previous lock (may be null), with a failed flag if locking failed

closeLockManager

public void closeLockManager()

Description copied from interface: LockManager

Closes the lock manager and releases resources.

clearLockManagerCaches

public void clearLockManagerCaches()

Description copied from interface: LockManager

Clears any cache held by the lock manager.

initBlobsPaths

protected void initBlobsPaths()

Specified by:

initBlobsPaths in class DBSRepositoryBase

markReferencedBinaries

public void markReferencedBinaries()

Description copied from interface: Repository

Marks the binaries in use by passing them to the binary manager(s)'s GC mark() method.

markReferencedBinaries

protected void markReferencedBinaries(State state,
                                      DocumentBlobManager blobManager)

markReferencedBinary

protected void markReferencedBinary(Object value,
                                    DocumentBlobManager blobManager)

findAll

protected Stream<State> findAll(String ctsQuery,
                                String... selects)

getProjectedQuery

protected String getProjectedQuery(String query,
                                   Collection<String> keys)