org.apache.jackrabbit.jcr2spi.version

Class VersionManagerImpl

java.lang.Object

org.apache.jackrabbit.jcr2spi.version.VersionManagerImpl

All Implemented Interfaces:

VersionManager

public class VersionManagerImpl
extends Object
implements VersionManager

VersionManagerImpl...

Constructor Summary

Constructors

Constructor and Description
VersionManagerImpl(WorkspaceManager workspaceManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	addVersionLabel(NodeState versionHistoryState, NodeState versionState, Name qLabel, boolean moveLabel)
NodeEntry	checkin(NodeState nodeState)
void	checkIsCheckedOut(NodeState nodeState)
void	checkout(NodeState nodeState)
void	checkout(NodeState nodeState, NodeId activityId)
NodeEntry	checkpoint(NodeState nodeState)
NodeEntry	checkpoint(NodeState nodeState, NodeId activityId)
NodeEntry	createActivity(String title)
NodeEntry	createConfiguration(NodeState nodeState)
NodeEntry	getVersionableNodeEntry(NodeState versionState)
NodeEntry	getVersionHistoryEntry(NodeState versionableState)
boolean	isCheckedOut(NodeState nodeState) Search nearest ancestor that is versionable.
Iterator<NodeId>	merge(NodeState nodeState, String workspaceName, boolean bestEffort)
Iterator<NodeId>	merge(NodeState nodeState, String workspaceName, boolean bestEffort, boolean isShallow)
Iterator<NodeId>	mergeActivity(NodeState activityState)
void	removeActivity(NodeState activityState)
void	removeVersion(NodeState versionHistoryState, NodeState versionState)
void	removeVersionLabel(NodeState versionHistoryState, NodeState versionState, Name qLabel)
void	resolveMergeConflict(NodeState nodeState, NodeState versionState, boolean done)
void	restore(NodeState[] versionStates, boolean removeExisting)
void	restore(NodeState nodeState, Path relativePath, NodeState versionState, boolean removeExisting)

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionManagerImpl

public VersionManagerImpl(WorkspaceManager workspaceManager)

Method Detail

checkin

public NodeEntry checkin(NodeState nodeState)
                  throws javax.jcr.RepositoryException

Specified by:

checkin in interface VersionManager

Returns:

NodeEntry of newly created version

Throws:

javax.jcr.version.VersionException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.InvalidItemStateException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

Node.checkin()

checkout

public void checkout(NodeState nodeState)
              throws javax.jcr.RepositoryException

Specified by:

checkout in interface VersionManager

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

Node.checkout()

checkout

public void checkout(NodeState nodeState,
            NodeId activityId)
              throws javax.jcr.RepositoryException

Specified by:

checkout in interface VersionManager

Throws:

javax.jcr.RepositoryException

checkpoint

public NodeEntry checkpoint(NodeState nodeState)
                     throws javax.jcr.RepositoryException

Specified by:

checkpoint in interface VersionManager

Throws:

javax.jcr.RepositoryException

See Also:

VersionManager.checkpoint(String)

checkpoint

public NodeEntry checkpoint(NodeState nodeState,
                   NodeId activityId)
                     throws javax.jcr.RepositoryException

Specified by:

checkpoint in interface VersionManager

Throws:

javax.jcr.RepositoryException

See Also:

VersionManager.checkpoint(String)

isCheckedOut

public boolean isCheckedOut(NodeState nodeState)
                     throws javax.jcr.RepositoryException

Search nearest ancestor that is versionable. If no versionable ancestor can be found, true is returned.

Specified by:

isCheckedOut in interface VersionManager

Parameters:

nodeState -

Returns:

Throws:

javax.jcr.RepositoryException

See Also:

Node.isCheckedOut()

checkIsCheckedOut

public void checkIsCheckedOut(NodeState nodeState)
                       throws javax.jcr.version.VersionException,
                              javax.jcr.RepositoryException

Specified by:

checkIsCheckedOut in interface VersionManager

Throws:

javax.jcr.version.VersionException - If the Node represented by the given NodeState is checkedin.

javax.jcr.RepositoryException - If another error occurs.

See Also:

Node.isCheckedOut()

removeVersion

public void removeVersion(NodeState versionHistoryState,
                 NodeState versionState)
                   throws javax.jcr.RepositoryException

Specified by:

removeVersion in interface VersionManager

Throws:

javax.jcr.ReferentialIntegrityException

javax.jcr.AccessDeniedException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.removeVersion(String)

addVersionLabel

public void addVersionLabel(NodeState versionHistoryState,
                   NodeState versionState,
                   Name qLabel,
                   boolean moveLabel)
                     throws javax.jcr.RepositoryException

Specified by:

addVersionLabel in interface VersionManager

Throws:

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.addVersionLabel(String, String, boolean)

removeVersionLabel

public void removeVersionLabel(NodeState versionHistoryState,
                      NodeState versionState,
                      Name qLabel)
                        throws javax.jcr.RepositoryException

Specified by:

removeVersionLabel in interface VersionManager

Throws:

javax.jcr.version.VersionException

javax.jcr.RepositoryException

See Also:

VersionHistory.removeVersionLabel(String)

restore

public void restore(NodeState nodeState,
           Path relativePath,
           NodeState versionState,
           boolean removeExisting)
             throws javax.jcr.RepositoryException

Specified by:

restore in interface VersionManager

Throws:

javax.jcr.version.VersionException

javax.jcr.ItemExistsException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Node.restore(String, boolean), Node.restore(Version, boolean), Node.restore(Version, String, boolean), Node.restoreByLabel(String, boolean)

restore

public void restore(NodeState[] versionStates,
           boolean removeExisting)
             throws javax.jcr.RepositoryException

Specified by:

restore in interface VersionManager

Throws:

javax.jcr.ItemExistsException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.version.VersionException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

Workspace.restore(Version[], boolean)

merge

public Iterator<NodeId> merge(NodeState nodeState,
                     String workspaceName,
                     boolean bestEffort)
                       throws javax.jcr.RepositoryException

Specified by:

merge in interface VersionManager

Returns:

An Iterator over NodeIds of all Nodes that failed to be merged and need manual resolution by the user of the API.

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.AccessDeniedException

javax.jcr.MergeException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

VersionManager.resolveMergeConflict(NodeState,NodeState,boolean), Node.merge(String, boolean)

merge

public Iterator<NodeId> merge(NodeState nodeState,
                     String workspaceName,
                     boolean bestEffort,
                     boolean isShallow)
                       throws javax.jcr.NoSuchWorkspaceException,
                              javax.jcr.AccessDeniedException,
                              javax.jcr.MergeException,
                              javax.jcr.lock.LockException,
                              javax.jcr.InvalidItemStateException,
                              javax.jcr.RepositoryException

Specified by:

merge in interface VersionManager

Returns:

An Iterator over NodeIds of all Nodes that failed to be merged and need manual resolution by the user of the API.

Throws:

javax.jcr.NoSuchWorkspaceException

javax.jcr.AccessDeniedException

javax.jcr.MergeException

javax.jcr.lock.LockException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

See Also:

VersionManager.resolveMergeConflict(NodeState,NodeState,boolean), Node.merge(String, boolean)

resolveMergeConflict

public void resolveMergeConflict(NodeState nodeState,
                        NodeState versionState,
                        boolean done)
                          throws javax.jcr.RepositoryException

Specified by:

resolveMergeConflict in interface VersionManager

Throws:

javax.jcr.version.VersionException

javax.jcr.InvalidItemStateException

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

Node.cancelMerge(Version), Node.doneMerge(Version)

createConfiguration

public NodeEntry createConfiguration(NodeState nodeState)
                              throws javax.jcr.UnsupportedRepositoryOperationException,
                                     javax.jcr.RepositoryException

Specified by:

createConfiguration in interface VersionManager

Returns:

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

createActivity

public NodeEntry createActivity(String title)
                         throws javax.jcr.UnsupportedRepositoryOperationException,
                                javax.jcr.RepositoryException

Specified by:

createActivity in interface VersionManager

Returns:

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

removeActivity

public void removeActivity(NodeState activityState)
                    throws javax.jcr.UnsupportedRepositoryOperationException,
                           javax.jcr.RepositoryException

Specified by:

removeActivity in interface VersionManager

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

mergeActivity

public Iterator<NodeId> mergeActivity(NodeState activityState)
                               throws javax.jcr.UnsupportedRepositoryOperationException,
                                      javax.jcr.RepositoryException

Specified by:

mergeActivity in interface VersionManager

Returns:

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

getVersionableNodeEntry

public NodeEntry getVersionableNodeEntry(NodeState versionState)
                                  throws javax.jcr.RepositoryException

Specified by:

getVersionableNodeEntry in interface VersionManager

Returns:

Throws:

javax.jcr.RepositoryException

getVersionHistoryEntry

public NodeEntry getVersionHistoryEntry(NodeState versionableState)
                                 throws javax.jcr.RepositoryException

Specified by:

getVersionHistoryEntry in interface VersionManager

Returns:

Throws:

javax.jcr.RepositoryException