org.alfresco.repo.version
Class Version2ServiceImpl

java.lang.Object
  extended by org.alfresco.repo.version.common.AbstractVersionServiceImpl
      extended by org.alfresco.repo.version.VersionServiceImpl
          extended by org.alfresco.repo.version.Version2ServiceImpl
All Implemented Interfaces:
Version2Model, VersionBaseModel, VersionModel, VersionService

public class Version2ServiceImpl
extends VersionServiceImpl
implements VersionService, Version2Model

Version2 Service - implements version2Store (a lighter implementation of the lightWeightVersionStore)


Field Summary
protected  boolean useDeprecatedV1
           
 
Fields inherited from class org.alfresco.repo.version.VersionServiceImpl
dbNodeService, MSGID_ERR_NO_BRANCHES, MSGID_ERR_NOT_FOUND, MSGID_ERR_ONE_PRECEEDING, MSGID_ERR_RESTORE_EXISTS, MSGID_ERR_RESTORE_NO_VERSION, MSGID_ERR_REVERT_MISMATCH, policyBehaviourFilter, searcher
 
Fields inherited from class org.alfresco.repo.version.common.AbstractVersionServiceImpl
dictionaryService, nodeService, policyComponent
 
Fields inherited from interface org.alfresco.service.cmr.version.VersionService
VERSION_STORE_PROTOCOL
 
Fields inherited from interface org.alfresco.repo.version.Version2Model
ASPECT_LOCALNAME_VERSION, ASPECT_VERSION, ASPECT_VERSION_STORE_ROOT, ASSOC_ROOT_VERSION, ASSOC_SUCCESSOR, CHILD_QNAME_VERSION_HISTORIES, CHILD_QNAME_VERSIONED_ASSOCS, CHILD_QNAME_VERSIONS, NAMESPACE_URI, PROP_ASSOC_DBID, PROP_FROZEN_ACCESSED, PROP_FROZEN_CREATED, PROP_FROZEN_CREATOR, PROP_FROZEN_MODIFIED, PROP_FROZEN_MODIFIER, PROP_FROZEN_NODE_DBID, PROP_FROZEN_NODE_REF, PROP_METADATA_PREFIX, PROP_QNAME_ASSOC_DBID, PROP_QNAME_FROZEN_ACCESSED, PROP_QNAME_FROZEN_CREATED, PROP_QNAME_FROZEN_CREATOR, PROP_QNAME_FROZEN_MODIFIED, PROP_QNAME_FROZEN_MODIFIER, PROP_QNAME_FROZEN_NODE_DBID, PROP_QNAME_FROZEN_NODE_REF, PROP_QNAME_TRANSLATION_VERSIONS, PROP_QNAME_VERSION_DESCRIPTION, PROP_QNAME_VERSION_LABEL, PROP_QNAME_VERSION_NUMBER, PROP_QNAME_VERSIONED_NODE_ID, PROP_VERSION_DESCRIPTION, PROP_VERSION_TYPE, STORE_ID, TYPE_QNAME_VERSION_HISTORY, TYPE_QNAME_VERSIONED_ASSOC
 
Fields inherited from interface org.alfresco.repo.version.VersionBaseModel
ASPECT_LOCALNAME_VERSION_STORE_ROOT, ASSOC_LOCALNAME_ROOT_VERSION, CHILD_VERSION_HISTORIES, CHILD_VERSIONED_ASSOCS, CHILD_VERSIONS, PROP_CREATED_DATE, PROP_CREATOR, PROP_DESCRIPTION, PROP_TRANSLATION_VERSIONS, PROP_VERSION_LABEL, PROP_VERSION_NUMBER, PROP_VERSIONED_NODE_ID, STORE_PROTOCOL, TYPE_VERSION_HISTORY, TYPE_VERSIONED_ASSOC
 
Fields inherited from interface org.alfresco.repo.version.VersionModel
ASPECT_VERSION_STORE_ROOT, ASSOC_ROOT_VERSION, ASSOC_SUCCESSOR, CHILD_QNAME_VERSION_HISTORIES, CHILD_QNAME_VERSION_META_DATA, CHILD_QNAME_VERSIONED_ASSOCS, CHILD_QNAME_VERSIONED_ATTRIBUTES, CHILD_QNAME_VERSIONED_CHILD_ASSOCS, CHILD_QNAME_VERSIONS, CHILD_VERSION_META_DATA, CHILD_VERSIONED_ATTRIBUTES, CHILD_VERSIONED_CHILD_ASSOCS, NAMESPACE_URI, PROP_ASSOC_QNAME, PROP_ASSOC_TYPE_QNAME, PROP_FROZEN_ASPECTS, PROP_FROZEN_NODE_ID, PROP_FROZEN_NODE_STORE_ID, PROP_FROZEN_NODE_STORE_PROTOCOL, PROP_FROZEN_NODE_TYPE, PROP_IS_MULTI_VALUE, PROP_IS_PRIMARY, PROP_META_DATA_NAME, PROP_META_DATA_VALUE, PROP_MULTI_VALUE, PROP_NTH_SIBLING, PROP_QNAME, PROP_QNAME_ASSOC_QNAME, PROP_QNAME_ASSOC_TYPE_QNAME, PROP_QNAME_FROZEN_ASPECTS, PROP_QNAME_FROZEN_NODE_ID, PROP_QNAME_FROZEN_NODE_STORE_ID, PROP_QNAME_FROZEN_NODE_STORE_PROTOCOL, PROP_QNAME_FROZEN_NODE_TYPE, PROP_QNAME_IS_MULTI_VALUE, PROP_QNAME_IS_PRIMARY, PROP_QNAME_META_DATA_NAME, PROP_QNAME_META_DATA_VALUE, PROP_QNAME_MULTI_VALUE, PROP_QNAME_NTH_SIBLING, PROP_QNAME_QNAME, PROP_QNAME_TRANSLATION_VERSIONS, PROP_QNAME_VALUE, PROP_QNAME_VERSION_LABEL, PROP_QNAME_VERSION_NUMBER, PROP_QNAME_VERSIONED_NODE_ID, PROP_VALUE, STORE_ID, TYPE_QNAME_VERSION, TYPE_QNAME_VERSION_HISTORY, TYPE_QNAME_VERSION_META_DATA_VALUE, TYPE_QNAME_VERSIONED_ASSOC, TYPE_QNAME_VERSIONED_CHILD_ASSOC, TYPE_QNAME_VERSIONED_PROPERTY, TYPE_VERSION, TYPE_VERSION_META_DATA_VALUE, TYPE_VERSIONED_CHILD_ASSOC, TYPE_VERSIONED_PROPERTY
 
Constructor Summary
Version2ServiceImpl()
           
 
Method Summary
protected  VersionHistory buildVersionHistory(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef, org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Builds a version history object from the version history reference.
protected  org.alfresco.service.cmr.repository.NodeRef createNewVersion(org.alfresco.service.namespace.QName sourceTypeRef, org.alfresco.service.cmr.repository.NodeRef versionHistoryRef, java.util.Map standardVersionProperties, java.util.Map versionProperties, int versionNumber, PolicyScope nodeDetails)
          Creates a new version node, setting the properties both calculated and specified.
 java.util.Collection createVersion(java.util.Collection nodeRefs, java.util.Map versionProperties)
          Note: we can't control the order of the list, so if we have children and parents in the list and the parents get versioned before the children and the children are not already versioned then the parents child references will be pointing to the node ref, rather than the verison history.
 Version createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Map versionProperties)
          Creates a new version based on the referenced node.
protected  Version createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Map origVersionProperties, int versionNumber)
          Creates a new version of the passed node assigning the version properties accordingly.
protected  org.alfresco.service.cmr.repository.NodeRef createVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Creates a new version history node, applying the root version aspect is required
 void deleteVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version)
          Delete a specific version associated with a node reference.
 void deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Delete the version history associated with a node reference.
protected  java.util.List getAllVersions(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef)
          Gets all versions in version history
 Version getCurrentVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Gets the version object for the current version of the node reference passed.
protected  java.util.Map getStandardVersionProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef, long nodeDbId, java.util.Set nodeAspects, int versionNumber, java.lang.String versionLabel, java.lang.String versionDescription)
          Get a map containing the standard list of version properties populated.
protected  Version getVersion(org.alfresco.service.cmr.repository.NodeRef versionRef)
          Constructs the a version object to contain the version information from the version node ref.
 VersionHistory getVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Gets the version history information for a node.
