org.apache.jackrabbit.core.version
Class XAVersionManager

java.lang.Object
  org.apache.jackrabbit.core.version.XAVersionManager

All Implemented Interfaces:

InternalXAResource, EventStateCollectionFactory, ItemStateManager, VersionManager, VirtualItemStateProvider

public class XAVersionManager
extends Object
implements EventStateCollectionFactory, VirtualItemStateProvider, InternalXAResource

Implementation of a VersionManager that works in an XA environment. Works as a filter between a version manager client and the global version manager.

Field Summary

protected NodeStateEx	historyRoot Persistent root node of the version histories.
protected NodeTypeRegistry	ntReg Node type registry.
protected LocalItemStateManager	stateMgr State manager for the version storage.

Constructor Summary

XAVersionManager(VersionManagerImpl vMgr, NodeTypeRegistry ntReg, SessionImpl session, ItemStateCacheFactory cacheFactory)
Creates a new instance of this class.

Method Summary

protected ISMLocking.ReadLock	acquireReadLock() acquires the read lock on this version manager.
protected ISMLocking.WriteLock	acquireWriteLock() Acquires the write lock on this version manager.
void	addListener(ItemStateListener listener) Add an ItemStateListener
void	afterOperation(TransactionContext tx) Invoked after one of the InternalXAResource.prepare(org.apache.jackrabbit.core.TransactionContext), InternalXAResource.commit(org.apache.jackrabbit.core.TransactionContext) or InternalXAResource.rollback(org.apache.jackrabbit.core.TransactionContext) method has been called.
void	associate(TransactionContext tx) Associate this resource with a transaction.
void	beforeOperation(TransactionContext tx) Invoked before one of the InternalXAResource.prepare(org.apache.jackrabbit.core.TransactionContext), InternalXAResource.commit(org.apache.jackrabbit.core.TransactionContext) or InternalXAResource.rollback(org.apache.jackrabbit.core.TransactionContext) method is called.
protected String	calculateCheckinVersionName(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeImpl node, boolean simple) Calculates the name of the new version that will be created by a checkin call.
protected InternalVersion	checkin(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeImpl node, boolean simple, Calendar cal) Checks in a node
Version	checkin(NodeImpl node, Calendar cal) invokes the checkin() on the persistent version manager and remaps the newly created version objects.
void	close() Close this version manager.
void	commit(TransactionContext tx) Commit transaction.
EventStateCollection	createEventStateCollection() Creates an EventStateCollection.
protected InternalVersionItem	createInternalVersionItem(NodeId id) Creates an InternalVersionItem based on the NodeState identified by id.
VirtualNodeState	createNodeState(VirtualNodeState parent, Name name, NodeId id, Name nodeTypeName) Creates a new virtual node state
VirtualPropertyState	createPropertyState(VirtualNodeState parent, Name name, int type, boolean multiValued) Creats a new virtual property state
protected VersionHistoryInfo	createVersionHistory(Session session, NodeState node) Creates a new version history.
InternalVersion	getHeadVersionOfNode(NodeId id) Returns the head version of the node with the given id. this is always the last of all versions. this only works correctly for liner version graphs (i.e. simple versioning)
protected InternalVersionItem	getItem(NodeId id) Returns the item with the given persistent id.
ItemState	getItemState(ItemId id) Return an item state, given its item id.
NodeReferences	getNodeReferences(NodeReferencesId id) Return a node references object, given its target id
protected NodeStateEx	getNodeStateEx(NodeId parentNodeId) Returns the node with the given persistent id.
InternalVersion	getVersion(NodeId id) Returns the version with the given id
InternalVersionHistory	getVersionHistory(NodeId id) Returns the version history with the given id
VersionHistoryInfo	getVersionHistory(Session session, NodeState node) Returns information about the version history of the specified node.
InternalVersionHistory	getVersionHistoryOfNode(NodeId id) Returns the version history for the versionable node with the given id.
VirtualItemStateProvider	getVirtualItemStateProvider() returns the virtual item state provider that exposes the internal versions as items.
NodeId	getVirtualRootId() Returns the id of the root node of the virtual tree.
InternalXAResource	getXAResourceBegin() Returns an InternalXAResource that acquires a write lock on the version manager in InternalXAResource.prepare(TransactionContext).
InternalXAResource	getXAResourceEnd() Returns an InternalXAResource that releases the write lock on the version manager in InternalXAResource.commit(TransactionContext) or InternalXAResource.rollback(TransactionContext).
protected boolean	hasItem(NodeId id) Return a flag indicating if the item specified exists.
protected boolean	hasItemReferences(NodeId id) Checks if there are item references (from outside the version storage) that reference the given node.
boolean	hasItemState(ItemId id) Return a flag indicating whether an item state for a given item id exists.
boolean	hasNodeReferences(NodeReferencesId id) Return a flag indicating whether a node references object for a given target id exists.
boolean	isVirtualRoot(ItemId id) Checks if the id refers to the root of a virtual tree.
protected void	itemDiscarded(InternalVersionItem item) Invoked by the internal version item itself, when it's underlying persistence state was discarded.
void	prepare(TransactionContext tx) Prepare transaction.
void	removeListener(ItemStateListener listener) Remove an ItemStateListener
protected void	removeVersion(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, Name name) Removes the specified version from the history
void	removeVersion(VersionHistory history, Name versionName) Removes the specified version from the given version history.
void	rollback(TransactionContext tx) Rollback transaction.
boolean	setNodeReferences(ChangeLog references) Informs this provider that the node references to some of its states have changed.
protected InternalVersion	setVersionLabel(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, Name version, Name label, boolean move) Set version label on the specified version.
Version	setVersionLabel(VersionHistory history, Name version, Name label, boolean move) Sets the version label to the given version.
protected void	versionCreated(InternalVersion version) Invoked when a new internal item has been created.
protected void	versionDestroyed(InternalVersion version) Invoked when a new internal item has been destroyed.

