org.fcrepo.kernel.services

Interface VersionService

All Superinterfaces:

Service

public interface VersionService
extends Service

Since:

Feb 19, 2014

Author:

bbpennel

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.
Collection<String>	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.
void	removeVersion(javax.jcr.Workspace workspace, String absPath, String label) Remove a version of a node.
void	revertToVersion(javax.jcr.Workspace workspace, String absPath, String label) Reverts the node to the version identified by the label.
void	setTxService(TransactionService txService)

Methods inherited from interface org.fcrepo.kernel.services.Service

exists, setRepository

Method Detail

nodeUpdated

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

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

Collection<String> 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

revertToVersion

void revertToVersion(javax.jcr.Workspace workspace,
                   String absPath,
                   String label)
                     throws javax.jcr.RepositoryException

Reverts the node to the version identified by the label. This method will throw a PathNotFoundException if no version with the given label is found.

Parameters:

workspace - the workspace in which the node resides

absPath - the path to the node whose version is to be reverted

label - identifies the historic version

Throws:

javax.jcr.RepositoryException

removeVersion

void removeVersion(javax.jcr.Workspace workspace,
                 String absPath,
                 String label)
                   throws javax.jcr.RepositoryException

Remove a version of a node. This method will throw a PathNotFoundException if no version with the given label is found.

Parameters:

workspace - the workspace in which the node resides

absPath - the path to the node whose version is to be removed

label - identifies the historic version by label or id

Throws:

javax.jcr.RepositoryException

checkpoint

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

setTxService

void setTxService(TransactionService txService)

Parameters:

txService - the txService to set