org.nuxeo.ecm.core.storage.sql.coremodel

Class SQLSession

java.lang.Object

org.nuxeo.ecm.core.storage.sql.coremodel.SQLSession

All Implemented Interfaces:

Session

public class SQLSession
extends Object
implements Session

This class is the bridge between the Nuxeo SPI Session and the actual low-level implementation of the SQL storage session.

Author:

Florent Guillaume

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SQLSession.PathComparator

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_NEGATIVE_ACL_PROPERTY Framework property to control whether negative ACLs (deny) are allowed.
static String	APPLICATION_OCTET_STREAM
static String	BLOB_DATA
static String	BLOB_DIGEST
static String	BLOB_ENCODING
static String	BLOB_LENGTH
static String	BLOB_MIME_TYPE
static String	BLOB_NAME
static String	DC_ISSUED
static String	RELATED_TEXT
static String	RELATED_TEXT_ID
static String	RELATED_TEXT_RESOURCES

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

USER_NAME

Constructor Summary

Constructors

Constructor and Description
SQLSession(Session session, Repository repository, String sessionId)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this session.
Document	copy(Document source, Document parent, String name) Copies the source document to the given folder.
Document	createProxy(Document doc, Document folder) Creates a generic proxy to the given document inside the given folder.
Binary	getBinary(Blob blob)
Map<String,String>	getBinaryFulltext(String id) Gets the fulltext extracted from the binary fields.
Document	getDocumentByUUID(String uuid) Gets a document given its ID.
Document	getLastVersion(String versionSeriesId)
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 document, Document parent) 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 versionableId, VersionModel versionModel) Gets a version of a document, given its versionable id and label.
Document	importDocument(String uuid, 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.
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.
Map<String,Serializable>	readPrefetch(Node node, ComplexType complexType, Set<String> xpaths) Recursively reads prefetched properties.
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

Field Detail

ALLOW_NEGATIVE_ACL_PROPERTY

public static final String ALLOW_NEGATIVE_ACL_PROPERTY

Framework property to control whether negative ACLs (deny) are allowed.

Since:

6.0

See Also:

Constant Field Values

BLOB_NAME

public static final String BLOB_NAME

See Also:

Constant Field Values

BLOB_MIME_TYPE

public static final String BLOB_MIME_TYPE

See Also:

Constant Field Values

BLOB_ENCODING

public static final String BLOB_ENCODING

See Also:

Constant Field Values

BLOB_DIGEST

public static final String BLOB_DIGEST

See Also:

Constant Field Values

BLOB_LENGTH

public static final String BLOB_LENGTH

See Also:

Constant Field Values

BLOB_DATA

public static final String BLOB_DATA

See Also:

Constant Field Values

APPLICATION_OCTET_STREAM

public static final String APPLICATION_OCTET_STREAM

See Also:

Constant Field Values

DC_ISSUED

public static final String DC_ISSUED

See Also:

Constant Field Values

RELATED_TEXT_RESOURCES

public static final String RELATED_TEXT_RESOURCES

See Also:

Constant Field Values

RELATED_TEXT_ID

public static final String RELATED_TEXT_ID

See Also:

Constant Field Values

RELATED_TEXT

public static final String RELATED_TEXT

See Also:

Constant Field Values

Constructor Detail

SQLSession

public SQLSession(Session session,
          Repository repository,
          String sessionId)
           throws DocumentException

Throws:

DocumentException

Method Detail

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

close

public void close()

Description copied from interface: Session

Closes this session. Does not save.

Specified by:

close in interface Session

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

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

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

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

getDocumentByUUID

public Document getDocumentByUUID(String uuid)
                           throws DocumentException

Description copied from interface: Session

Gets a document given its ID.

Specified by:

getDocumentByUUID in interface Session

Parameters:

uuid - the document id

Returns:

the document

Throws:

DocumentException - if any error occurs

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

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

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

getVersion

public Document getVersion(String versionableId,
                  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:

versionableId - the versionable id

versionModel - the version model

Returns:

the version, or null if not found

Throws:

DocumentException

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 document,
                              Document parent)
                                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:

document - the document or version

parent - 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 uuid,
                      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:

uuid - 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

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

getLastVersion

public Document getLastVersion(String versionSeriesId)
                        throws DocumentException

Throws:

DocumentException

readPrefetch

public Map<String,Serializable> readPrefetch(Node node,
                                    ComplexType complexType,
                                    Set<String> xpaths)
                                      throws PropertyException

Recursively reads prefetched properties.

Throws:

PropertyException

Since:

5.9.4

getBinary

public Binary getBinary(Blob blob)
                 throws DocumentException

Parameters:

blob -

Returns:

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

setACP

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

Specified by:

setACP in interface Session

Throws:

SecurityException

getMergedACP

public ACP getMergedACP(Document doc)
                 throws SecurityException

Specified by:

getMergedACP in interface Session

Throws:

SecurityException

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