Package | Description |
---|---|
org.nuxeo.ecm.core.api | |
org.nuxeo.ecm.core.lifecycle |
LifeCycle API.
|
org.nuxeo.ecm.core.lifecycle.impl |
Implementation of the LifeCycle API.
|
org.nuxeo.ecm.core.model | |
org.nuxeo.ecm.core.security | |
org.nuxeo.ecm.core.storage.sql.coremodel | |
org.nuxeo.ecm.core.versioning | |
org.nuxeo.ecm.platform.sync.security |
Modifier and Type | Method and Description |
---|---|
static Document |
DocumentResolver.resolveReference(Session session,
DocumentRef docRef)
Resolves the document given its reference.
|
Modifier and Type | Method and Description |
---|---|
static DataModel |
DocumentModelFactory.createDataModel(Document doc,
Schema schema)
Creates a data model from a document and a schema.
|
static DocumentModelImpl |
DocumentModelFactory.createDocumentModel(Document doc) |
static DocumentModelImpl |
DocumentModelFactory.createDocumentModel(Document doc,
String[] schemas)
Creates a document model for an existing document.
|
String |
AbstractSession.generateDocumentName(Document parent,
String name)
Generate a non-null unique name within given parent's children.
|
static DocumentModel.DocumentModelRefresh |
DocumentModelFactory.refreshDocumentModel(Document doc,
int flags,
String[] schemas)
Gets what's to refresh in a model (except for the ACPs, which need the
session).
|
static DocumentModel |
DocumentModelFactory.writeDocumentModel(DocumentModel docModel,
Document doc)
Writes a document model to a document.
|
Modifier and Type | Method and Description |
---|---|
void |
LifeCycleService.followTransition(Document doc,
String transitionName)
Follows a given transition.
|
LifeCycle |
LifeCycleService.getLifeCycleFor(Document doc)
Returns the life cycle a given document follows.
|
void |
LifeCycleService.initialize(Document doc)
Initializes the life cycle for the given document.
|
void |
LifeCycleService.initialize(Document doc,
String initialStateName)
Initializes the life cycle for the given document.
|
void |
LifeCycleService.reinitLifeCycle(Document doc)
Sets the current state to the initial state as defined by the associated
lifecycle.
|
Modifier and Type | Method and Description |
---|---|
void |
LifeCycleServiceImpl.followTransition(Document doc,
String transitionName) |
LifeCycle |
LifeCycleServiceImpl.getLifeCycleFor(Document doc) |
void |
LifeCycleServiceImpl.initialize(Document doc) |
void |
LifeCycleServiceImpl.initialize(Document doc,
String initialStateName) |
void |
LifeCycleServiceImpl.reinitLifeCycle(Document doc) |
Modifier and Type | Interface and Description |
---|---|
interface |
DocumentProxy
Methods specific to a proxy.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractDocument
Abstract document that implements code independent on the model
implementation.
|
class |
MockDocument |
Modifier and Type | Method and Description |
---|---|
Document |
MockDocument.addChild(String name,
String typeName) |
Document |
DocumentContainer.addChild(String name,
String typeName)
Creates a new child document given its typename.
|
Document |
MockDocument.checkIn(String label,
String description) |
Document |
Session.copy(Document src,
Document dst,
String name)
Copies the source document to the given folder.
|
Document |
Session.createProxy(Document doc,
Document folder)
Creates a generic proxy to the given document inside the given folder.
|
Document |
MockDocument.getBaseVersion() |
Document |
MockDocument.getChild(String name) |
Document |
DocumentContainer.getChild(String name)
Gets a child document given its name.
|
Document |
Session.getDocumentByUUID(String uuid)
Gets a document given its ID.
|
Document |
MockDocument.getLastVersion() |
Document |
Session.getNullDocument()
Gets the null document, to be used as a fake parent to add placeless
children.
|
Document |
MockDocument.getParent() |
Document |
Document.getParent()
Gets the parent document or null if this is the root document.
|
Document |
Session.getRootDocument()
Gets the root document in this repository.
|
Document |
MockDocument.getSourceDocument() |
Document |
DocumentProxy.getTargetDocument()
Gets the document (version or live document) to which this proxy points.
|
Document |
MockDocument.getVersion(String label) |
Document |
Session.getVersion(String versionableId,
VersionModel versionModel)
Gets a version of a document, given its versionable id and label.
|
Document |
MockDocument.getWorkingCopy() |
Document |
Session.importDocument(String uuid,
Document parent,
String name,
String typeName,
Map<String,Serializable> properties)
Imports a document with a given id and parent.
|
Document |
Session.move(Document src,
Document dst,
String name)
Moves the source document to the given folder.
|
Document |
EmptyDocumentIterator.next() |
Document |
Session.resolvePath(String path)
Gets the document at the given path, if any.
|
Document |
MockDocument.resolvePath(String relPath) |
Document |
DocumentContainer.resolvePath(String relPath)
Resolves a document given its relative path to the current document.
|
Modifier and Type | Method and Description |
---|---|
Iterator<Document> |
MockDocument.getChildren() |
Iterator<Document> |
DocumentContainer.getChildren()
Gets an iterator over the children of the document.
|
Collection<Document> |
Session.getProxies(Document doc,
Document folder)
Finds the proxies for a document.
|
List<Document> |
MockDocument.getVersions() |
Modifier and Type | Method and Description |
---|---|
int |
PathComparator.compare(Document o1,
Document o2) |
Document |
Session.copy(Document src,
Document dst,
String name)
Copies the source document to the given folder.
|
Document |
Session.createProxy(Document doc,
Document folder)
Creates a generic proxy to the given document inside the given folder.
|
Collection<Document> |
Session.getProxies(Document doc,
Document folder)
Finds the proxies for a document.
|
Document |
Session.importDocument(String uuid,
Document parent,
String name,
String typeName,
Map<String,Serializable> properties)
Imports a document with a given id and parent.
|
Document |
Session.move(Document src,
Document dst,
String name)
Moves the source document to the given folder.
|
void |
MockDocument.restore(Document version) |
void |
Session.setProxyTarget(Document proxy,
Document target)
Sets a proxies' target.
|
void |
DocumentProxy.setTargetDocument(Document target)
Sets the document (version or live document) to which this proxy points.
|
Modifier and Type | Method and Description |
---|---|
Access |
SecurityPolicyServiceImpl.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] additionalPrincipals) |
Access |
SecurityPolicyService.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] principalsToCheck)
Checks given permission for doc and principal.
|
Access |
SecurityPolicy.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] additionalPrincipals)
Checks given permission for doc and principal.
|
Access |
LockSecurityPolicy.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] additionalPrincipals) |
Access |
CheckInSecurityPolicy.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] additionalPrincipals) |
boolean |
SecurityService.checkPermission(Document doc,
Principal principal,
String permission) |
boolean |
SecurityManager.checkPermission(Document doc,
String username,
String permission)
Checks whether this ACP grant the given permission on the given user.
|
Access |
SecurityManager.getAccess(Document doc,
String username,
String permission)
Checks whether this ACP grant the given permission on the given user, denies it or
doesn't specify a rule.
|
ACP |
SecurityManager.getACP(Document doc) |
ACP |
SecurityManager.getMergedACP(Document doc) |
static List<SecuritySummaryEntry> |
SecurityService.getSecuritySummary(Document doc,
Boolean includeParents) |
void |
SecurityManager.setACP(Document doc,
ACP acp,
boolean overwrite) |
Modifier and Type | Interface and Description |
---|---|
interface |
SQLDocument
Base interface for SQL documents.
|
Modifier and Type | Class and Description |
---|---|
class |
SQLDocumentLive |
class |
SQLDocumentProxy
A proxy is a shortcut to a target document (a version or normal document).
|
class |
SQLDocumentVersion |
Modifier and Type | Method and Description |
---|---|
Document |
SQLDocumentVersion.addChild(String name,
String typeName) |
Document |
SQLDocumentProxy.addChild(String name,
String typeName) |
Document |
SQLDocumentLive.addChild(String name,
String typeName) |
Document |
SQLDocumentVersion.checkIn(String label,
String description) |
Document |
SQLDocumentProxy.checkIn(String label,
String checkinComment) |
Document |
SQLDocumentLive.checkIn(String label,
String checkinComment) |
Document |
SQLSession.copy(Document source,
Document parent,
String name) |
Document |
SQLSession.createProxy(Document doc,
Document folder) |
Document |
SQLDocumentVersion.getBaseVersion() |
Document |
SQLDocumentProxy.getBaseVersion() |
Document |
SQLDocumentLive.getBaseVersion() |
Document |
SQLDocumentVersion.getChild(String name) |
Document |
SQLDocumentProxy.getChild(String name) |
Document |
SQLDocumentLive.getChild(String name) |
Document |
SQLSession.getDocumentByUUID(String uuid) |
Document |
SQLDocumentVersion.getLastVersion() |
Document |
SQLDocumentProxy.getLastVersion() |
Document |
SQLDocumentLive.getLastVersion() |
Document |
SQLSession.getLastVersion(Serializable versionSeriesId) |
Document |
SQLSession.getNullDocument() |
Document |
SQLDocumentVersion.getParent() |
Document |
SQLDocumentProxy.getParent() |
Document |
SQLDocumentLive.getParent() |
Document |
SQLSession.getRootDocument() |
Document |
SQLDocumentVersion.getSourceDocument() |
Document |
SQLDocumentProxy.getSourceDocument() |
Document |
SQLDocumentLive.getSourceDocument() |
Document |
SQLDocumentProxy.getTargetDocument() |
Document |
SQLDocumentVersion.getVersion(String label) |
Document |
SQLDocumentProxy.getVersion(String label) |
Document |
SQLDocumentLive.getVersion(String label) |
Document |
SQLSession.getVersion(String versionableId,
VersionModel versionModel) |
Document |
SQLDocumentVersion.getWorkingCopy() |
Document |
SQLDocumentProxy.getWorkingCopy() |
Document |
SQLDocumentLive.getWorkingCopy() |
Document |
SQLSession.importDocument(String uuid,
Document parent,
String name,
String typeName,
Map<String,Serializable> properties) |
Document |
SQLSession.move(Document source,
Document parent,
String name) |
Document |
SQLSession.resolvePath(String path) |
Document |
SQLDocumentProxy.resolvePath(String path) |
Document |
SQLDocumentLive.resolvePath(String path) |
Modifier and Type | Method and Description |
---|---|
Iterator<Document> |
SQLDocumentVersion.getChildren() |
Iterator<Document> |
SQLDocumentProxy.getChildren() |
Iterator<Document> |
SQLDocumentLive.getChildren() |
Collection<Document> |
SQLSession.getProxies(Document document,
Document parent) |
List<Document> |
SQLDocumentVersion.getVersions() |
List<Document> |
SQLDocumentProxy.getVersions() |
List<Document> |
SQLDocumentLive.getVersions() |
Modifier and Type | Method and Description |
---|---|
boolean |
SQLSecurityManager.checkPermission(Document doc,
String username,
String permission) |
Document |
SQLSession.copy(Document source,
Document parent,
String name) |
Document |
SQLSession.createProxy(Document doc,
Document folder) |
Access |
SQLSecurityManager.getAccess(Document doc,
String username,
String permission) |
ACP |
SQLSecurityManager.getACP(Document doc) |
ACP |
SQLSecurityManager.getMergedACP(Document doc) |
Collection<Document> |
SQLSession.getProxies(Document document,
Document parent) |
Document |
SQLSession.importDocument(String uuid,
Document parent,
String name,
String typeName,
Map<String,Serializable> properties) |
Document |
SQLSession.move(Document source,
Document parent,
String name) |
void |
SQLDocumentVersion.restore(Document version) |
void |
SQLDocumentProxy.restore(Document version) |
void |
SQLDocumentLive.restore(Document version) |
void |
SQLSecurityManager.setACP(Document doc,
ACP acp,
boolean overwrite) |
void |
SQLSession.setProxyTarget(Document proxy,
Document target) |
void |
SQLDocumentProxy.setTargetDocument(Document target) |
Modifier and Type | Method and Description |
---|---|
Document |
VersionableDocument.checkIn(String label,
String checkinComment)
Creates a new version.
|
Document |
VersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment)
Applies version increment option and does a checkin.
|
Document |
VersioningComponent.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
Document |
StandardVersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
Document |
CompatVersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
Document |
VersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options)
Applies versioning options after document save.
|
Document |
VersioningComponent.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
Document |
StandardVersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
Document |
CompatVersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
Document |
VersionableDocument.getBaseVersion()
Gets the version to which a checked in document is linked.
|
Document |
VersionableDocument.getLastVersion()
Gets the last version of this document.
|
Document |
VersionableDocument.getSourceDocument()
Gets the head ("live") version of this document.
|
Document |
VersionableDocument.getVersion(String label)
Gets a version of this document, given its label.
|
Document |
VersionableDocument.getWorkingCopy() |
Modifier and Type | Method and Description |
---|---|
List<Document> |
VersionableDocument.getVersions() |
Modifier and Type | Method and Description |
---|---|
Document |
VersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment)
Applies version increment option and does a checkin.
|
Document |
VersioningComponent.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
Document |
StandardVersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
Document |
CompatVersioningService.doCheckIn(Document doc,
VersioningOption option,
String checkinComment) |
void |
VersioningService.doCheckOut(Document doc)
Apply modifications after doing a checkout.
|
void |
VersioningComponent.doCheckOut(Document doc) |
void |
StandardVersioningService.doCheckOut(Document doc) |
void |
CompatVersioningService.doCheckOut(Document doc) |
void |
VersioningService.doPostCreate(Document doc,
Map<String,Serializable> options)
Applies versioning after document creation.
|
void |
VersioningComponent.doPostCreate(Document doc,
Map<String,Serializable> options) |
void |
StandardVersioningService.doPostCreate(Document doc,
Map<String,Serializable> options) |
Document |
VersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options)
Applies versioning options after document save.
|
Document |
VersioningComponent.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
Document |
StandardVersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
Document |
CompatVersioningService.doPostSave(Document doc,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
VersioningOption |
VersioningService.doPreSave(Document doc,
boolean isDirty,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options)
Applies versioning options before document save.
|
VersioningOption |
VersioningComponent.doPreSave(Document doc,
boolean isDirty,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
VersioningOption |
StandardVersioningService.doPreSave(Document doc,
boolean isDirty,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
VersioningOption |
CompatVersioningService.doPreSave(Document doc,
boolean isDirty,
VersioningOption option,
String checkinComment,
Map<String,Serializable> options) |
void |
VersionRemovalPolicy.removeVersions(Session session,
Document doc,
CoreSession coreSession)
Removes the versions when a given working document is about to be
removed.
|
void |
NullVersionRemovalPolicy.removeVersions(Session session,
Document doc,
CoreSession coreSession) |
void |
DefaultVersionRemovalPolicy.removeVersions(Session session,
Document doc,
CoreSession coreSession) |
void |
VersionableDocument.restore(Document version)
Replaces current version with version specified.
|
Modifier and Type | Method and Description |
---|---|
Access |
ReadSecurityPolicy.checkPermission(Document doc,
ACP mergedAcp,
Principal principal,
String permission,
String[] resolvedPermissions,
String[] additionalPrincipals) |
Copyright © 2012 Nuxeo SA. All Rights Reserved.