Methods inherited from class java.lang.Object

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

Field Detail

stateMgr

protected LocalItemStateManager stateMgr

State manager for the version storage.

ntReg

protected final NodeTypeRegistry ntReg

Node type registry.

historyRoot

protected NodeStateEx historyRoot

Persistent root node of the version histories.

Constructor Detail

XAVersionManager

public XAVersionManager(VersionManagerImpl vMgr,
                        NodeTypeRegistry ntReg,
                        SessionImpl session,
                        ItemStateCacheFactory cacheFactory)
                 throws RepositoryException

Creates a new instance of this class.

Throws:

RepositoryException

Method Detail

createEventStateCollection

public EventStateCollection createEventStateCollection()
                                                throws RepositoryException

Description copied from interface: EventStateCollectionFactory

Creates an EventStateCollection.

Specified by:

createEventStateCollection in interface EventStateCollectionFactory

Returns:

a new EventStateCollection

Throws:

RepositoryException - if creation fails for some reason

getVirtualItemStateProvider

public VirtualItemStateProvider getVirtualItemStateProvider()

returns the virtual item state provider that exposes the internal versions as items.

Specified by:

getVirtualItemStateProvider in interface VersionManager

Returns:

the virtual item state provider.

createVersionHistory

protected VersionHistoryInfo createVersionHistory(Session session,
                                                  NodeState node)
                                           throws RepositoryException

Creates a new version history. This action is needed either when creating a new 'mix:versionable' node or when adding the 'mix:versionable' mixin to a node.

node - NodeState

Returns:

identifier of the new version history node

Throws:

RepositoryException

See Also:

getVersionHistory(Session, NodeState)

checkin

public Version checkin(NodeImpl node,
                       Calendar cal)
                throws RepositoryException

invokes the checkin() on the persistent version manager and remaps the newly created version objects.

Specified by:

checkin in interface VersionManager

Parameters:

node - node to checkin

cal - create time of the new version, or null

Returns:

the newly created version

Throws:

RepositoryException - if an error occurs

removeVersion

public void removeVersion(VersionHistory history,
                          Name versionName)
                   throws RepositoryException

Removes the specified version from the given version history.

Specified by:

removeVersion in interface VersionManager

Parameters:

history - version history to remove the version from

versionName - name of the version

Throws:

RepositoryException - if an error occurs

setVersionLabel

public Version setVersionLabel(VersionHistory history,
                               Name version,
                               Name label,
                               boolean move)
                        throws RepositoryException

Sets the version label to the given version. If the label is already assigned to another version, a VersionException is thrown unless move is true. If version is null, the label is removed from the respective version. In either case, the version the label was previously assigned is returned, or null of the label was not moved.