protected  org.alfresco.service.cmr.repository.NodeRef getVersionHistoryNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          Gets a reference to the version history node for a given 'real' node.
 org.alfresco.service.cmr.repository.StoreRef getVersionStoreReference()
          Gets the reference to the version store
 void initialise()
          Initialise method
 org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName)
          By default a deep restore is performed.
 org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName, boolean deep)
          Restores a node not currently present in the store, but that has a version history.
 void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef)
          The node reference will be reverted to the current version.
 void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean deep)
          The node reference will be reverted to the current version.
 void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version)
          A deep revert will take place by default.
 void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version, boolean deep)
          Revert the state of the node to the specified version.
 void setOnlyUseDeprecatedV1(boolean useDeprecatedV1)
           
 void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
           
 void setVersionMigrator(VersionMigrator versionMigrator)
           
 
Methods inherited from class org.alfresco.repo.version.VersionServiceImpl
createVersion, defaultOnCreateVersion, ensureVersioningEnabled, getRootNode, getVersionMetaData, initialiseWithoutBind, registerVersionLabelPolicy, setDbNodeService, setPolicyBehaviourFilter, setSearcher
 
Methods inherited from class org.alfresco.repo.version.common.AbstractVersionServiceImpl
invokeAfterCreateVersion, invokeBeforeCreateVersion, invokeCalculateVersionLabel, invokeOnCreateVersion, setDictionaryService, setNodeService, setPolicyComponent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.alfresco.service.cmr.version.VersionService
createVersion, ensureVersioningEnabled, registerVersionLabelPolicy
 

Field Detail

useDeprecatedV1

protected boolean useDeprecatedV1
Constructor Detail

Version2ServiceImpl

public Version2ServiceImpl()
Method Detail

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setVersionMigrator

public void setVersionMigrator(VersionMigrator versionMigrator)

setOnlyUseDeprecatedV1

public void setOnlyUseDeprecatedV1(boolean useDeprecatedV1)

initialise

public void initialise()
Initialise method

Overrides:
initialise in class VersionServiceImpl

getVersionStoreReference

public org.alfresco.service.cmr.repository.StoreRef getVersionStoreReference()
Description copied from class: VersionServiceImpl
Gets the reference to the version store

Specified by:
getVersionStoreReference in interface VersionService
Overrides:
getVersionStoreReference in class VersionServiceImpl
Returns:
reference to the version store

createVersion

public Version createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                             java.util.Map versionProperties)
                      throws ReservedVersionNameException,
                             AspectMissingException
Description copied from interface: VersionService
Creates a new version based on the referenced node.

If the node has not previously been versioned then a version history and initial version will be created.

If the node referenced does not or can not have the version aspect applied to it then an exception will be raised.

The version properties are stored as version meta-data against the newly created version.

Specified by:
createVersion in interface VersionService
Overrides:
createVersion in class VersionServiceImpl
Parameters:
nodeRef - a node reference
versionProperties - the version properties that are stored with the newly created version, or null if there are no relevant properties
Returns:
the created version object
Throws:
ReservedVersionNameException - thrown if a reserved property name is used int he version properties provided
AspectMissingException - thrown if the version aspect is missing
See Also:
VersionCounterService#nextVersionNumber(StoreRef)

createVersion

public java.util.Collection createVersion(java.util.Collection nodeRefs,
                                          java.util.Map versionProperties)
                                   throws ReservedVersionNameException,
                                          AspectMissingException
Description copied from class: VersionServiceImpl
Note: we can't control the order of the list, so if we have children and parents in the list and the parents get versioned before the children and the children are not already versioned then the parents child references will be pointing to the node ref, rather than the verison history.

Specified by:
createVersion in interface VersionService
Overrides:
createVersion in class VersionServiceImpl
Parameters:
nodeRefs - a list of node references
versionProperties - version property values
Returns:
a collection of newly created versions
Throws:
ReservedVersionNameException - thrown if a reserved property name is used in the version properties provided
AspectMissingException - thrown if the version aspect is missing

createVersion

protected Version createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                java.util.Map origVersionProperties,
                                int versionNumber)
                         throws ReservedVersionNameException
