|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.core.version.XAVersionManager
public class XAVersionManager
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 |
---|
protected LocalItemStateManager stateMgr
protected final NodeTypeRegistry ntReg
protected NodeStateEx historyRoot
Constructor Detail |
---|
public XAVersionManager(VersionManagerImpl vMgr, NodeTypeRegistry ntReg, SessionImpl session, ItemStateCacheFactory cacheFactory) throws RepositoryException
RepositoryException
Method Detail |
---|
public EventStateCollection createEventStateCollection() throws RepositoryException
EventStateCollectionFactory
EventStateCollection
.
createEventStateCollection
in interface EventStateCollectionFactory
EventStateCollection
RepositoryException
- if creation fails for some reasonpublic VirtualItemStateProvider getVirtualItemStateProvider()
getVirtualItemStateProvider
in interface VersionManager
protected VersionHistoryInfo createVersionHistory(Session session, NodeState node) throws RepositoryException
node
- NodeState
RepositoryException
getVersionHistory(Session, NodeState)
public Version checkin(NodeImpl node, Calendar cal) throws RepositoryException
checkin
in interface VersionManager
node
- node to checkincal
- create time of the new version, or null
RepositoryException
- if an error occurspublic void removeVersion(VersionHistory history, Name versionName) throws RepositoryException
removeVersion
in interface VersionManager
history
- version history to remove the version fromversionName
- name of the version
RepositoryException
- if an error occurspublic Version setVersionLabel(VersionHistory history, Name version, Name label, boolean move) throws RepositoryException
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.
setVersionLabel
in interface VersionManager
history
- version historyversion
- name of the versionlabel
- new labelmove
- if true
label will be moved
null
RepositoryException
- if an error occurspublic void close() throws Exception
close
in interface VersionManager
Exception
- if an error occurspublic boolean isVirtualRoot(ItemId id)
isVirtualRoot
in interface VirtualItemStateProvider
true
if it is the rootpublic NodeId getVirtualRootId()
getVirtualRootId
in interface VirtualItemStateProvider
public VirtualPropertyState createPropertyState(VirtualNodeState parent, Name name, int type, boolean multiValued) throws RepositoryException
createPropertyState
in interface VirtualItemStateProvider
RepositoryException
public VirtualNodeState createNodeState(VirtualNodeState parent, Name name, NodeId id, Name nodeTypeName) throws RepositoryException
createNodeState
in interface VirtualItemStateProvider
RepositoryException
public boolean setNodeReferences(ChangeLog references)
setNodeReferences
in interface VirtualItemStateProvider
references
- collection of NodeReferences
instances
true
if the reference target is one of its items.public ItemState getItemState(ItemId id) throws NoSuchItemStateException, ItemStateException
getItemState
in interface ItemStateManager
id
- item id
NoSuchItemStateException
- if the item does not exist
ItemStateException
- if an error occurspublic boolean hasItemState(ItemId id)
hasItemState
in interface ItemStateManager
id
- item id
true
if an item state exists,
otherwise false
public NodeReferences getNodeReferences(NodeReferencesId id) throws NoSuchItemStateException, ItemStateException
getNodeReferences
in interface ItemStateManager
id
- target id
NoSuchItemStateException
- if the item does not exist
ItemStateException
- if an error occurspublic boolean hasNodeReferences(NodeReferencesId id)
hasNodeReferences
in interface ItemStateManager
id
- target id
true
if a node reference object exists for the given
id, otherwise false
.public void addListener(ItemStateListener listener)
ItemStateListener
Not needed.
addListener
in interface VirtualItemStateProvider
listener
- the new listener to be informed on modificationspublic void removeListener(ItemStateListener listener)
ItemStateListener
Not needed.
removeListener
in interface VirtualItemStateProvider
listener
- an existing listenerprotected InternalVersionItem getItem(NodeId id) throws RepositoryException
id
- the id of the item
RepositoryException
- if an error occursprotected boolean hasItem(NodeId id)
id
- the id of the item
true
if the item exists;
false
otherwiseprotected boolean hasItemReferences(NodeId id) throws RepositoryException
id
- the id of the node
true
if there are item references from outside the
version storage; false
otherwise.
RepositoryException
- if an error occurs while reading from the
repository.protected NodeStateEx getNodeStateEx(NodeId parentNodeId) throws RepositoryException
parentNodeId
- the id of the node
RepositoryException
- if an error occurs while reading from the
repository.protected InternalVersion checkin(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeImpl node, boolean simple, Calendar cal) throws RepositoryException
history
- the version historynode
- node to checkinsimple
- flag indicates simple versioningcal
- create time of the new version, or null
RepositoryException
- if an error occursNode.checkin()
protected void removeVersion(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, Name name) throws VersionException, RepositoryException
history
- the version history from where to remove the version.name
- the name of the version to remove.
VersionException
- if the version history
does
not have a version with name
.
RepositoryException
- if any other error occurs.protected InternalVersion setVersionLabel(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, Name version, Name label, boolean move) throws RepositoryException
history
- version historyversion
- version namelabel
- version labelmove
- true
to move from existing version;
false
otherwise.
RepositoryException
- if an error occursprotected void versionCreated(InternalVersion version)
version
- internal version itemprotected void versionDestroyed(InternalVersion version)
version
- internal version itempublic void associate(TransactionContext tx)
associate
in interface InternalXAResource
tx
- transaction context, if null
disassociatepublic void beforeOperation(TransactionContext tx)
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.
beforeOperation
in interface InternalXAResource
tx
- transaction contextpublic void prepare(TransactionContext tx) throws TransactionException
prepare
in interface InternalXAResource
tx
- transaction context
TransactionException
- if an error occurspublic void commit(TransactionContext tx) throws TransactionException
commit
in interface InternalXAResource
tx
- transaction context
TransactionException
- if an error occurspublic void rollback(TransactionContext tx)
rollback
in interface InternalXAResource
tx
- transaction context.public void afterOperation(TransactionContext tx)
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.
afterOperation
in interface InternalXAResource
tx
- transaction contextpublic InternalXAResource getXAResourceBegin()
InternalXAResource
that acquires a write lock on the
version manager in InternalXAResource.prepare(TransactionContext)
.
public InternalXAResource getXAResourceEnd()
InternalXAResource
that releases the write lock on the
version manager in InternalXAResource.commit(TransactionContext)
or InternalXAResource.rollback(TransactionContext)
.
public InternalVersion getVersion(NodeId id) throws RepositoryException
getVersion
in interface VersionManager
id
- id of the version to retrieve
RepositoryException
- if an error occurspublic InternalVersionHistory getVersionHistory(NodeId id) throws RepositoryException
getVersionHistory
in interface VersionManager
id
- id of the version history
RepositoryException
- if an error occurspublic InternalVersionHistory getVersionHistoryOfNode(NodeId id) throws RepositoryException
getVersionHistoryOfNode
in interface VersionManager
id
- id of the node to retrieve the version history for
RepositoryException
- if an error occurs or the history does not exitpublic InternalVersion getHeadVersionOfNode(NodeId id) throws RepositoryException
getHeadVersionOfNode
in interface VersionManager
id
- id of the node to retrieve the version for
RepositoryException
- if an error occursprotected ISMLocking.WriteLock acquireWriteLock()
protected ISMLocking.ReadLock acquireReadLock()
public VersionHistoryInfo getVersionHistory(Session session, NodeState node) throws RepositoryException
getVersionHistory
in interface VersionManager
session
- workspace sessionnode
- node whose version history should be returned
RepositoryException
- if an error occursprotected String calculateCheckinVersionName(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeImpl node, boolean simple) throws RepositoryException
history
- the version historynode
- the node to checkinsimple
- if true
indicates simple versioning
RepositoryException
- if an error occurs.protected void itemDiscarded(InternalVersionItem item)
item
- protected InternalVersionItem createInternalVersionItem(NodeId id) throws RepositoryException
InternalVersionItem
based on the NodeState
identified by id
.
id
- the node id of the version item.
null
if there is no node state
with the given id
.
RepositoryException
- if an error occurs while reading from the
version storage.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |