org.nuxeo.ecm.core.model

Interface Session

All Known Implementing Classes:

DBSSession, SQLSession

public interface Session

Internal Session accessing the low-level storage.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this session.
Document	copy(Document src, Document dst, 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.
Map<String,String>	getBinaryFulltext(String id) Gets the fulltext extracted from the binary fields.
Document	getDocumentByUUID(String uuid) 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 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 src, Document dst, 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.

Field Detail

USER_NAME

static final String USER_NAME

See Also:

Constant Field Values

Method Detail

getSessionId

String getSessionId()

Gets the session id.

Returns:

the session id

getRepositoryName

String getRepositoryName()

Gets the repository that created this session.

Returns:

the repository

query

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

Does a query.

Throws:

QueryException

Since:

5.9.4

queryAndFetch

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

Does a query and fetch the individual results as maps.

Throws:

QueryException

save

void save()
          throws DocumentException

Saves this session.

Throws:

DocumentException - if any error occurs

isLive

boolean isLive()

Checks whether the session is alive.

Returns:

true if the session is closed, false otherwise

isStateSharedByAllThreadSessions

boolean isStateSharedByAllThreadSessions()

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

close

void close()

Closes this session. Does not save.

Throws:

DocumentException - if any error occurs

resolvePath

Document resolvePath(String path)
                     throws DocumentException

Gets the document at the given path, if any.

Parameters:

path -

Returns:

Throws:

DocumentException - if any error occurs

getDocumentByUUID

Document getDocumentByUUID(String uuid)
                           throws DocumentException

Gets a document given its ID.

Parameters:

uuid - the document id

Returns:

the document

Throws:

DocumentException - if any error occurs

getRootDocument

Document getRootDocument()
                         throws DocumentException

Gets the root document in this repository.

Returns:

the root document

Throws:

DocumentException - if any error occurs

getNullDocument

Document getNullDocument()
                         throws DocumentException

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

Returns:

the null document

Throws:

DocumentException

copy

Document copy(Document src,
            Document dst,
            String name)
              throws DocumentException

Copies the source document to the given folder.

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

Parameters:

src -

dst -

name -

Throws:

DocumentException - if any error occurs

move

Document move(Document src,
            Document dst,
            String name)
              throws DocumentException

Moves the source document to the given folder.

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

Parameters:

src - the source document to move

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

Document createProxy(Document doc,
                   Document folder)
                     throws DocumentException

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

Parameters:

doc - the document

folder - the folder

Returns:

the proxy

Throws:

DocumentException - if any error occurs

getProxies

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

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.

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

Since:

1.4.1 for the case where doc is a proxy

setProxyTarget

void setProxyTarget(Document proxy,
                  Document target)
                    throws DocumentException

Sets a proxies' target.

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

Parameters:

proxy - the proxy

target - the new target

Throws:

DocumentException

Since:

5.5

importDocument

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

Imports a document with a given id and parent.

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

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

getVersion

Document getVersion(String versionableId,
                  VersionModel versionModel)
                    throws DocumentException

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.

Parameters:

versionableId - the versionable id

versionModel - the version model

Returns:

the version, or null if not found

Throws:

DocumentException

isNegativeAclAllowed

boolean isNegativeAclAllowed()

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.

Returns:

true if negative ACLs are allowed

Since:

6.0

getMergedACP

ACP getMergedACP(Document doc)
                 throws SecurityException

Throws:

SecurityException

setACP

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

Throws:

DocumentException

getBinaryFulltext

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

Gets the fulltext extracted from the binary fields.

Throws:

DocumentException

Since:

5.9.3