Description copied from class: VersionServiceImpl
Creates a new version of the passed node assigning the version properties accordingly.

Overrides:
createVersion in class VersionServiceImpl
Parameters:
nodeRef - a node reference
versionNumber - the version number
Returns:
the newly created version
Throws:
ReservedVersionNameException - thrown if there is a name clash in the version properties

createVersionHistory

protected org.alfresco.service.cmr.repository.NodeRef createVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Creates a new version history node, applying the root version aspect is required

Parameters:
nodeRef - the node ref
Returns:
the version history node reference

getVersionHistory

public VersionHistory getVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Description copied from interface: VersionService
Gets the version history information for a node.

If the node has not been versioned then null is returned.

If the node referenced does not or can not have the version aspect applied to it then an exception will be raised.

Specified by:
getVersionHistory in interface VersionService
Overrides:
getVersionHistory in class VersionServiceImpl
Parameters:
nodeRef - a node reference
Returns:
the version history information
See Also:
VersionService.getVersionHistory(NodeRef)

getCurrentVersion

public Version getCurrentVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Description copied from interface: VersionService
Gets the version object for the current version of the node reference passed.

Returns null if the node is not versionable or has not been versioned.

Specified by:
getCurrentVersion in interface VersionService
Overrides:
getCurrentVersion in class VersionServiceImpl
Parameters:
nodeRef - the node reference
Returns:
the version object for the current version
See Also:
VersionService.getCurrentVersion(NodeRef)

getStandardVersionProperties

protected java.util.Map getStandardVersionProperties(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                     long nodeDbId,
                                                     java.util.Set nodeAspects,
                                                     int versionNumber,
                                                     java.lang.String versionLabel,
                                                     java.lang.String versionDescription)
Get a map containing the standard list of version properties populated.

Parameters:
nodeRef - the node reference
Returns:
the standard version properties

createNewVersion

protected org.alfresco.service.cmr.repository.NodeRef createNewVersion(org.alfresco.service.namespace.QName sourceTypeRef,
                                                                       org.alfresco.service.cmr.repository.NodeRef versionHistoryRef,
                                                                       java.util.Map standardVersionProperties,
                                                                       java.util.Map versionProperties,
                                                                       int versionNumber,
                                                                       PolicyScope nodeDetails)
Creates a new version node, setting the properties both calculated and specified.

Parameters:
versionableNodeRef - the reference to the node being versioned
versionHistoryRef - version history node reference
preceedingNodeRef - the version node preceeding this in the version history , null if none
versionProperties - version properties
versionNumber - the version number
Returns:
the version node reference

getAllVersions

protected java.util.List getAllVersions(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef)
Gets all versions in version history

Parameters:
versionHistoryRef - the version history nodeRef
Returns:
list of all versions

buildVersionHistory

protected VersionHistory buildVersionHistory(org.alfresco.service.cmr.repository.NodeRef versionHistoryRef,
                                             org.alfresco.service.cmr.repository.NodeRef nodeRef)
Builds a version history object from the version history reference.

The node ref is passed to enable the version history to be scoped to the appropriate branch in the version history.

Overrides:
buildVersionHistory in class VersionServiceImpl
Parameters:
versionHistoryRef - the node ref for the version history
nodeRef - the node reference
Returns:
a constructed version history object

getVersion

protected Version getVersion(org.alfresco.service.cmr.repository.NodeRef versionRef)
Constructs the a version object to contain the version information from the version node ref.

Overrides:
getVersion in class VersionServiceImpl
Parameters:
versionRef - the version reference
Returns:
object containing verison data

getVersionHistoryNodeRef

protected org.alfresco.service.cmr.repository.NodeRef getVersionHistoryNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets a reference to the version history node for a given 'real' node.

Overrides:
getVersionHistoryNodeRef in class VersionServiceImpl
Parameters:
nodeRef - a node reference
Returns:
a reference to the version history node, null of none

revert

public void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Description copied from interface: VersionService
The node reference will be reverted to the current version.

A deep revert will be performed.

Specified by:
revert in interface VersionService
Overrides:
revert in class VersionServiceImpl
Parameters:
nodeRef - the node reference
See Also:
org.alfresco.cms.version.VersionService#revert(NodeRef)