Specified by:

setVersionLabel in interface VersionManager

Parameters:

history - version history

version - name of the version

label - new label

move - if true label will be moved

Returns:

the version that had the label or null

Throws:

RepositoryException - if an error occurs

close

public void close()
           throws Exception

Close this version manager. After having closed a persistence manager, further operations on this object are treated as illegal and throw

Specified by:

close in interface VersionManager

Throws:

Exception - if an error occurs

isVirtualRoot

public boolean isVirtualRoot(ItemId id)

Checks if the id refers to the root of a virtual tree.

Specified by:

isVirtualRoot in interface VirtualItemStateProvider

Returns:

true if it is the root

getVirtualRootId

public NodeId getVirtualRootId()

Returns the id of the root node of the virtual tree.

Specified by:

getVirtualRootId in interface VirtualItemStateProvider

Returns:

the id of the root node of the virtual tree.

createPropertyState

public VirtualPropertyState createPropertyState(VirtualNodeState parent,
                                                Name name,
                                                int type,
                                                boolean multiValued)
                                         throws RepositoryException

Creats a new virtual property state

Specified by:

createPropertyState in interface VirtualItemStateProvider

Returns:

Throws:

RepositoryException

createNodeState

public VirtualNodeState createNodeState(VirtualNodeState parent,
                                        Name name,
                                        NodeId id,
                                        Name nodeTypeName)
                                 throws RepositoryException

Creates a new virtual node state

Specified by:

createNodeState in interface VirtualItemStateProvider

Returns:

Throws:

RepositoryException

setNodeReferences

public boolean setNodeReferences(ChangeLog references)

Informs this provider that the node references to some of its states have changed.

Specified by:

setNodeReferences in interface VirtualItemStateProvider

Parameters:

references - collection of NodeReferences instances

Returns:

true if the reference target is one of its items.

getItemState

public ItemState getItemState(ItemId id)
                       throws NoSuchItemStateException,
                              ItemStateException

Return an item state, given its item id.

Return item states for changes only. Global version manager will return other items.

Specified by:

getItemState in interface ItemStateManager

Parameters:

id - item id

Returns:

item state

Throws:

NoSuchItemStateException - if the item does not exist

ItemStateException - if an error occurs

hasItemState

public boolean hasItemState(ItemId id)

Return a flag indicating whether an item state for a given item id exists.

Specified by:

hasItemState in interface ItemStateManager

Parameters:

id - item id

Returns:

true if an item state exists, otherwise false

getNodeReferences

public NodeReferences getNodeReferences(NodeReferencesId id)
                                 throws NoSuchItemStateException,
                                        ItemStateException

Return a node references object, given its target id

Specified by:

getNodeReferences in interface ItemStateManager

Parameters:

id - target id

Returns:

node references object

Throws:

NoSuchItemStateException - if the item does not exist

ItemStateException - if an error occurs

hasNodeReferences

public boolean hasNodeReferences(NodeReferencesId id)

Return a flag indicating whether a node references object for a given target id exists.

Specified by:

hasNodeReferences in interface ItemStateManager

Parameters:

id - target id

Returns:

true if a node reference object exists for the given id, otherwise false.

addListener

public void addListener(ItemStateListener listener)

Add an ItemStateListener

Not needed.

Specified by:

addListener in interface VirtualItemStateProvider

Parameters:

listener - the new listener to be informed on modifications

removeListener

public void removeListener(ItemStateListener listener)

Remove an ItemStateListener

Not needed.

Specified by:

removeListener in interface VirtualItemStateProvider

Parameters:

listener - an existing listener

getItem

protected InternalVersionItem getItem(NodeId id)
                               throws RepositoryException

Returns the item with the given persistent id. Subclass responsibility.

Please note, that the overridden method must acquire the readlock before reading the state manager.

Parameters:

id - the id of the item

Returns:

version item

Throws:

RepositoryException - if an error occurs

hasItem

protected boolean hasItem(NodeId id)

Return a flag indicating if the item specified exists. Subclass responsibility.

Parameters:

id - the id of the item

Returns:

true if the item exists; false otherwise

hasItemReferences

protected boolean hasItemReferences(NodeId id)
                             throws RepositoryException

Checks if there are item references (from outside the version storage) that reference the given node. Subclass responsibility.

Please note, that the overridden method must acquire the readlock before reading the state manager.

