|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jackrabbit.core.version.InternalVersionManagerImpl
public class InternalVersionManagerImpl
This Class implements a VersionManager.
Nested Class Summary | |
---|---|
static class |
InternalVersionManagerImpl.DynamicESCFactory
|
Field Summary | |
---|---|
protected NodeId |
activitiesId
|
protected NodeId |
historiesId
|
protected NodeTypeRegistry |
ntReg
Node type registry. |
protected LocalItemStateManager |
stateMgr
State manager for the version storage. |
Constructor Summary | |
---|---|
InternalVersionManagerImpl(PersistenceManager pMgr,
FileSystem fs,
NodeTypeRegistry ntReg,
DelegatingObservationDispatcher obsMgr,
NodeId systemId,
NodeId historiesId,
NodeId activitiesId,
ItemStateCacheFactory cacheFactory,
ISMLocking ismLocking)
Creates a new internal version manager |
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. |
protected String |
calculateCheckinVersionName(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
NodeStateEx node,
boolean simple)
Calculates the name of the new version that will be created by a checkin call. |
NodeId |
canCheckout(NodeStateEx state,
NodeId activityId)
invokes the checkout() on the persistent version manager. |
protected InternalVersion |
checkin(NodeStateEx node,
Calendar created)
Creates a new version of the given node using the given version creation time. |
InternalVersion |
checkin(Session session,
NodeStateEx node,
Calendar created)
invokes the checkin() on the persistent version manager and remaps the newly created version objects. |
void |
close()
Close this version manager. |
NodeId |
createActivity(Session session,
String title)
Creates a new activity |
protected InternalVersionItem |
createInternalVersionItem(NodeId id)
Creates an InternalVersionItem based on the NodeState
identified by id . |
protected VersionItemStateManager |
createItemStateManager(PersistenceManager pMgr,
NodeId rootId,
NodeTypeRegistry ntReg,
ItemStateCacheFactory cacheFactory,
ISMLocking ismLocking)
Creates a VersionItemStateManager or derivative. |
protected VersionHistoryInfo |
createVersionHistory(Session session,
NodeState node,
NodeId copiedFrom)
Creates a new version history. |
void |
externalUpdate(ChangeLog changes,
List<EventState> events,
long timestamp,
String userData)
Handle an external update. |
protected NodeStateEx |
getActivitiesRoot()
returns the activities root node |
InternalActivity |
getActivity(NodeId id)
Returns the activity with the given id |
InternalBaseline |
getBaseline(NodeId id)
Returns the baseline with the given id |
InternalVersionManagerImpl.DynamicESCFactory |
getEscFactory()
Returns the event state collection factory. |
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 NodeStateEx |
getHistoryRoot()
returns the version history root node |
protected InternalVersionItem |
getItem(NodeId id)
Returns the item with the given persistent id. |
protected static Name |
getName(String name)
Utility method that returns the given string as a name in the default namespace. |
protected NodeStateEx |
getNodeStateEx(NodeId parentNodeId)
Returns the node with the given persistent id. |
protected static NodeStateEx |
getParentNode(NodeStateEx parent,
String uuid,
Name interNT)
Utility method that returns the parent node under which the version history of the identified versionable node is or will be stored. |
PersistenceManager |
getPersistenceManager()
Return the persistence manager. |
protected SharedItemStateManager |
getSharedStateMgr()
Returns the shared item state manager. |
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,
NodeId copiedFrom)
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. |
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. |
protected InternalVersion |
internalCheckin(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
NodeStateEx node,
boolean simple,
Calendar created)
Checks in a node |
protected void |
internalRemoveActivity(org.apache.jackrabbit.core.version.InternalActivityImpl activity)
Removes the specified activity |
protected void |
internalRemoveVersion(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
Name name)
Removes the specified version from the history |
protected void |
itemDiscarded(InternalVersionItem item)
Invoked by the internal version item itself, when it's underlying persistence state was discarded. |
void |
itemsUpdated(Collection<InternalVersionItem> items)
Invoked by some external source to indicate that some items in the versions tree were updated. |
void |
removeActivity(Session session,
NodeId nodeId)
Removes an activity and all |
void |
removeVersion(Session session,
InternalVersionHistory history,
Name name)
Removes the specified version from the given version history. |
void |
setEventChannel(UpdateEventChannel eventChannel)
Set an event channel to inform about updates. |
protected InternalVersion |
setVersionLabel(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history,
Name version,
Name label,
boolean move)
Set version label on the specified version. |
InternalVersion |
setVersionLabel(Session session,
InternalVersionHistory history,
Name version,
Name label,
boolean move)
Sets the version label to the given version . |
void |
stateCreated(ItemState created)
Called when an ItemState has successfully
been created (i.e. its underlying persistent state was created). |
void |
stateDestroyed(ItemState destroyed)
Called when an ItemState has successfully been
removed (i.e. its underlying persistent state has been destroyed). |
void |
stateDiscarded(ItemState discarded)
Called when an ItemState has been discarded (i.e. it has
been rendered 'invalid'). |
void |
stateModified(ItemState modified)
Called when an ItemState has successfully
been modified (i.e. its underlying persistent state has changed). |
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 final NodeId historiesId
protected final NodeId activitiesId
Constructor Detail |
---|
public InternalVersionManagerImpl(PersistenceManager pMgr, FileSystem fs, NodeTypeRegistry ntReg, DelegatingObservationDispatcher obsMgr, NodeId systemId, NodeId historiesId, NodeId activitiesId, ItemStateCacheFactory cacheFactory, ISMLocking ismLocking) throws RepositoryException
pMgr
- underlying persistence managerfs
- workspace file systemntReg
- node type registryobsMgr
- observation managersystemId
- node id of the version storage parent (i.e. jcr:system)historiesId
- node id of the version storage (i.e. jcr:versionStorage)activitiesId
- node id of the activities storage (i.e. jcr:activities)cacheFactory
- item state cache factoryismLocking
- workspace item state locking
RepositoryException
- if an error occursMethod Detail |
---|
public VirtualItemStateProvider getVirtualItemStateProvider()
getVirtualItemStateProvider
in interface InternalVersionManager
public PersistenceManager getPersistenceManager()
public void close() throws Exception
close
in interface InternalVersionManager
Exception
- if an error occurspublic InternalVersionManagerImpl.DynamicESCFactory getEscFactory()
protected VersionHistoryInfo createVersionHistory(Session session, NodeState node, NodeId copiedFrom) throws RepositoryException
session
- repository sessionnode
- versionable node statecopiedFrom
- node id for the jcr:copiedFrom property
RepositoryException
- if an error occurrsgetVersionHistory(Session, NodeState, NodeId)
public NodeId createActivity(Session session, String title) throws RepositoryException
createActivity
in interface InternalVersionManager
session
- the current sessiontitle
- title of the new activity
RepositoryException
- if an error occurspublic void removeActivity(Session session, NodeId nodeId) throws RepositoryException
removeActivity
in interface InternalVersionManager
session
- the current sessionnodeId
- id of the activity to remove
RepositoryException
- if an error occurspublic boolean hasItem(NodeId id)
id
- the id of the item
true
if the item exists;
false
otherwiseprotected InternalVersionItem getItem(NodeId id) throws RepositoryException
id
- the id of the item
RepositoryException
- if an error occurspublic NodeId canCheckout(NodeStateEx state, NodeId activityId) throws RepositoryException
canCheckout
in interface InternalVersionManager
state
- node to checkoutactivityId
- node id if the current activity
RepositoryException
- if an error occurspublic InternalVersion checkin(Session session, NodeStateEx node, Calendar created) throws RepositoryException
checkin
in interface InternalVersionManager
session
- session that invokes the checkinnode
- node to checkincreated
- create time of the new version,
or null
for the current time
RepositoryException
- if an error occurspublic void removeVersion(Session session, InternalVersionHistory history, Name name) throws VersionException, RepositoryException
removeVersion
in interface InternalVersionManager
session
- the session that performs the removehistory
- version history to remove the version fromname
- name of the version
RepositoryException
- if an error occurs
VersionException
public InternalVersion setVersionLabel(Session session, InternalVersionHistory 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.
This method must not be synchronized since it could cause deadlocks with
item-reading listeners in the observation thread.
setVersionLabel
in interface InternalVersionManager
session
- the session that performs the operationhistory
- version historyversion
- name of the versionlabel
- new labelmove
- if true
label will be moved
null
RepositoryException
- if an error occurspublic void itemsUpdated(Collection<InternalVersionItem> items)
items
- items updatedpublic void setEventChannel(UpdateEventChannel eventChannel)
eventChannel
- event channelprotected void itemDiscarded(InternalVersionItem item)
item
- item that was discardedprotected 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 NodeStateEx getHistoryRoot()
protected NodeStateEx getActivitiesRoot()
protected SharedItemStateManager getSharedStateMgr()
protected VersionItemStateManager createItemStateManager(PersistenceManager pMgr, NodeId rootId, NodeTypeRegistry ntReg, ItemStateCacheFactory cacheFactory, ISMLocking ismLocking) throws ItemStateException
VersionItemStateManager
or derivative.
pMgr
- persistence managerrootId
- root node idntReg
- node type registrycacheFactory
- cache factoryismLocking
- the ISM locking implementation
ItemStateException
- if an error occurspublic void stateCreated(ItemState created)
ItemState
has successfully
been created (i.e. its underlying persistent state was created).
Not used.
stateCreated
in interface ItemStateListener
created
- the ItemState
that has been 'created'public void stateModified(ItemState modified)
ItemState
has successfully
been modified (i.e. its underlying persistent state has changed).
Not used.
stateModified
in interface ItemStateListener
modified
- the ItemState
that has been 'modified'public void stateDestroyed(ItemState destroyed)
ItemState
has successfully been
removed (i.e. its underlying persistent state has been destroyed).
Remove item from cache on removal.
stateDestroyed
in interface ItemStateListener
destroyed
- the ItemState
that has been 'destroyed'public void stateDiscarded(ItemState discarded)
ItemState
has been discarded (i.e. it has
been rendered 'invalid').
Not used.
stateDiscarded
in interface ItemStateListener
discarded
- the ItemState
that has been discardedItemState.discard()
public void externalUpdate(ChangeLog changes, List<EventState> events, long timestamp, String userData) throws RepositoryException
externalUpdate
in interface UpdateEventListener
changes
- external changes containing only node and property ids.events
- events to delivertimestamp
- when the change occured.userData
- the user data associated with this update.
RepositoryException
- if the update cannot be processedpublic InternalVersion getVersion(NodeId id) throws RepositoryException
getVersion
in interface InternalVersionManager
id
- id of the version to retrieve
null
RepositoryException
- if an error occurspublic InternalBaseline getBaseline(NodeId id) throws RepositoryException
getBaseline
in interface InternalVersionManager
id
- id of the baseline version to retrieve
null
if not found
RepositoryException
- if an error occurspublic InternalActivity getActivity(NodeId id) throws RepositoryException
getActivity
in interface InternalVersionManager
id
- id of the activity to retrieve
RepositoryException
- if an error occurspublic InternalVersionHistory getVersionHistory(NodeId id) throws RepositoryException
getVersionHistory
in interface InternalVersionManager
id
- id of the version history
RepositoryException
- if an error occurspublic InternalVersionHistory getVersionHistoryOfNode(NodeId id) throws RepositoryException
getVersionHistoryOfNode
in interface InternalVersionManager
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 InternalVersionManager
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, NodeId copiedFrom) throws RepositoryException
getVersionHistory
in interface InternalVersionManager
session
- workspace sessionnode
- node whose version history should be returnedcopiedFrom
- the node id for the jcr:copiedFrom property use for copied nodes
RepositoryException
- if an error occursprotected void internalRemoveActivity(org.apache.jackrabbit.core.version.InternalActivityImpl activity) throws RepositoryException
activity
- the acitvity to remove
RepositoryException
- if any other error occurs.protected static Name getName(String name)
name
- string name
Name
object.protected static NodeStateEx getParentNode(NodeStateEx parent, String uuid, Name interNT) throws RepositoryException
interNT
is not null
then the returned
parent node and any ancestor nodes are automatically created if they do
not already exist. Otherwise
null
is returned if the parent node does not exist.
parent
- the parent nodeuuid
- UUID of a versionable nodeinterNT
- intermediate nodetype.
null
RepositoryException
- if an error occursprotected InternalVersion checkin(NodeStateEx node, Calendar created) throws RepositoryException
node
- the node to be checked increated
- version creation time
RepositoryException
- if an error occursprotected InternalVersion internalCheckin(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeStateEx node, boolean simple, Calendar created) throws RepositoryException
history
- the version historynode
- node to checkinsimple
- flag indicates simple versioningcreated
- optional created date.
RepositoryException
- if an error occursNode.checkin()
protected String calculateCheckinVersionName(org.apache.jackrabbit.core.version.InternalVersionHistoryImpl history, NodeStateEx 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 internalRemoveVersion(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 itemprotected 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 |