org.apache.jackrabbit.core.state

Class LocalItemStateManager

java.lang.Object

org.apache.jackrabbit.core.state.LocalItemStateManager

All Implemented Interfaces:

ItemStateListener, ItemStateManager, NodeStateListener, UpdatableItemStateManager

Direct Known Subclasses:

XAItemStateManager

public class LocalItemStateManager
extends Object
implements UpdatableItemStateManager, NodeStateListener

Local ItemStateManager that isolates changes to persistent states from other clients.

Field Summary

Fields

Modifier and Type	Field and Description
protected EventStateCollectionFactory	factory Event state collection factory.
protected SharedItemStateManager	sharedStateMgr Shared item state manager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocalItemStateManager(SharedItemStateManager sharedStateMgr, EventStateCollectionFactory factory, ItemStateCacheFactory cacheFactory) Creates a new LocalItemStateManager instance.

Method Summary

Modifier and Type	Method and Description
void	addListener(ItemStateListener listener) Add an ItemStateListener
void	cancel() Cancel an update operation.
static LocalItemStateManager	createInstance(SharedItemStateManager sharedStateMgr, EventStateCollectionFactory factory, ItemStateCacheFactory cacheFactory) Creates a new LocalItemStateManager instance and registers it as an ItemStateListener with the given SharedItemStateManager.
PropertyState	createNew(Name propName, NodeId parentId) Creates a PropertyState instance representing new, i.e.
NodeState	createNew(NodeId id, Name nodeTypeName, NodeId parentId) Creates a NodeState instance representing new, i.e.
void	destroy(ItemState state) Destroy an item state.
void	dispose() Disposes this UpdatableItemStateManager and frees resources.
void	edit() Start an edit operation on items inside this manager.
protected ChangeLog	getChanges() Returns the change log that contains the current changes in this local item state manager.
ItemState	getItemState(ItemId id) Return an item state, given its item id.
NodeIdFactory	getNodeIdFactory()
NodeReferences	getNodeReferences(NodeId id) Return a node references object, given its target id
protected NodeState	getNodeState(NodeId id) Retrieve a node state from the parent shared state manager and wraps it into a intermediate object that helps us handle local modifications.
NodeState	getOrCreateLocalState(NodeState transientState) Returns the local node state below the given transient one.
protected PropertyState	getPropertyState(PropertyId id) Retrieve a property state from the parent shared state manager and wraps it into a intermediate object that helps us handle local modifications.
boolean	hasItemState(ItemId id) Return a flag indicating whether an item state for a given item id exists.
boolean	hasNodeReferences(NodeId id) Return a flag indicating whether a node references object for a given target id exists.
boolean	inEditMode() Returns true if this manager is in edit mode i.e.
void	nodeAdded(NodeState state, Name name, int index, NodeId id) Called when a child node has been added
void	nodeModified(NodeState state) Called when a node has been modified, typically as a result of removal or addition of a child node.
void	nodeRemoved(NodeState state, Name name, int index, NodeId id) Called when a child node has been removed
void	nodesReplaced(NodeState state) Called when the children nodes were replaced by other nodes, typically as result of a reorder operation.
void	removeListener(ItemStateListener listener) Remove an ItemStateListener
void	stateCreated(ItemState created) Called when an ItemState has successfully been created (i.e.
void	stateDestroyed(ItemState destroyed) Called when an ItemState has successfully been removed (i.e.
void	stateDiscarded(ItemState discarded) Called when an ItemState has been discarded (i.e.
void	stateModified(ItemState modified) Called when an ItemState has successfully been modified (i.e.
void	store(ItemState state) Store an item state.
void	update() End an update operation.
protected void	update(ChangeLog changeLog) End an update operation.

Methods inherited from class java.lang.Object

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

Field Detail

sharedStateMgr

protected final SharedItemStateManager sharedStateMgr

Shared item state manager

factory

protected final EventStateCollectionFactory factory

Event state collection factory.

Constructor Detail

LocalItemStateManager

protected LocalItemStateManager(SharedItemStateManager sharedStateMgr,
                                EventStateCollectionFactory factory,
                                ItemStateCacheFactory cacheFactory)

Creates a new LocalItemStateManager instance.

Parameters:

sharedStateMgr - shared state manager

factory - event state collection factory

Method Detail

createInstance

public static LocalItemStateManager createInstance(SharedItemStateManager sharedStateMgr,
                                                   EventStateCollectionFactory factory,
                                                   ItemStateCacheFactory cacheFactory)

Creates a new LocalItemStateManager instance and registers it as an ItemStateListener with the given SharedItemStateManager.

Parameters:

sharedStateMgr - the SharedItemStateManager

factory - the EventStateCollectionFactory

cacheFactory - the ItemStateCacheFactory

Returns:

a new LocalItemStateManager instance

getNodeState

protected NodeState getNodeState(NodeId id)
                          throws NoSuchItemStateException,
                                 ItemStateException

Retrieve a node state from the parent shared state manager and wraps it into a intermediate object that helps us handle local modifications.

Parameters:

id - node id

Returns:

node state

Throws:

NoSuchItemStateException

ItemStateException

getPropertyState

protected PropertyState getPropertyState(PropertyId id)
                                  throws NoSuchItemStateException,
                                         ItemStateException

Retrieve a property state from the parent shared state manager and wraps it into a intermediate object that helps us handle local modifications.

Parameters:

id - property id

Returns:

property state

Throws:

NoSuchItemStateException

ItemStateException

getChanges

protected ChangeLog getChanges()

Returns the change log that contains the current changes in this local item state manager.

Returns:

the change log with the current changes.

getItemState

public ItemState getItemState(ItemId id)
                       throws NoSuchItemStateException,
                              ItemStateException

Return an item state, given its item id.

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(NodeId 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(NodeId 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.

edit

public void edit()
          throws IllegalStateException

Start an edit operation on items inside this manager. This allows calling the operations defined below. At the end of this operation, either UpdatableItemStateManager.update() or UpdatableItemStateManager.cancel() must be invoked.

Specified by:

edit in interface UpdatableItemStateManager

Throws:

IllegalStateException - if the manager is already in edit mode.

inEditMode

public boolean inEditMode()

Returns true if this manager is in edit mode i.e. if an edit operation has been started by invoking UpdatableItemStateManager.edit(), otherwise returns false.

Specified by:

inEditMode in interface UpdatableItemStateManager

Returns:

true if this manager is in edit mode, otherwise false

createNew

public NodeState createNew(NodeId id,
                           Name nodeTypeName,
                           NodeId parentId)
                    throws RepositoryException

Creates a NodeState instance representing new, i.e. not yet existing state. Call UpdatableItemStateManager.store(org.apache.jackrabbit.core.state.ItemState) on the returned object to make it persistent.

Specified by:

createNew in interface UpdatableItemStateManager

Parameters:

id - the id of the node, or null for a new node id

nodeTypeName - The node type name

parentId - parent node's id

Returns:

a node state

Throws:

RepositoryException - if the node state can not be created

getOrCreateLocalState

public NodeState getOrCreateLocalState(NodeState transientState)
                                throws RepositoryException

Returns the local node state below the given transient one. If given a fresh new node state, then a new local state is created and added to the change log.

Parameters:

transientState - transient state

Returns:

local node state

Throws:

RepositoryException - if the local state could not be created

createNew

public PropertyState createNew(Name propName,
                               NodeId parentId)
                        throws IllegalStateException

Creates a PropertyState instance representing new, i.e. not yet existing state. Call UpdatableItemStateManager.store(org.apache.jackrabbit.core.state.ItemState) on the returned object to make it persistent.

Specified by:

createNew in interface UpdatableItemStateManager

Parameters:

propName - property name

parentId - parent node Id

Returns:

a property state

Throws:

IllegalStateException - if the manager is not in edit mode.

store

public void store(ItemState state)
           throws IllegalStateException

Store an item state.

Specified by:

store in interface UpdatableItemStateManager

Parameters:

state - item state that should be stored

Throws:

IllegalStateException - if the manager is not in edit mode.

destroy

public void destroy(ItemState state)
             throws IllegalStateException

Destroy an item state.

Specified by:

destroy in interface UpdatableItemStateManager

Parameters:

state - item state that should be destroyed

Throws:

IllegalStateException - if the manager is not in edit mode.

cancel

public void cancel()
            throws IllegalStateException

Cancel an update operation. This will undo all changes made to objects inside this item state manager.

Specified by:

cancel in interface UpdatableItemStateManager

Throws:

IllegalStateException - if the manager is not in edit mode.

update

public void update()
            throws ReferentialIntegrityException,
                   StaleItemStateException,
                   ItemStateException,
                   IllegalStateException

End an update operation. This will save all items added to this update operation in a single step. If this operation fails, no item will have been saved.

Specified by:

update in interface UpdatableItemStateManager

Throws:

ReferentialIntegrityException - if a new or modified REFERENCE property refers to a non-existent target or if a removed node is still being referenced

StaleItemStateException - if at least one of the affected items has become stale in the meantime

ItemStateException - if the operation failed for another reason

IllegalStateException - if the manager is not in edit mode.

update

protected void update(ChangeLog changeLog)
               throws ReferentialIntegrityException,
                      StaleItemStateException,
                      ItemStateException

End an update operation. Fetch the states and references from the parent (shared) item manager, reconnect them to the items collected in our (local) change log and overwrite the shared items with our copies.

Parameters:

changeLog - change log containing local states and references

Throws:

ReferentialIntegrityException - if a new or modified REFERENCE property refers to a non-existent target or if a removed node is still being referenced

StaleItemStateException - if at least one of the affected item states has become stale in the meantime

ItemStateException - if an error occurs

dispose

public void dispose()

Disposes this UpdatableItemStateManager and frees resources.

Specified by:

dispose in interface UpdatableItemStateManager

addListener

public void addListener(ItemStateListener listener)

Add an ItemStateListener

Parameters:

listener - the new listener to be informed on modifications

removeListener

public void removeListener(ItemStateListener listener)

Remove an ItemStateListener

Parameters:

listener - an existing listener

stateCreated

public void stateCreated(ItemState created)

Called when an ItemState has successfully been created (i.e. its underlying persistent state was created).

Notification handler gets called for both local states that this state manager has created, as well as states that were created by the shared state manager we're listening to.

Specified by:

stateCreated in interface ItemStateListener

Parameters:

created - the ItemState that has been 'created'

stateModified

public void stateModified(ItemState modified)

Called when an ItemState has successfully been modified (i.e. its underlying persistent state has changed).

Notification handler gets called for both local states that this state manager has created, as well as states that were created by the shared state manager we're listening to.

Specified by:

stateModified in interface ItemStateListener

Parameters:

modified - the ItemState that has been 'modified'

stateDestroyed

public void stateDestroyed(ItemState destroyed)

Called when an ItemState has successfully been removed (i.e. its underlying persistent state has been destroyed).

Notification handler gets called for both local states that this state manager has created, as well as states that were created by the shared state manager we're listening to.

Specified by:

stateDestroyed in interface ItemStateListener

Parameters:

destroyed - the ItemState that has been 'destroyed'

stateDiscarded

public void stateDiscarded(ItemState discarded)

Called when an ItemState has been discarded (i.e. it has been rendered 'invalid').

Notification handler gets called for both local states that this state manager has created, as well as states that were created by the shared state manager we're listening to.

Specified by:

stateDiscarded in interface ItemStateListener

Parameters:

discarded - the ItemState that has been discarded

See Also:

ItemState.discard()

nodeAdded

public void nodeAdded(NodeState state,
                      Name name,
                      int index,
                      NodeId id)

Called when a child node has been added

Optimization: shared state manager we're listening to does not deliver node state changes, therefore the state concerned must be a local state.

Specified by:

nodeAdded in interface NodeStateListener

Parameters:

state - node state that changed

name - name of node that was added

index - index of new node

id - id of new node

nodesReplaced

public void nodesReplaced(NodeState state)

Called when the children nodes were replaced by other nodes, typically as result of a reorder operation.

Optimization: shared state manager we're listening to does not deliver node state changes, therefore the state concerned must be a local state.

Specified by:

nodesReplaced in interface NodeStateListener

Parameters:

state - node state that changed

nodeModified

public void nodeModified(NodeState state)

Called when a node has been modified, typically as a result of removal or addition of a child node.

Please note, that this method is not called if ItemStateListener.stateModified(ItemState) was called.

Optimization: shared state manager we're listening to does not deliver node state changes, therefore the state concerned must be a local state.

Specified by:

nodeModified in interface NodeStateListener

Parameters:

state - node state that changed

nodeRemoved

public void nodeRemoved(NodeState state,
                        Name name,
                        int index,
                        NodeId id)

Called when a child node has been removed

Optimization: shared state manager we're listening to does not deliver node state changes, therefore the state concerned must be a local state.

Specified by:

nodeRemoved in interface NodeStateListener

Parameters:

state - node state that changed

name - name of node that was removed

index - index of removed node

id - id of removed node

getNodeIdFactory

public NodeIdFactory getNodeIdFactory()