Parameters:

id - the id of the node

Returns:

true if there are item references from outside the version storage; false otherwise.

Throws:

RepositoryException - if an error occurs while reading from the repository.

getNodeStateEx

protected NodeStateEx getNodeStateEx(NodeId parentNodeId)
                              throws RepositoryException

Returns the node with the given persistent id. Subclass responsibility.

Please note, that the overridden method must acquire the readlock before reading the state manager.

Parameters:

parentNodeId - the id of the node

Throws:

RepositoryException - if an error occurs while reading from the repository.

checkin

protected InternalVersion checkin(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
                                  NodeImpl node,
                                  boolean simple,
                                  Calendar cal)
                           throws RepositoryException

Checks in a node

Before modifying version history given, make a local copy of it.

Parameters:

history - the version history

node - node to checkin

simple - flag indicates simple versioning

cal - create time of the new version, or null

Returns:

internal version

Throws:

RepositoryException - if an error occurs

See Also:

Node.checkin()

removeVersion

protected void removeVersion(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
                             Name name)
                      throws VersionException,
                             RepositoryException

Removes the specified version from the history

Before modifying version history given, make a local copy of it.

Parameters:

history - the version history from where to remove the version.

name - the name of the version to remove.

Throws:

VersionException - if the version history does not have a version with name.

RepositoryException - if any other error occurs.

setVersionLabel

protected InternalVersion setVersionLabel(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
                                          Name version,
                                          Name label,
                                          boolean move)
                                   throws RepositoryException

Set version label on the specified version.

Before modifying version history given, make a local copy of it.

Parameters:

history - version history

version - version name

label - version label

move - true to move from existing version; false otherwise.

Returns:

The internal version.

Throws:

RepositoryException - if an error occurs

versionCreated

protected void versionCreated(InternalVersion version)

Invoked when a new internal item has been created.

Put the version object into our cache.

Parameters:

version - internal version item

versionDestroyed

protected void versionDestroyed(InternalVersion version)

Invoked when a new internal item has been destroyed.

Remove the version object from our cache.

Parameters:

version - internal version item

associate

public void associate(TransactionContext tx)

Associate this resource with a transaction. All further operations on the object should be interpreted as part of this transaction and changes recorded in some attribute of the transaction context.

Specified by:

associate in interface InternalXAResource

Parameters:

tx - transaction context, if null disassociate

beforeOperation

public void beforeOperation(TransactionContext tx)

Invoked before one of the InternalXAResource.prepare(org.apache.jackrabbit.core.TransactionContext), InternalXAResource.commit(org.apache.jackrabbit.core.TransactionContext) or InternalXAResource.rollback(org.apache.jackrabbit.core.TransactionContext) method is called.

Delegate the call to our XA item state manager.

Specified by:

beforeOperation in interface InternalXAResource

Parameters:

tx - transaction context

prepare

public void prepare(TransactionContext tx)
             throws TransactionException

Prepare transaction. The transaction is identified by a transaction context.

Delegate the call to our XA item state manager.

Specified by:

prepare in interface InternalXAResource

Parameters:

tx - transaction context

Throws:

TransactionException - if an error occurs

commit

public void commit(TransactionContext tx)
            throws TransactionException

Commit transaction. The transaction is identified by a transaction context. If the method throws, other resources get their changes rolled back.

Delegate the call to our XA item state manager. If successful, inform global repository manager to update its caches.

Specified by:

commit in interface InternalXAResource

Parameters:

tx - transaction context

Throws:

TransactionException - if an error occurs

rollback

public void rollback(TransactionContext tx)

Rollback transaction. The transaction is identified by a transaction context.

Delegate the call to our XA item state manager.

Specified by:

rollback in interface InternalXAResource

Parameters:

tx - transaction context.

afterOperation

public void afterOperation(TransactionContext tx)

Invoked after one of the InternalXAResource.prepare(org.apache.jackrabbit.core.TransactionContext), InternalXAResource.commit(org.apache.jackrabbit.core.TransactionContext) or InternalXAResource.rollback(org.apache.jackrabbit.core.TransactionContext) method has been called.

Delegate the call to our XA item state manager.

Specified by:

afterOperation in interface InternalXAResource

Parameters:

tx - transaction context

getXAResourceBegin

public InternalXAResource getXAResourceBegin()

