org.apache.jackrabbit.oak.jcr.version

Class ReadWriteVersionManager

java.lang.Object

org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

org.apache.jackrabbit.oak.jcr.version.ReadWriteVersionManager

public class ReadWriteVersionManager
extends org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

ReadWriteVersionManager...

Constructor Summary

Constructors

Constructor and Description
ReadWriteVersionManager(@NotNull SessionDelegate sessionDelegate)

Method Summary

Modifier and Type	Method and Description
void	addVersionLabel(@NotNull VersionStorage versionStorage, @NotNull String versionHistoryOakRelPath, @NotNull String versionIdentifier, @NotNull String oakVersionLabel, boolean moveLabel)
@NotNull org.apache.jackrabbit.oak.api.Tree	checkin(@NotNull org.apache.jackrabbit.oak.api.Tree versionable) Performs a checkin on a versionable tree and returns the tree that represents the created version.
void	checkout(@NotNull org.apache.jackrabbit.oak.api.Root workspaceRoot, @NotNull String versionablePath) Performs a checkout on a versionable tree.
protected @NotNull org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager	getNodeTypeManager()
protected @NotNull org.apache.jackrabbit.oak.api.Tree	getVersionStorage()
protected @NotNull org.apache.jackrabbit.oak.api.Root	getWorkspaceRoot()
protected void	refresh() Called by the write methods to refresh the state of the possible session associated with this instance.
void	removeVersion(@NotNull VersionStorage versionStorage, @NotNull String versionHistoryOakRelPath, @NotNull String oakVersionName)
void	removeVersionLabel(@NotNull VersionStorage versionStorage, @NotNull String versionHistoryOakRelPath, @NotNull String oakVersionLabel)

Methods inherited from class org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

checkVersionable, getBaseVersion, getIdentifierManager, getInstance, getVersion, getVersionable, getVersionHistory, getVersionHistoryPath, isCheckedOut, isVersionable, isVersionStoreTree

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadWriteVersionManager

public ReadWriteVersionManager(@NotNull
                               @NotNull SessionDelegate sessionDelegate)

Method Detail

refresh

protected void refresh()
                throws RepositoryException

Called by the write methods to refresh the state of the possible session associated with this instance. The default implementation of this method does nothing, but a subclass can use this callback to keep a session in sync with the persisted version changes.

Throws:

RepositoryException - if the session could not be refreshed

getVersionStorage

@NotNull
protected @NotNull org.apache.jackrabbit.oak.api.Tree getVersionStorage()

Specified by:

getVersionStorage in class org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

getWorkspaceRoot

@NotNull
protected @NotNull org.apache.jackrabbit.oak.api.Root getWorkspaceRoot()

Specified by:

getWorkspaceRoot in class org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

getNodeTypeManager

@NotNull
protected @NotNull org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager getNodeTypeManager()

Specified by:

getNodeTypeManager in class org.apache.jackrabbit.oak.plugins.version.ReadOnlyVersionManager

checkin

@NotNull
public @NotNull org.apache.jackrabbit.oak.api.Tree checkin(@NotNull
                                                                    @NotNull org.apache.jackrabbit.oak.api.Tree versionable)
                                                             throws RepositoryException,
                                                                    InvalidItemStateException,
                                                                    UnsupportedRepositoryOperationException

Performs a checkin on a versionable tree and returns the tree that represents the created version.

Parameters:

versionable - the versionable node to check in.

Returns:

the created version.

Throws:

InvalidItemStateException - if the current root has pending changes.

UnsupportedRepositoryOperationException - if the versionable tree isn't actually versionable.

RepositoryException - if an error occurs while checking the node type of the tree.

checkout

public void checkout(@NotNull
                     @NotNull org.apache.jackrabbit.oak.api.Root workspaceRoot,
                     @NotNull
                     @NotNull String versionablePath)
              throws UnsupportedRepositoryOperationException,
                     InvalidItemStateException,
                     RepositoryException

Performs a checkout on a versionable tree.

Parameters:

workspaceRoot - a fresh workspace root without pending changes.

versionablePath - the absolute path to the versionable node to check out.

Throws:

UnsupportedRepositoryOperationException - if the versionable tree isn't actually versionable.

RepositoryException - if an error occurs while checking the node type of the tree.

IllegalStateException - if the workspaceRoot has pending changes.

IllegalArgumentException - if the versionablePath is not absolute.

InvalidItemStateException

addVersionLabel

public void addVersionLabel(@NotNull
                            @NotNull VersionStorage versionStorage,
                            @NotNull
                            @NotNull String versionHistoryOakRelPath,
                            @NotNull
                            @NotNull String versionIdentifier,
                            @NotNull
                            @NotNull String oakVersionLabel,
                            boolean moveLabel)
                     throws RepositoryException

Throws:

RepositoryException

removeVersionLabel

public void removeVersionLabel(@NotNull
                               @NotNull VersionStorage versionStorage,
                               @NotNull
                               @NotNull String versionHistoryOakRelPath,
                               @NotNull
                               @NotNull String oakVersionLabel)
                        throws RepositoryException

Throws:

RepositoryException

removeVersion

public void removeVersion(@NotNull
                          @NotNull VersionStorage versionStorage,
                          @NotNull
                          @NotNull String versionHistoryOakRelPath,
                          @NotNull
                          @NotNull String oakVersionName)
                   throws RepositoryException

Throws:

RepositoryException