org.fcrepo.kernel.services

Class VersionService

java.lang.Object

org.modeshape.jcr.api.JcrTools

org.fcrepo.kernel.services.RepositoryService

org.fcrepo.kernel.services.VersionService

All Implemented Interfaces:

FedoraJcrTypes

@Component
public class VersionService
extends RepositoryService

This service exposes management of node versioning. Instead of invoking the JCR VersionManager methods, this provides a level of indirection that allows for special handling of features built on top of JCR such as user transactions.

Author:

Mike Durbin

Nested Class Summary

Nested classes/interfaces inherited from class org.modeshape.jcr.api.JcrTools

org.modeshape.jcr.api.JcrTools.BasicOperation, org.modeshape.jcr.api.JcrTools.BrowseContent, org.modeshape.jcr.api.JcrTools.CountNodes, org.modeshape.jcr.api.JcrTools.NodeOperation, org.modeshape.jcr.api.JcrTools.Operation, org.modeshape.jcr.api.JcrTools.PrintNodes, org.modeshape.jcr.api.JcrTools.Variable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AUTO_VERSION
protected static String	VERSION_POLICY
protected static String	VERSIONABLE

Fields inherited from class org.fcrepo.kernel.services.RepositoryService

repo

Fields inherited from interface org.fcrepo.jcr.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, FCR_CONTENT, FEDORA_BINARY, FEDORA_DATASTREAM, FEDORA_OBJECT, FEDORA_RESOURCE, FROZEN_MIXIN_TYPES, FROZEN_NODE, JCR_CREATED, JCR_CREATEDBY, JCR_LASTMODIFIED, PREMIS_FILE_NAME, ROOT

Constructor Summary

Constructors

Constructor and Description
VersionService()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkpoint(javax.jcr.Node node) Creates a version checkpoint for the given node if versioning is enabled for that node type.
void	createVersion(javax.jcr.Workspace workspace, Collection<String> paths) Explicitly creates a version for the nodes at each path provided.
void	nodeUpdated(javax.jcr.Node n) Notifies the version manager that the given node was updated so that if automatic versioning is set for that node, a version checkpoint will be made.
void	nodeUpdated(javax.jcr.Session session, String absPath) Notifies the version manager that the node at a given path was updated so that if automatic versioning is set for that node, a version checkpoint will be made.

Methods inherited from class org.fcrepo.kernel.services.RepositoryService

backupRepository, exists, getAllNodeTypes, getNamespaceRegistryDataset, getNamespaceRegistryStream, getNodeTypes, getRepositoryNamespaces, getRepositoryObjectCount, getRepositorySize, registerNodeTypes, restoreRepository, searchRepository, setRepository

Methods inherited from class org.modeshape.jcr.api.JcrTools

findOrCreateChild, findOrCreateChild, findOrCreateNode, findOrCreateNode, findOrCreateNode, findOrCreateNode, getNode, getReadable, getStringValue, importContent, importContent, importContent, importContent, importContent, importContent, importContent, isDebug, onEachNode, onEachNodeBelow, print, printNode, printQuery, printQuery, printQuery, printQuery, printSubgraph, printSubgraph, printSubgraph, registerNodeTypes, removeAllChildren, removeAllChildren, repeatedlyWithSession, resourceUrl, uploadFile, uploadFile, uploadFile, uploadFileAndBlock, uploadFileAndBlock, uploadFileAndBlock, uploadFilesAndBlock, var, vars, withSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSIONABLE

protected static final String VERSIONABLE

See Also:

Constant Field Values

VERSION_POLICY

protected static final String VERSION_POLICY

See Also:

Constant Field Values

AUTO_VERSION

protected static final String AUTO_VERSION

See Also:

Constant Field Values

Constructor Detail

VersionService

public VersionService()

Method Detail

nodeUpdated

public void nodeUpdated(javax.jcr.Session session,
               String absPath)
                 throws javax.jcr.RepositoryException

Notifies the version manager that the node at a given path was updated so that if automatic versioning is set for that node, a version checkpoint will be made. When a node object is available, use of nodeUpdated(javax.jcr.Node) will save the overhead of a redundant node lookup.

Parameters:

session -

absPath - the absolute path to the node that was created or modified

Throws:

javax.jcr.RepositoryException

nodeUpdated

public void nodeUpdated(javax.jcr.Node n)
                 throws javax.jcr.RepositoryException

Notifies the version manager that the given node was updated so that if automatic versioning is set for that node, a version checkpoint will be made.

Parameters:

n - the node that was updated

Throws:

javax.jcr.RepositoryException

createVersion

public void createVersion(javax.jcr.Workspace workspace,
                 Collection<String> paths)
                   throws javax.jcr.RepositoryException

Explicitly creates a version for the nodes at each path provided.

Parameters:

workspace - the workspace in which the node resides

paths - absolute paths to the nodes within the workspace

Throws:

javax.jcr.RepositoryException

checkpoint

public void checkpoint(javax.jcr.Node node)
                throws javax.jcr.RepositoryException

Creates a version checkpoint for the given node if versioning is enabled for that node type. When versioning is enabled this is the equivalent of VersionManager#checkpoint(node.getPath()), except that it is aware of TxSessions and queues these operations accordingly.

Parameters:

node - the node for whom a new version is to be minted

Throws:

javax.jcr.RepositoryException