org.nuxeo.ecm.core.storage.dbs

Class DBSSession

java.lang.Object

org.nuxeo.ecm.core.storage.dbs.DBSSession

All Implemented Interfaces:

Session

public class DBSSession
extends Object
implements Session

Implementation of a Session for Document-Based Storage.

Since:

5.9.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DBSSession.DBSQueryResult
static class	DBSSession.OrderByComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changeTokenEnabled
protected boolean	closed
protected static Pattern	dotDigitsPattern
protected boolean	fulltextSearchDisabled
protected boolean	isLatestVersionDisabled
protected static Set<String>	KEYS_RETENTION_ACTIVE_AND_PROXIES
protected com.codahale.metrics.MetricRegistry	registry
protected DBSRepository	repository
protected static Type	STRING_ARRAY_TYPE
protected DBSTransactionState	transaction

Fields inherited from interface org.nuxeo.ecm.core.model.Session

USER_NAME

Constructor Summary

Constructors

Constructor and Description
DBSSession(DBSRepository repository)

Method Summary

Modifier and Type	Method and Description
protected static Serializable	acpToMem(ACP acp)
protected void	addBackProxyId(DBSDocumentState docState, String id)
protected DBSDocumentState	addProxyState(String id, String parentId, String name, Long pos, String targetId, String versionSeriesId)
void	begin()
protected Document	checkIn(String id, String label, String checkinComment)
protected void	checkNegativeAcl(ACP acp)
protected void	checkNotUnder(String parentId, String id, String op) Checks that we don't move/copy under ourselves.
protected void	checkOut(String id)
void	close() Closes this session.
void	commit()
static String	convToInternal(String name)
static String	convToInternalAce(String name)
static String	convToNXQL(String name)
Document	copy(Document source, Document parent, String name) Copies the source document to the given folder.
protected String	copy(String sourceId, String parentId, List<String> ancestorIds, String name) Copy source under parent, and set its ancestors.
protected String	copyRecurse(String sourceId, String parentId, LinkedList<String> ancestorIds, String name)
Document	createChild(String id, String parentId, String name, Long pos, String typeName)
protected DBSDocumentState	createChildState(String id, String parentId, String name, Long pos, String typeName)
Document	createProxy(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.
protected void	doOrderBy(List<Map<String,Serializable>> projections, OrderByClause orderByClause)
protected PartialList<String>	doQuery(String query, String queryType, QueryFilter queryFilter, int countUpTo)
protected PartialList<Map<String,Serializable>>	doQueryAndFetch(String query, String queryType, QueryFilter queryFilter, boolean distinctDocuments, int countUpTo, org.apache.commons.lang3.mutable.Mutable<String> idKeyHolder)
protected String	findFreeName(Document parent, String name)
protected ACP	getACP(Document doc)
Map<String,String>	getBinaryFulltext(String id) Gets the fulltext extracted from the binary fields.
protected BlobManager	getBlobManager()
protected Document	getChild(String parentId, String name)
protected List<Document>	getChildren(String parentId)
protected List<String>	getChildrenIds(String parentId)
protected DBSDocument	getDocument(DBSDocumentState docState)
protected DBSDocument	getDocument(DBSDocumentState docState, boolean readonly)
protected DBSDocument	getDocument(String id)
Document	getDocumentByUUID(String id) Gets a document given its ID.
protected String	getDocumentIdByPath(String path)
protected List<Document>	getDocuments(List<String> ids)
protected ACL	getInheritedACLs(Document doc)
protected Document	getLastVersion(String versionSeriesId)
LockManager	getLockManager() Gets the lock manager for this session.
ACP	getMergedACP(Document doc)
protected Long	getNextPos(String parentId)
Document	getNullDocument() Gets the null document, to be used as a fake parent to add placeless children.
protected String	getPath(Map<String,Serializable> projection)
List<Document>	getProxies(Document doc, Document folder) Finds the proxies for a document.
String	getRepositoryName() Gets the repository that created this session.
Document	getRootDocument() Gets the root document in this repository.
protected String	getRootId()
static Type	getType(String name)
Document	getVersion(String versionSeriesId, VersionModel versionModel) Gets a version of a document, given its versionable id and label.
protected DBSDocumentState	getVersionByLabel(String versionSeriesId, String label)
protected List<String>	getVersionsIds(String versionSeriesId)
protected boolean	hasChild(String parentId, String name)
protected boolean	hasChildren(String parentId)
Document	importDocument(String id, Document parent, String name, String typeName, Map<String,Serializable> properties) Imports a document with a given id and parent.
boolean	isLive() Checks whether the session is alive.
boolean	isNegativeAclAllowed() Returns true if negative ACLs are allowed.
protected boolean	isOrderable(String id)
protected boolean	isOrderByPath(OrderByClause orderByClause) Does an ORDER BY clause include ecm:path
protected boolean	keepWhenRestore(String key)
void	markUserChange(String id) Marks this document id as belonging to a user change.
protected static ACP	memToAcp(Serializable acpSer)
Document	move(Document source, Document parent, String name) Moves the source document to the given folder.
protected String	normalize(String path)
protected void	orderBefore(String parentId, String sourceId, String destId)
PartialList<Document>	query(String query, String queryType, QueryFilter queryFilter, long countUpTo) Does a query.
IterableQueryResult	queryAndFetch(String query, String queryType, QueryFilter queryFilter, boolean distinctDocuments, Object[] params) Does a query and fetch the individual results as maps.
PartialList<Map<String,Serializable>>	queryProjection(String query, String queryType, QueryFilter queryFilter, boolean distinctDocuments, long countUpTo, Object[] params) Does a query and fetch the individual results as maps.
protected void	recomputeVersionSeries(String versionSeriesId) Recomputes isLatest / isLatestMajor on all versions.
protected void	remove(String rootId) Removes a document.
protected void	removeBackProxyId(DBSDocumentState docState, String id)
protected void	removeBackProxyIds(DBSDocumentState docState, Set<String> ids)
Document	resolvePath(String path) Gets the document at the given path, if any.
protected void	restoreVersion(Document doc, Document version)
void	rollback()
void	save() Saves this session.
ScrollResult<String>	scroll(String scrollId) Get the next batch of result containing id of documents.
ScrollResult<String>	scroll(String query, 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.
void	setACP(Document doc, ACP acp, boolean overwrite)
void	setProxyTarget(Document proxy, Document target) Sets a proxies' target.
protected static Boolean	trueOrNull(Object value)
protected static ACP	updateACP(ACP curAcp, ACP addAcp) Returns the merge of two ACPs.
void	updateReadACLs(Collection<String> docIds) Updates the Read ACLs for some documents.

Methods inherited from class java.lang.Object

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

Field Detail

KEYS_RETENTION_ACTIVE_AND_PROXIES

protected static final Set<String> KEYS_RETENTION_ACTIVE_AND_PROXIES

repository

protected final DBSRepository repository

transaction

protected final DBSTransactionState transaction

fulltextSearchDisabled

protected final boolean fulltextSearchDisabled

changeTokenEnabled

protected final boolean changeTokenEnabled

closed

protected boolean closed

registry

protected final com.codahale.metrics.MetricRegistry registry

isLatestVersionDisabled

protected boolean isLatestVersionDisabled

dotDigitsPattern

protected static final Pattern dotDigitsPattern

STRING_ARRAY_TYPE

protected static final Type STRING_ARRAY_TYPE

Constructor Detail

DBSSession

public DBSSession(DBSRepository repository)

Method Detail

getRepositoryName

public String getRepositoryName()

Description copied from interface: Session

Gets the repository that created this session.

Specified by:

getRepositoryName in interface Session

Returns:

the repository

close

public void close()

Description copied from interface: Session

Closes this session. Does not save.

Specified by:

close in interface Session

isLive

public boolean isLive()

Description copied from interface: Session

Checks whether the session is alive.

Specified by:

isLive in interface Session

Returns:

true if the session is closed, false otherwise

save

public void save()

Description copied from interface: Session

Saves this session.

Specified by:

save in interface Session

begin

public void begin()

commit

public void commit()

rollback

public void rollback()

getBlobManager

protected BlobManager getBlobManager()

getRootId

protected String getRootId()

normalize

protected String normalize(String path)

resolvePath

public Document resolvePath(String path)

Description copied from interface: Session

Gets the document at the given path, if any.

Specified by:

resolvePath in interface Session

getDocumentIdByPath

protected String getDocumentIdByPath(String path)

getChild

protected Document getChild(String parentId,
                            String name)

getChildren

protected List<Document> getChildren(String parentId)

getChildrenIds

protected List<String> getChildrenIds(String parentId)

hasChildren

protected boolean hasChildren(String parentId)

getDocumentByUUID

public Document getDocumentByUUID(String id)

Description copied from interface: Session

Gets a document given its ID.

Specified by:

getDocumentByUUID in interface Session

Parameters:

id - the document id

Returns:

the document

getRootDocument

public Document getRootDocument()

Description copied from interface: Session

Gets the root document in this repository.

Specified by:

getRootDocument in interface Session

Returns:

the root document

getNullDocument

public Document getNullDocument()

Description copied from interface: Session

Gets the null document, to be used as a fake parent to add placeless children.

Specified by:

getNullDocument in interface Session

Returns:

the null document

getDocument

protected DBSDocument getDocument(String id)

getDocuments

protected List<Document> getDocuments(List<String> ids)

getDocument

protected DBSDocument getDocument(DBSDocumentState docState)

getDocument

protected DBSDocument getDocument(DBSDocumentState docState,
                                  boolean readonly)

hasChild

protected boolean hasChild(String parentId,
                           String name)

createChild

public Document createChild(String id,
                            String parentId,
                            String name,
                            Long pos,
                            String typeName)

createChildState

protected DBSDocumentState createChildState(String id,
                                            String parentId,
                                            String name,
                                            Long pos,
                                            String typeName)

isOrderable

protected boolean isOrderable(String id)

getNextPos

protected Long getNextPos(String parentId)

orderBefore

protected void orderBefore(String parentId,
                           String sourceId,
                           String destId)

checkOut

protected void checkOut(String id)

checkIn

protected Document checkIn(String id,
                           String label,
                           String checkinComment)

recomputeVersionSeries

protected void recomputeVersionSeries(String versionSeriesId)

Recomputes isLatest / isLatestMajor on all versions.

restoreVersion

protected void restoreVersion(Document doc,
                              Document version)

keepWhenRestore

protected boolean keepWhenRestore(String key)

copy

public Document copy(Document source,
                     Document parent,
                     String name)

Description copied from interface: Session

Copies the source document to the given folder.

If the destination document is not a folder, an exception is thrown.

Specified by:

copy in interface Session

copyRecurse

protected String copyRecurse(String sourceId,
                             String parentId,
                             LinkedList<String> ancestorIds,
                             String name)

copy

protected String copy(String sourceId,
                      String parentId,
                      List<String> ancestorIds,
                      String name)

Copy source under parent, and set its ancestors.

findFreeName

protected String findFreeName(Document parent,
                              String name)

checkNotUnder

protected void checkNotUnder(String parentId,
                             String id,
                             String op)

Checks that we don't move/copy under ourselves.

move

public Document move(Document source,
                     Document parent,
                     String name)

Description copied from interface: Session

Moves the source document to the given folder.

If the destination document is not a folder an exception is thrown.

Specified by:

move in interface Session

Parameters:

source - the source document to move

parent - the destination folder

name - the new name of the document or null if the original name should be preserved

remove

protected void remove(String rootId)

Removes a document.

We also have to update everything impacted by "relations":

• parent-child relations: delete all subchildren recursively,
• proxy-target relations: if a proxy is removed, update the target's PROXY_IDS; and if a target is removed, raise an error if a proxy still exists for that target.

createProxy

public Document createProxy(Document doc,
                            Document folder)

Description copied from interface: Session

Creates a generic proxy to the given document inside the given folder.

Specified by:

createProxy in interface Session

Parameters:

doc - the document

folder - the folder

Returns:

the proxy

addProxyState

protected DBSDocumentState addProxyState(String id,
                                         String parentId,
                                         String name,
                                         Long pos,
                                         String targetId,
                                         String versionSeriesId)

addBackProxyId

protected void addBackProxyId(DBSDocumentState docState,
                              String id)

removeBackProxyId

protected void removeBackProxyId(DBSDocumentState docState,
                                 String id)

removeBackProxyIds

protected void removeBackProxyIds(DBSDocumentState docState,
                                  Set<String> ids)

getProxies

public List<Document> getProxies(Document doc,
                                 Document folder)

Description copied from interface: Session

Finds the proxies for a document. If the folder is not null, the search will be limited to its children.

If the document is a version, then only proxies to that version will be looked up.

Specified by:

getProxies in interface Session

Parameters:

doc - the document or version

folder - the folder, or null

Returns:

the list of proxies if any is found otherwise an empty list

setProxyTarget

public void setProxyTarget(Document proxy,
                           Document target)

Description copied from interface: Session

Sets a proxies' target.

The target must have the same version series as the proxy.

Specified by:

setProxyTarget in interface Session

Parameters:

proxy - the proxy

target - the new target

importDocument

public Document importDocument(String id,
                               Document parent,
                               String name,
                               String typeName,
                               Map<String,Serializable> properties)

Description copied from interface: Session

Imports a document with a given id and parent.

The document can then be filled with the normal imported properties.

Specified by:

importDocument in interface Session

Parameters:

id - the document uuid

parent - the document parent, or null for a version

name - the document name in its parent

typeName - the document type, or ecm:proxy for a proxy

properties - system properties of the document, which will vary depending whether it's a live document, a version or a proxy (see the various IMPORT_* constants of CoreSession)

Returns:

a writable Document, even for proxies and versions

trueOrNull

protected static Boolean trueOrNull(Object value)

getVersion

public Document getVersion(String versionSeriesId,
                           VersionModel versionModel)

Description copied from interface: Session

Gets a version of a document, given its versionable id and label.

The version model contains the label of the version to look for. On return, it is filled with the version's description and creation date.

Specified by:

getVersion in interface Session

Parameters:

versionSeriesId - the versionable id

versionModel - the version model

Returns:

the version, or null if not found

getVersionByLabel

protected DBSDocumentState getVersionByLabel(String versionSeriesId,
                                             String label)

getVersionsIds

protected List<String> getVersionsIds(String versionSeriesId)

getLastVersion

protected Document getLastVersion(String versionSeriesId)

updateReadACLs

public void updateReadACLs(Collection<String> docIds)

Description copied from interface: Session

Updates the Read ACLs for some documents.

Specified by:

updateReadACLs in interface Session

Parameters:

docIds - the document ids

isNegativeAclAllowed

public boolean isNegativeAclAllowed()

Description copied from interface: Session

Returns true if negative ACLs are allowed.

Negative ACLs are ACLs that include an ACE with a deny (isGranted=false). This does not include the full-blocking ACE for Everyone/Everything, which is always allowed.

Specified by:

isNegativeAclAllowed in interface Session

Returns:

true if negative ACLs are allowed

getMergedACP

public ACP getMergedACP(Document doc)

Specified by:

getMergedACP in interface Session

getInheritedACLs

protected ACL getInheritedACLs(Document doc)

getACP

protected ACP getACP(Document doc)

setACP

public void setACP(Document doc,
                   ACP acp,
                   boolean overwrite)

Specified by:

setACP in interface Session

checkNegativeAcl

protected void checkNegativeAcl(ACP acp)

updateACP

protected static ACP updateACP(ACP curAcp,
                               ACP addAcp)

Returns the merge of two ACPs.

acpToMem

protected static Serializable acpToMem(ACP acp)

memToAcp

protected static ACP memToAcp(Serializable acpSer)

getBinaryFulltext

public Map<String,String> getBinaryFulltext(String id)

Description copied from interface: Session

Gets the fulltext extracted from the binary fields.

Specified by:

getBinaryFulltext in interface Session

query

public PartialList<Document> query(String query,
                                   String queryType,
                                   QueryFilter queryFilter,
                                   long countUpTo)

Description copied from interface: Session

Does a query.

Specified by:

query in interface Session

doQuery

protected PartialList<String> doQuery(String query,
                                      String queryType,
                                      QueryFilter queryFilter,
                                      int countUpTo)

doQueryAndFetch

protected PartialList<Map<String,Serializable>> doQueryAndFetch(String query,
                                                                String queryType,
                                                                QueryFilter queryFilter,
                                                                boolean distinctDocuments,
                                                                int countUpTo,
                                                                org.apache.commons.lang3.mutable.Mutable<String> idKeyHolder)

isOrderByPath

protected boolean isOrderByPath(OrderByClause orderByClause)

Does an ORDER BY clause include ecm:path

getPath

protected String getPath(Map<String,Serializable> projection)

doOrderBy

protected void doOrderBy(List<Map<String,Serializable>> projections,
                         OrderByClause orderByClause)

queryAndFetch

public IterableQueryResult queryAndFetch(String query,
                                         String queryType,
                                         QueryFilter queryFilter,
                                         boolean distinctDocuments,
                                         Object[] params)

Description copied from interface: Session

Does a query and fetch the individual results as maps.

Specified by:

queryAndFetch in interface Session

queryProjection

public PartialList<Map<String,Serializable>> queryProjection(String query,
                                                             String queryType,
                                                             QueryFilter queryFilter,
                                                             boolean distinctDocuments,
                                                             long countUpTo,
                                                             Object[] params)

Description copied from interface: Session

Does a query and fetch the individual results as maps.

Specified by:

queryProjection in interface Session

scroll

public ScrollResult<String> scroll(String query,
                                   int batchSize,
                                   int keepAliveSeconds)

Description copied from interface: Session

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

Specified by:

scroll in interface Session

scroll

public ScrollResult<String> scroll(String scrollId)

Description copied from interface: Session

Get the next batch of result containing id of documents.

Specified by:

scroll in interface Session

convToInternal

public static String convToInternal(String name)

convToInternalAce

public static String convToInternalAce(String name)

convToNXQL

public static String convToNXQL(String name)

getType

public static Type getType(String name)

getLockManager

public LockManager getLockManager()

Description copied from interface: Session

Gets the lock manager for this session.

Specified by:

getLockManager in interface Session

Returns:

the lock manager

markUserChange

public void markUserChange(String id)

Marks this document id as belonging to a user change.

Since:

9.2