revert

public void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                   boolean deep)
Description copied from interface: VersionService
The node reference will be reverted to the current version.

Specified by:
revert in interface VersionService
Overrides:
revert in class VersionServiceImpl
Parameters:
nodeRef - the node reference
deep - true if a deep revert is to be performed, flase otherwise
See Also:
VersionService.revert(org.alfresco.service.cmr.repository.NodeRef, boolean)

revert

public void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                   Version version)
Description copied from interface: VersionService
A deep revert will take place by default.

Specified by:
revert in interface VersionService
Overrides:
revert in class VersionServiceImpl
Parameters:
nodeRef - the node reference
version - the version to revert to
See Also:
VersionService.revert(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.version.Version)

revert

public void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                   Version version,
                   boolean deep)
Description copied from interface: VersionService
Revert the state of the node to the specified version.

Any changes made to the node will be lost and the state of the node will reflect that of the version specified.

The version label property on the node reference will remain unchanged.

If the node is further versioned then the new version will be created at the head of the version history graph. A branch will not be created.

If a deep revert is to be performed then any child nodes that are no longer present will be deep restored (if appropriate) otherwise child associations to deleted, versioned nodes will not be restored.

Specified by:
revert in interface VersionService
Overrides:
revert in class VersionServiceImpl
Parameters:
nodeRef - the node reference
version - the version to revert to
deep - true is a deep revert is to be performed, false otherwise.
See Also:
VersionService.revert(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.version.Version, boolean)

restore

public org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                           org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                                                           org.alfresco.service.namespace.QName assocTypeQName,
                                                           org.alfresco.service.namespace.QName assocQName)
Description copied from interface: VersionService
By default a deep restore is performed.

Specified by:
restore in interface VersionService
Overrides:
restore in class VersionServiceImpl
Parameters:
nodeRef - the node reference to a node that no longer exists in the store
parentNodeRef - the new parent of the restored node
assocTypeQName - the assoc type qname
assocQName - the assoc qname
Returns:
the newly restored node reference
See Also:
VersionService.restore(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, org.alfresco.service.namespace.QName)

restore

public org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                                                           org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
                                                           org.alfresco.service.namespace.QName assocTypeQName,
                                                           org.alfresco.service.namespace.QName assocQName,
                                                           boolean deep)
Description copied from interface: VersionService
Restores a node not currently present in the store, but that has a version history.

The restored node will be at the head (most resent version).

Restoration will fail if there is no version history for the specified node id in the specified store.

If the node already exists in the store then an exception will be raised.

Once the node is restored it is reverted to the head version in the appropriate version history tree. If deep is set to true then this will be a deep revert, false otherwise.

Specified by:
restore in interface VersionService
Overrides:
restore in class VersionServiceImpl
Parameters:
nodeRef - the node reference to a node that no longer exists in the store
parentNodeRef - the new parent of the restored node
assocTypeQName - the assoc type qname
assocQName - the assoc qname
deep - true is a deep revert should be performed once the node has been restored, false otherwise
Returns:
the newly restored node reference
See Also:
VersionService.restore(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, org.alfresco.service.namespace.QName, boolean)

deleteVersionHistory

public void deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
                          throws AspectMissingException
Description copied from interface: VersionService
Delete the version history associated with a node reference.

This operation is permanent, all versions in the version history are deleted and cannot be retrieved.

The current version label for the node reference is reset and any subsequent versions of the node will result in a new version history being created.

Specified by:
deleteVersionHistory in interface VersionService
Overrides:
deleteVersionHistory in class VersionServiceImpl
Parameters:
nodeRef - the node reference
Throws:
AspectMissingException - thrown if the version aspect is missing
See Also:
org.alfresco.cms.version.VersionService#deleteVersionHistory(NodeRef)

deleteVersion

public void deleteVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          Version version)
Description copied from interface: VersionService
Delete a specific version associated with a node reference.

This operation is permanent, the specific version in the version history is deleted and cannot be retrieved.

If this is the last version, then the current version label for the node reference is reset and any subsequent versions of the node will result in a new version history being created.

Specified by:
deleteVersion in interface VersionService
Overrides:
deleteVersion in class VersionServiceImpl
Parameters:
nodeRef - the node reference
version - the version to delete


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.