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
static class	DBSSession.DBSDocumentListIterator

Field Summary

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

USER_NAME

Constructor Summary

Constructors

Constructor and Description
DBSSession(DBSRepository repository, String sessionId)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this session.
void	commit()
static String	convToInternal(String name)
static String	convToNXQL(String name)
Document	copy(Document source, Document parent, String name) Copies the source document to the given folder.
Document	createChild(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.
Map<String,String>	getBinaryFulltext(String id) Gets the fulltext extracted from the binary fields.
Document	getDocumentByUUID(String id) Gets a document given its ID.
ACP	getMergedACP(Document doc)
Document	getNullDocument() Gets the null document, to be used as a fake parent to add placeless children.
Collection<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.
String	getSessionId() Gets the session id.
Document	getVersion(String versionSeriesId, VersionModel versionModel) Gets a version of a document, given its versionable id and label.
Document	importDocument(String id, Document parent, String name, String typeName, Map<String,Serializable> properties) Imports a document with a given id and parent.
static boolean	isArray(String name)
static boolean	isBoolean(String name)
boolean	isLive() Checks whether the session is alive.
boolean	isNegativeAclAllowed() Returns true if negative ACLs are allowed.
boolean	isStateSharedByAllThreadSessions() Returns true if all sessions in the current thread share the same state.
Document	move(Document source, Document parent, String name) Moves the source document to the given folder.
DocumentModelList	query(String query, String queryType, QueryFilter queryFilter, long countUpTo) Does a query.
IterableQueryResult	queryAndFetch(String query, String queryType, QueryFilter queryFilter, Object[] params) Does a query and fetch the individual results as maps.
Document	resolvePath(String path) Gets the document at the given path, if any.
void	save() Saves this session.
void	setACP(Document doc, ACP acp, boolean overwrite)
void	setProxyTarget(Document proxy, Document target) Sets a proxies' target.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBSSession

public DBSSession(DBSRepository repository,
          String sessionId)

Method Detail

getSessionId

public String getSessionId()

Description copied from interface: Session

Gets the session id.

Specified by:

getSessionId in interface Session

Returns:

the session id

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()
          throws DocumentException

Description copied from interface: Session

Saves this session.

Specified by:

save in interface Session

Throws:

DocumentException - if any error occurs

commit

public void commit()
            throws DocumentException

Throws:

DocumentException

isStateSharedByAllThreadSessions

public boolean isStateSharedByAllThreadSessions()

Description copied from interface: Session

Returns true if all sessions in the current thread share the same state.

Specified by:

isStateSharedByAllThreadSessions in interface Session

resolvePath

public Document resolvePath(String path)
                     throws DocumentException

Description copied from interface: Session

Gets the document at the given path, if any.

Specified by:

resolvePath in interface Session

Returns:

Throws:

DocumentException - if any error occurs

getDocumentByUUID

public Document getDocumentByUUID(String id)
                           throws DocumentException

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

Throws:

DocumentException - if any error occurs

getRootDocument

public Document getRootDocument()
                         throws DocumentException

Description copied from interface: Session

Gets the root document in this repository.

Specified by:

getRootDocument in interface Session

Returns:

the root document

Throws:

DocumentException - if any error occurs

getNullDocument

public Document getNullDocument()
                         throws DocumentException

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

Throws:

DocumentException

createChild

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

Throws:

DocumentException

copy

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

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

Throws:

DocumentException - if any error occurs

move

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

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

Throws:

DocumentException - if any error occurs

createProxy

public Document createProxy(Document doc,
                   Document folder)
                     throws DocumentException

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

Throws:

DocumentException - if any error occurs

getProxies

public Collection<Document> getProxies(Document doc,
                              Document folder)
                                throws DocumentException

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

Throws:

DocumentException - if any error occurs

setProxyTarget

public void setProxyTarget(Document proxy,
                  Document target)
                    throws DocumentException

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

Throws:

DocumentException

importDocument

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

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

Throws:

DocumentException

getVersion

public Document getVersion(String versionSeriesId,
                  VersionModel versionModel)
                    throws DocumentException

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

Throws:

DocumentException

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)
                 throws SecurityException

Specified by:

getMergedACP in interface Session

Throws:

SecurityException

setACP

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

Specified by:

setACP in interface Session

Throws:

DocumentException

getBinaryFulltext

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

Description copied from interface: Session

Gets the fulltext extracted from the binary fields.

Specified by:

getBinaryFulltext in interface Session

Throws:

DocumentException

query

public DocumentModelList query(String query,
                      String queryType,
                      QueryFilter queryFilter,
                      long countUpTo)
                        throws QueryException

Description copied from interface: Session

Does a query.

Specified by:

query in interface Session

Throws:

QueryException

queryAndFetch

public IterableQueryResult queryAndFetch(String query,
                                String queryType,
                                QueryFilter queryFilter,
                                Object[] params)
                                  throws QueryException

Description copied from interface: Session

Does a query and fetch the individual results as maps.

Specified by:

queryAndFetch in interface Session

Throws:

QueryException

convToInternal

public static String convToInternal(String name)

convToNXQL

public static String convToNXQL(String name)

isArray

public static boolean isArray(String name)

isBoolean

public static boolean isBoolean(String name)