Returns an InternalXAResource that acquires a write lock on the version manager in InternalXAResource.prepare(TransactionContext).

Returns:

an internal XA resource.

getXAResourceEnd

public InternalXAResource getXAResourceEnd()

Returns an InternalXAResource that releases the write lock on the version manager in InternalXAResource.commit(TransactionContext) or InternalXAResource.rollback(TransactionContext).

Returns:

an internal XA resource.

getVersion

public InternalVersion getVersion(NodeId id)
                           throws RepositoryException

Returns the version with the given id

Specified by:

getVersion in interface VersionManager

Parameters:

id - id of the version to retrieve

Returns:

the version.

Throws:

RepositoryException - if an error occurs

getVersionHistory

public InternalVersionHistory getVersionHistory(NodeId id)
                                         throws RepositoryException

Returns the version history with the given id

Specified by:

getVersionHistory in interface VersionManager

Parameters:

id - id of the version history

Returns:

the version history.

Throws:

RepositoryException - if an error occurs

getVersionHistoryOfNode

public InternalVersionHistory getVersionHistoryOfNode(NodeId id)
                                               throws RepositoryException

Returns the version history for the versionable node with the given id.

Specified by:

getVersionHistoryOfNode in interface VersionManager

Parameters:

id - id of the node to retrieve the version history for

Returns:

the version history

Throws:

RepositoryException - if an error occurs or the history does not exit

getHeadVersionOfNode

public InternalVersion getHeadVersionOfNode(NodeId id)
                                     throws RepositoryException

Returns the head version of the node with the given id. this is always the last of all versions. this only works correctly for liner version graphs (i.e. simple versioning) Assumes that all versions are stored chronologically below the version history and just returns the last one. i.e. currently only works for simple versioning.

Specified by:

getHeadVersionOfNode in interface VersionManager

Parameters:

id - id of the node to retrieve the version for

Returns:

the version.

Throws:

RepositoryException - if an error occurs

acquireWriteLock

protected ISMLocking.WriteLock acquireWriteLock()

Acquires the write lock on this version manager.

acquireReadLock

protected ISMLocking.ReadLock acquireReadLock()

acquires the read lock on this version manager.

getVersionHistory

public VersionHistoryInfo getVersionHistory(Session session,
                                            NodeState node)
                                     throws RepositoryException

Returns information about the version history of the specified node. If the given node does not already have an associated version history, then an empty history is automatically created. This method should only be called by code that already knows that the specified node is versionable.

Specified by:

getVersionHistory in interface VersionManager

Parameters:

session - workspace session

node - node whose version history should be returned

Returns:

identifiers of the version history and root version nodes

Throws:

RepositoryException - if an error occurs

calculateCheckinVersionName

protected String calculateCheckinVersionName(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
                                             NodeImpl node,
                                             boolean simple)
                                      throws RepositoryException

Calculates the name of the new version that will be created by a checkin call. The name is determined as follows:

• first the predecessor version with the shortes name is searched.
• if that predecessor version is the root version, the new version gets the name "{number of successors}+1" + ".0"
• if that predecessor version has no successor, the last digit of it's version number is incremented.
• if that predecessor version has successors but the incremented name does not exist, that name is used.
• otherwise a ".0" is added to the name until a non conflicting name is found.
  Example Graph: jcr:rootVersion | | 1.0 2.0 | 1.1 | 1.2 ---\ ------\ | \ \ 1.3 1.2.0 1.2.0.0 | | 1.4 1.2.1 ----\ | | \ 1.5 1.2.2 1.2.1.0 | | | 1.6 | 1.2.1.1 |-----/ 1.7

  Parameters:

  history - the version history

  node - the node to checkin

  simple - if true indicates simple versioning

  Returns:

  the new version name

  Throws:

  RepositoryException - if an error occurs.

itemDiscarded

protected void itemDiscarded(InternalVersionItem item)

Invoked by the internal version item itself, when it's underlying persistence state was discarded.

Parameters:

item -

createInternalVersionItem

protected InternalVersionItem createInternalVersionItem(NodeId id)
                                                 throws RepositoryException

Creates an InternalVersionItem based on the NodeState identified by id.

Parameters:

id - the node id of the version item.

Returns:

the version item or null if there is no node state with the given id.

Throws:

RepositoryException - if an error occurs while reading from the version storage.