Package org.nuxeo.ecm.core.storage.dbs

Class DBSDocument

java.lang.Object
org.nuxeo.ecm.core.storage.BaseDocument<State>
org.nuxeo.ecm.core.storage.dbs.DBSDocument
All Implemented Interfaces:
Document
public class DBSDocument extends BaseDocument<State>
Implementation of a Document for Document-Based Storage. The document is stored as a JSON-like Map. The keys of the Map are the property names (including special names for system properties), and the values Map are Serializable values, either:
  • a scalar (String, Long, Double, Boolean, Calendar, Binary),
  • an array of scalars,
  • a List of Maps, recursively,
  • or another Map, recursively.
An ACP value is stored as a list of maps. Each map has a keys for the ACL name and the actual ACL which is a list of ACEs. An ACE is a map having as keys username, permission, and grant.
Since:
5.9.4

  • Field Details

  • Constructor Details

  • Method Details

    • getType

      public DocumentType getType()
      Description copied from interface: Document
      Gets the type of this document.
      Returns:
      the document type

    • getSession

      public Session getSession()
      Description copied from interface: Document
      Gets the session that owns this document.
      Returns:
      the session

    • getRepositoryName

      public String getRepositoryName()
      Description copied from interface: Document
      Gets the repository in which the document lives.
      Returns:
      the repository name.

    • getProxySchemas

      protected List<Schema> getProxySchemas()
      Description copied from class: BaseDocument
      Gets the list of proxy schemas, if this is a proxy.
      Specified by:
      getProxySchemas in class BaseDocument<State>
      Returns:
      the proxy schemas, or null

    • getUUID

      public String getUUID()
      Description copied from interface: Document
      Gets this document's UUID.
      Returns:
      the document UUID

    • getName

      public String getName()
      Description copied from interface: Document
      Gets the name of this document.
      Returns:
      the document name

    • getPos

      public Long getPos()
      Description copied from interface: Document
      Gets the document's position in its containing folder (if ordered).
      Returns:
      the position

    • getParent

      public Document getParent()
      Description copied from interface: Document
      Gets the parent document, or null if this is the root document.
      Returns:
      the parent document, or null

    • isProxy

      public boolean isProxy()
      Description copied from interface: Document
      Checks whether or not this document is a proxy.
      Returns:
      true if this document is a proxy, false otherwise

    • isVersion

      public boolean isVersion()
      Description copied from interface: Document
      Checks whether this document is a version document.
      Returns:
      true if it's a version, false otherwise

    • getPath

      public String getPath()
      Description copied from interface: Document
      Gets the path of this document.
      Returns:
      the path

    • getChild

      public Document getChild(String name)
      Description copied from interface: Document
      Gets a child document given its name.

      Throws DocumentNotFoundException if the document could not be found.

      Parameters:
      name - the name of the child to retrieve
      Returns:
      the child if exists

    • getChildren

      public List<Document> getChildren()
      Description copied from interface: Document
      Gets the children of the document.
      Returns:
      the children

    • getChildrenIds

      public List<String> getChildrenIds()
      Description copied from interface: Document
      Gets a list of the children ids.
      Returns:
      a list of children ids.

    • hasChild

      public boolean hasChild(String name)
      Description copied from interface: Document
      Checks whether this document has a child of the given name.
      Parameters:
      name - the name of the child to check
      Returns:
      true if the child exists, false otherwise

    • hasChildren

      public boolean hasChildren()
      Description copied from interface: Document
      Tests if the document has any children.
      Returns:
      true if the document has children, false otherwise

    • addChild

      public Document addChild(String name, String typeName)
      Description copied from interface: Document
      Creates a new child document of the given type.
      Parameters:
      name - the name of the new child to create
      typeName - the type of the child to create
      Returns:
      the newly created document

    • orderBefore

      public void orderBefore(String src, String dest)
      Description copied from interface: Document
      Orders the given source child before the destination child.

      Both source and destination must be names that point to child documents of this document. The source document will be placed before the destination one. If destination is null, the source document will be appended at the end of the children list.

      Parameters:
      src - the document to move
      dest - the document before which to place the source document

    • getPropertyValue

      public Serializable getPropertyValue(String name)
      Description copied from interface: Document
      Gets a simple property value.

      For more generic properties described by an xpath, use Document.getValue(java.lang.String) instead.

      Parameters:
      name - the name of the property to get
      Returns:
      the property value or null if the property is not set
      See Also:

    • setPropertyValue

      public void setPropertyValue(String name, Serializable value)
      Description copied from interface: Document
      Sets a simple property value.

      For more generic properties described by an xpath, use Document.setValue(java.lang.String, java.lang.Object) instead.

      Parameters:
      name - the name of the property to set
      value - the value to set
      See Also:

    • getChild

      protected State getChild(State state, String name, Type type)
      Description copied from class: BaseDocument
      Gets a child state.
      Specified by:
      getChild in class BaseDocument<State>
      Parameters:
      state - the parent state
      name - the child name
      type - the child's type
      Returns:
      the child state, or null if it doesn't exist

    • getChildForWrite

      protected State getChildForWrite(State state, String name, Type type) throws PropertyException
      Description copied from class: BaseDocument
      Gets a child state into which we will want to write data.

      Creates it if needed.

      Specified by:
      getChildForWrite in class BaseDocument<State>
      Parameters:
      state - the parent state
      name - the child name
      type - the child's type
      Returns:
      the child state, never null
      Throws:
      PropertyException

    • getChildAsList

      protected List<State> getChildAsList(State state, String name)
      Description copied from class: BaseDocument
      Gets a child state which is a list.
      Specified by:
      getChildAsList in class BaseDocument<State>
      Parameters:
      state - the parent state
      name - the child name
      Returns:
      the child state, never null

    • updateList

      protected void updateList(State state, String name, Field field, String xpath, List<Object> values)
      Description copied from class: BaseDocument
      Update a list.
      Specified by:
      updateList in class BaseDocument<State>
      Parameters:
      state - the parent state
      name - the child name
      field - the list element type
      xpath - the xpath of this list
      values - the values

    • updateList

      protected List<State> updateList(State state, String name, Property property) throws PropertyException
      Description copied from class: BaseDocument
      Update a list.
      Specified by:
      updateList in class BaseDocument<State>
      Parameters:
      state - the parent state
      name - the child name
      property - the property
      Returns:
      the list of states to write
      Throws:
      PropertyException

    • getValue

      public Object getValue(String xpath) throws PropertyException
      Description copied from interface: Document
      Gets a property value.

      The xpath may point to a partial path, in which case the value may be a complex List or Map.

      Parameters:
      xpath - the xpath of the property to set
      Returns:
      the property value or null if the property is not set
      Throws:
      PropertyException - if the property does not exist

    • setValue

      public void setValue(String xpath, Object value) throws PropertyException
      Description copied from interface: Document
      Sets a property value.

      The xpath may point to a partial path, in which case the value may be a complex List or Map.

      Parameters:
      xpath - the xpath of the property to set
      value - the value to set
      Throws:
      PropertyException - if the property does not exist or the value is of the wrong type

    • visitBlobs

      public void visitBlobs(Consumer<Document.BlobAccessor> blobVisitor) throws PropertyException
      Description copied from interface: Document
      Visits all the blobs of this document and calls the passed blob visitor on each one.
      Throws:
      PropertyException

    • replaceBlobDigest

      public String replaceBlobDigest(String key, String newKey, String newDigest)
      Description copied from interface: Document
      Visits the blobs of this document and, for those with a matching key, replace their key and digest with new ones.
      Parameters:
      key - the bob key to look for
      newKey - the new key
      newDigest - the new digest
      Returns:
      the old digest if at least one replacement was done, null otherwise

    • replaceBlobDigest

      protected void replaceBlobDigest(Document.BlobAccessor accessor, String key, String newKey, String newDigest, org.apache.commons.lang3.mutable.MutableObject<String> oldDigestHolder)

    • getDocumentBlobManager

      protected DocumentBlobManager getDocumentBlobManager()

    • makeFlexibleRecord

      public void makeFlexibleRecord()
      Description copied from interface: Document
      Turns the document into a flexible record.

      A record is a document with specific capabilities related to mandatory retention until a given date, and legal holds.

      If the document is already a flexible record, this method has no effect. An enforced record cannot be turned into a flexible record.

      The permission "MakeRecord" is required.

      See Also:

    • makeRecord

      public void makeRecord()
      Description copied from interface: Document
      Turns the document into an enforced record.

      A record is a document with specific capabilities related to mandatory retention until a given date, and legal holds. In addition, its main blob receives special treatment from the document blob manager to make sure it's never shared with another blob at the storage level, and is deleted as soon as the record is deleted.

      If the document is already a record, this method has no effect.

      The permission "MakeRecord" is required.

      See Also:

    • makeRecord

      protected void makeRecord(boolean flexible)

    • isRecord

      public boolean isRecord()
      Description copied from interface: Document
      Checks if the document is a record.
      Returns:
      true if the document is a record, false otherwise
      See Also:

    • isFlexibleRecord

      public boolean isFlexibleRecord()
      Returns:
      true if the document is a flexible record, false otherwise

    • setRetainUntil

      public void setRetainUntil(Calendar retainUntil) throws PropertyException
      Description copied from interface: Document
      Sets a retention date for the document (a record).

      If no previous retention date was set, or if the previous retention date was indeterminate, or if the previous retention date was before the given value, then the retention date is set to the given value.

      If the previous retention date was after the given value (that is, if trying to reduce the retention time), an exception is thrown.

      If the given value is null and the previous retention date is in the past (it has already expired), then the retention date is set to null.

      The permission "SetRetention" is required.

      Parameters:
      retainUntil - the new retention date
      Throws:
      PropertyException - if trying to reduce the retention time, or if the document is not a record
      See Also:

    • getRetainUntil

      public Calendar getRetainUntil()
      Description copied from interface: Document
      Gets the retention date for the document.
      Returns:
      the retention date, or "SetRetention" for a retention in the indeterminate future, or null if there is no retention date
      See Also:

    • setLegalHold

      public void setLegalHold(boolean hold)
      Description copied from interface: Document
      Sets or removes a legal hold on the document (a record).

      The permission "ManageLegalHold" is required.

      Parameters:
      hold - true to set a legal hold, false to remove it
      See Also:

    • hasLegalHold

      public boolean hasLegalHold()
      Description copied from interface: Document
      Checks if the document has a legal hold set.
      Returns:
      true if a legal hold has been set on the document, false otherwise
      See Also:

    • isRetentionActive

      public boolean isRetentionActive()
      Description copied from interface: Document
      Checks whether this document is under active retention.

    • setRetentionActive

      public void setRetentionActive(boolean retentionActive)
      Description copied from interface: Document
      Sets or unsets this document as under active retention.

    • checkIn

      public Document checkIn(String label, String checkinComment)
      Description copied from interface: Document
      Creates a new version.
      Parameters:
      label - the version label
      checkinComment - the checkin comment
      Returns:
      the created version

    • checkOut

      public void checkOut()

    • getVersionsIds

      public List<String> getVersionsIds()
      Description copied from interface: Document
      Gets the list of version ids for this document.
      Returns:
      the list of version ids

    • getVersions

      public List<Document> getVersions()
      Description copied from interface: Document
      Gets the versions for this document.
      Returns:
      the versions of the document, or an empty list if there are no versions

    • getLastVersion

      public Document getLastVersion()
      Description copied from interface: Document
      Gets the last version of this document.

      Returns null if there is no version at all.

      Returns:
      the last version, or null if there is no version

    • getSourceDocument

      public Document getSourceDocument()
      Description copied from interface: Document
      Gets the source for this document.

      For a version, it's the working copy.

      For a proxy, it's the version the proxy points to.

      Returns:
      the source document

    • restore

      public void restore(Document version)
      Description copied from interface: Document
      Replaces this document's content with the version specified.
      Parameters:
      version - the version to replace with

    • getVersion

      public Document getVersion(String label)
      Description copied from interface: Document
      Gets a version of this document, given its label.
      Parameters:
      label - the version label
      Returns:
      the version

    • getBaseVersion

      public Document getBaseVersion()
      Description copied from interface: Document
      Gets the version to which a checked in document is linked.

      Returns null for a checked out document or a version or a proxy.

      Returns:
      the version, or null

    • isCheckedOut

      public boolean isCheckedOut()
      Description copied from interface: Document
      Checks whether this document is checked out.
      Returns:
      true if the document is checked out, or false otherwise

    • getVersionSeriesId

      public String getVersionSeriesId()
      Description copied from interface: Document
      Gets the version series id.
      Returns:
      the version series id

    • getVersionCreationDate

      public Calendar getVersionCreationDate()
      Description copied from interface: Document
      Gets the version creation date of this document if it's a version or a proxy.
      Returns:
      the version creation date, or null if it's not a version or a proxy

    • getVersionLabel

      public String getVersionLabel()
      Description copied from interface: Document
      Gets the version label.
      Returns:
      the version label

    • getCheckinComment

      public String getCheckinComment()
      Description copied from interface: Document
      Gets the version check in comment of this document if it's a version or a proxy.
      Returns:
      the check in comment, or null if it's not a version or a proxy

    • isLatestVersion

      public boolean isLatestVersion()
      Description copied from interface: Document
      Checks whether this document is the latest version.
      Returns:
      true if this is the latest version, or false otherwise

    • isMajorVersion

      public boolean isMajorVersion()
      Description copied from interface: Document
      Checks whether this document is a major version.
      Returns:
      true if this is a major version, or false otherwise

    • isLatestMajorVersion

      public boolean isLatestMajorVersion()
      Description copied from interface: Document
      Checks whether this document is the latest major version.
      Returns:
      true if this is the latest major version, or false otherwise

    • isEqualOnVersion

      protected boolean isEqualOnVersion(Object ob, String key)

    • isVersionSeriesCheckedOut

      public boolean isVersionSeriesCheckedOut()
      Description copied from interface: Document
      Checks if there is a checked out working copy for the version series of this document.
      Returns:
      true if there is a checked out working copy

    • getWorkingCopy

      public Document getWorkingCopy()
      Description copied from interface: Document
      Gets the working copy for this document.
      Returns:
      the working copy

    • isFolder

      public boolean isFolder()
      Description copied from interface: Document
      Checks whether this document is a folder.
      Returns:
      true if the document is a folder, false otherwise

    • setReadOnly

      public void setReadOnly(boolean readonly)
      Description copied from interface: Document
      Sets this document as readonly or not.

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: Document
      Checks whether this document is readonly or not.

    • remove

      public void remove()
      Description copied from interface: Document
      Removes this document and all its children, if any.

    • remove

      public void remove(NuxeoPrincipal principal)
      Description copied from interface: Document
      Removes this document and all its children, if any.
      Parameters:
      principal - the caller

    • removeSingleton

      public void removeSingleton()
      Description copied from interface: Document
      Removes this document only, without its children.

    • getBlobKeys

      public String[] getBlobKeys()

    • getLifeCycleState

      public String getLifeCycleState()
      Description copied from interface: Document
      Gets the life cycle state of this document.
      Returns:
      the life cycle state

    • setCurrentLifeCycleState

      public void setCurrentLifeCycleState(String lifeCycleState) throws LifeCycleException
      Description copied from interface: Document
      Sets the life cycle state of this document.
      Parameters:
      lifeCycleState - the life cycle state
      Throws:
      LifeCycleException

    • getLifeCyclePolicy

      public String getLifeCyclePolicy()
      Description copied from interface: Document
      Gets the life cycle policy of this document.
      Returns:
      the life cycle policy

    • setLifeCyclePolicy

      public void setLifeCyclePolicy(String policy) throws LifeCycleException
      Description copied from interface: Document
      Sets the life cycle policy of this document.
      Parameters:
      policy - the life cycle policy
      Throws:
      LifeCycleException

    • followTransition

      public void followTransition(String transition) throws LifeCycleException
      Description copied from interface: Document
      Follows a given life cycle transition.

      This will update the life cycle state of the document.

      Parameters:
      transition - the name of the transition to follow
      Throws:
      LifeCycleException

    • getAllowedStateTransitions

      public Collection<String> getAllowedStateTransitions() throws LifeCycleException
      Description copied from interface: Document
      Returns the allowed state transitions for this document.
      Returns:
      a collection of state transitions
      Throws:
      LifeCycleException

    • setSystemProp

      public void setSystemProp(String name, Serializable value)
      Description copied from interface: Document
      Sets a system property.

    • getSystemProp

      public <T extends Serializable> T getSystemProp(String name, Class<T> type)
      Description copied from interface: Document
      Gets a system property.

    • getChangeToken

      public String getChangeToken()
      Description copied from interface: Document
      Gets the current change token for this document.
      Returns:
      the change token

    • getProxyUserVisibleChangeToken

      protected static String getProxyUserVisibleChangeToken(String proxyToken, String targetToken)

    • validateUserVisibleChangeToken

      public boolean validateUserVisibleChangeToken(String userVisibleChangeToken)
      Description copied from interface: Document
      Validates that the passed user-visible change token is compatible with the one for this document.
      Returns:
      false if the change token is not valid

    • validateProxyChangeToken

      protected static boolean validateProxyChangeToken(String userVisibleChangeToken, DBSDocumentState proxyState, DBSDocumentState targetState)

    • markUserChange

      public void markUserChange()
      Description copied from interface: Document
      Marks the document as being modified by a user change.

      This causes an additional change token increment and check during save.

    • getStateOrTarget

      protected DBSDocumentState getStateOrTarget(Type type) throws PropertyException
      Throws:
      PropertyException

    • getStateOrTarget

      protected DBSDocumentState getStateOrTarget(String xpath)

    • getStateOrTargetForSchema

      protected DBSDocumentState getStateOrTargetForSchema(String schema)
      Checks if the given schema should be resolved on the proxy or the target.

    • getStateOrTarget

      protected DBSDocumentState getStateOrTarget()
      Gets the target state if this is a proxy, or the regular state otherwise.

    • isSchemaForProxy

      protected boolean isSchemaForProxy(String schema)

    • getSchema

      protected String getSchema(String xpath)

    • readDocumentPart

      public void readDocumentPart(DocumentPart dp) throws PropertyException
      Description copied from interface: Document
      Loads a DocumentPart from storage.

      Reading data is done by DocumentPart because of per-proxy schemas.

      Throws:
      PropertyException

    • internalName

      protected String internalName(String name)
      Description copied from class: BaseDocument
      Finds the internal name to use to refer to this property.
      Specified by:
      internalName in class BaseDocument<State>

    • writeDocumentPart

      public boolean writeDocumentPart(DocumentPart dp, Document.WriteContext writeContext, boolean create) throws PropertyException
      Description copied from interface: Document
      Writes a DocumentPart to storage.

      Writing data is done by DocumentPart because of per-proxy schemas.

      Parameters:
      dp - the document part
      writeContext - the write context
      create - whether this is for a document creation
      Returns:
      true if something changed
      Throws:
      PropertyException

    • getAllFacets

      public Set<String> getAllFacets()
      Description copied from interface: Document
      Gets the facets available on this document (from the type and the instance facets).
      Returns:
      the facets

    • getFacets

      public String[] getFacets()
      Description copied from interface: Document
      Gets the facets defined on this document instance. The type facets are not returned.
      Returns:
      the facets

    • getRetainedProperties

      public String[] getRetainedProperties() throws PropertyException
      Description copied from interface: Document
      Gets the retained property xpaths of this document instance at the time it became a record.
      Returns:
      the retained properties
      Throws:
      PropertyException - if document is not a record

    • hasFacet

      public boolean hasFacet(String facet)
      Description copied from interface: Document
      Checks whether this document has a given facet, either from its type or added on the instance.
      Parameters:
      facet - the facet name
      Returns:
      true if the document has the facet

    • addFacet

      public boolean addFacet(String facet)
      Description copied from interface: Document
      Adds a facet to this document.

      Does nothing if the facet was already present on the document.

      Parameters:
      facet - the facet name
      Returns:
      true if the facet was added, or false if it is already present

    • removeFacet

      public boolean removeFacet(String facet)
      Description copied from interface: Document
      Removes a facet from this document.

      It's not possible to remove a facet coming from the document type.

      Parameters:
      facet - the facet name
      Returns:
      true if the facet was removed, or false if it isn't present or is present on the type or does not exit

    • getSchemas

      protected static Set<String> getSchemas(DocumentType type, List<Object> facets)

    • getTargetDocument

      public DBSDocument getTargetDocument()
      Description copied from interface: Document
      Gets the document (version or live document) to which this proxy points.

    • getTargetDocumentId

      protected String getTargetDocumentId()

    • setTargetDocument

      public void setTargetDocument(Document target)
      Description copied from interface: Document
      Sets the document (version or live document) to which this proxy points.

    • getDocumentLock

      protected Lock getDocumentLock()
      Description copied from class: BaseDocument
      Gets the lock from this recently created and unsaved document.
      Specified by:
      getDocumentLock in class BaseDocument<State>
      Returns:
      the lock, or null if no lock is set

    • setDocumentLock

      protected Lock setDocumentLock(Lock lock)
      Description copied from class: BaseDocument
      Sets a lock on this recently created and unsaved document.
      Specified by:
      setDocumentLock in class BaseDocument<State>
      Parameters:
      lock - the lock to set
      Returns:
      null if locking succeeded, or the existing lock if locking failed

    • removeDocumentLock

      protected Lock removeDocumentLock(String owner)
      Description copied from class: BaseDocument
      Removes a lock from this recently created and unsaved document.
      Specified by:
      removeDocumentLock in class BaseDocument<State>
      Parameters:
      owner - the owner to check, or null for no check
      Returns:
      null if there was no lock or if removal succeeded, or a lock if it blocks removal due to owner mismatch

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object