org.apache.jackrabbit.oak.jcr.session

Class NodeImpl<T extends NodeDelegate>

java.lang.Object

org.apache.jackrabbit.oak.jcr.session.NodeImpl<T>

Type Parameters:

T - the delegate type

All Implemented Interfaces:

Item, Node, JackrabbitNode

Direct Known Subclasses:

VersionHistoryImpl, VersionImpl

public class NodeImpl<T extends NodeDelegate>
extends Object
implements Node, JackrabbitNode

TODO document

Field Summary

Fields

Modifier and Type	Field and Description
protected T	dlg
static String	ITEM_SAVE_DOES_SESSION_SAVE
static int	MV_PROPERTY_WARN_THRESHOLD
static boolean	SAVE_SESSION The value of this flag determines the behaviour of save().
protected SessionContext	sessionContext
protected SessionDelegate	sessionDelegate

Fields inherited from interface javax.jcr.Node

JCR_CHILD_NODE_DEFINITION, JCR_CONTENT, JCR_FROZEN_NODE, JCR_PROPERTY_DEFINITION, JCR_ROOT_VERSION, JCR_VERSION_LABELS

Constructor Summary

Constructors

Constructor and Description
NodeImpl(T dlg, SessionContext sessionContext)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(ItemVisitor visitor)
void	addMixin(String mixinName)
Node	addNode(String relPath)
Node	addNode(String relPath, String primaryNodeTypeName)
boolean	canAddMixin(String mixinName)
void	cancelMerge(Version version)
Version	checkin()
void	checkout()
protected org.apache.jackrabbit.oak.api.PropertyState	createMultiState(String oakName, List<Value> values, org.apache.jackrabbit.oak.api.Type<?> type)
static NodeImpl<? extends NodeDelegate>	createNode(NodeDelegate delegate, SessionContext context)
static NodeImpl<? extends NodeDelegate>	createNodeOrNull(NodeDelegate delegate, SessionContext context)
protected org.apache.jackrabbit.oak.api.PropertyState	createSingleState(String oakName, Value value, org.apache.jackrabbit.oak.api.Type<?> type)
void	doneMerge(Version version)
void	followLifecycleTransition(String transition)
String[]	getAllowedLifecycleTransistions()
Item	getAncestor(int depth)
Version	getBaseVersion()
String	getCorrespondingNodePath(String workspaceName)
NodeDefinition	getDefinition()
int	getDepth()
String	getIdentifier()
int	getIndex()
Lock	getLock()
NodeType[]	getMixinNodeTypes()
String	getName()
Node	getNode(String relPath)
NodeIterator	getNodes()
NodeIterator	getNodes(String namePattern)
NodeIterator	getNodes(String[] nameGlobs)
Node	getParent()
String	getPath()
Item	getPrimaryItem()
NodeType	getPrimaryNodeType()
PropertyIterator	getProperties()
PropertyIterator	getProperties(String namePattern)
PropertyIterator	getProperties(String[] nameGlobs)
Property	getProperty(String relPath)
PropertyIterator	getReferences()
PropertyIterator	getReferences(String name)
Session	getSession()
NodeIterator	getSharedSet()
String	getUUID()
VersionHistory	getVersionHistory()
PropertyIterator	getWeakReferences()
PropertyIterator	getWeakReferences(String name)
boolean	hasNode(String relPath)
boolean	hasNodes()
boolean	hasProperties()
boolean	hasProperty(String relPath)
boolean	holdsLock()
boolean	isCheckedOut()
boolean	isLocked()
boolean	isModified()
boolean	isNew()
boolean	isNode()
boolean	isNodeType(String nodeTypeName)
boolean	isSame(Item otherItem)
Lock	lock(boolean isDeep, boolean isSessionScoped)
NodeIterator	merge(String srcWorkspace, boolean bestEffort)
void	orderBefore(String srcChildRelPath, String destChildRelPath)
protected <U> U	perform(SessionOperation<U> op) Perform the passed SessionOperation.
void	refresh(boolean keepChanges)
void	remove()
void	removeMixin(String mixinName)
void	removeShare()
void	removeSharedSet()
void	rename(String newName) Simplified implementation of JackrabbitNode.rename(String).
void	restore(String versionName, boolean removeExisting)
void	restore(Version version, boolean removeExisting)
void	restore(Version version, String relPath, boolean removeExisting)
void	restoreByLabel(String versionLabel, boolean removeExisting)
void	save() This implementation delegates to Session.save() if SAVE_SESSION is true.
void	setMixins(String[] mixinNames) Simplified implementation of the JackrabbitNode.setMixins(String[]) method that adds all mixin types that are not yet present on this node and removes all mixins that are no longer contained in the specified array.
void	setPrimaryType(String nodeTypeName)
Property	setProperty(String name, BigDecimal value)
Property	setProperty(String name, Binary value)
Property	setProperty(String name, boolean value)
Property	setProperty(String name, Calendar value)
Property	setProperty(String name, double value)
Property	setProperty(String name, InputStream value)
Property	setProperty(String name, long value)
Property	setProperty(String name, Node value)
Property	setProperty(String name, String value)
Property	setProperty(String name, String[] values)
Property	setProperty(String name, String[] values, int type)
Property	setProperty(String name, String value, int type)
Property	setProperty(String name, Value value)
Property	setProperty(String name, Value[] values)
Property	setProperty(String jcrName, Value[] values, int type)
Property	setProperty(String name, Value value, int type)
String	toString()
void	unlock()
void	update(String srcWorkspace)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jcr.Item

getAncestor, getDepth, getName, getPath, getSession, isSame, refresh, save

Field Detail

ITEM_SAVE_DOES_SESSION_SAVE

public static final String ITEM_SAVE_DOES_SESSION_SAVE

See Also:

Constant Field Values

MV_PROPERTY_WARN_THRESHOLD

public static final int MV_PROPERTY_WARN_THRESHOLD

See Also:

Constant Field Values

SAVE_SESSION

public static final boolean SAVE_SESSION

The value of this flag determines the behaviour of save(). If false, save will throw a UnsupportedRepositoryOperationException if the sub tree rooted at this item does not contain all transient changes. If true, save will delegate to Session.save().

sessionContext

protected final SessionContext sessionContext

dlg

protected final T extends ItemDelegate dlg

sessionDelegate

protected final SessionDelegate sessionDelegate

Constructor Detail

NodeImpl

public NodeImpl(T dlg,
        SessionContext sessionContext)

Method Detail

createNodeOrNull

@CheckForNull
public static NodeImpl<? extends NodeDelegate> createNodeOrNull(@CheckForNull
                                                             NodeDelegate delegate,
                                                             @Nonnull
                                                             SessionContext context)
                                                         throws RepositoryException

Throws:

RepositoryException

createNode

@Nonnull
public static NodeImpl<? extends NodeDelegate> createNode(@Nonnull
                                                  NodeDelegate delegate,
                                                  @Nonnull
                                                  SessionContext context)
                                                   throws RepositoryException

Throws:

RepositoryException

isNode

public boolean isNode()

Specified by:

isNode in interface Item

See Also:

Item.isNode()

getParent

@Nonnull
public Node getParent()
               throws RepositoryException

Specified by:

getParent in interface Item

Throws:

RepositoryException

See Also:

Item.getParent()

isNew

public boolean isNew()

Specified by:

isNew in interface Item

See Also:

Item.isNew()

isModified

public boolean isModified()

Specified by:

isModified in interface Item

See Also:

Item.isModified()

remove

public void remove()
            throws RepositoryException

Specified by:

remove in interface Item

Throws:

RepositoryException

See Also:

Item.remove()

accept

public void accept(ItemVisitor visitor)
            throws RepositoryException

Specified by:

accept in interface Item

Throws:

RepositoryException

addNode

@Nonnull
public Node addNode(String relPath)
             throws RepositoryException

Specified by:

addNode in interface Node

Throws:

RepositoryException

See Also:

Node.addNode(String)

addNode

@Nonnull
public Node addNode(String relPath,
                   String primaryNodeTypeName)
             throws RepositoryException

Specified by:

addNode in interface Node

Throws:

RepositoryException

orderBefore

public void orderBefore(String srcChildRelPath,
               String destChildRelPath)
                 throws RepositoryException

Specified by:

orderBefore in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Value value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Value value,
                           int type)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Value[] values)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String jcrName,
                           Value[] values,
                           int type)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           String[] values)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           String[] values,
                           int type)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           String value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           String value,
                           int type)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           InputStream value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Binary value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           boolean value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           double value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           BigDecimal value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           long value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Calendar value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

setProperty

@Nonnull
public Property setProperty(String name,
                           Node value)
                     throws RepositoryException

Specified by:

setProperty in interface Node

Throws:

RepositoryException

getNode

@Nonnull
public Node getNode(String relPath)
             throws RepositoryException

Specified by:

getNode in interface Node

Throws:

RepositoryException

getNodes

@Nonnull
public NodeIterator getNodes()
                      throws RepositoryException

Specified by:

getNodes in interface Node

Throws:

RepositoryException

getNodes

@Nonnull
public NodeIterator getNodes(String namePattern)
                      throws RepositoryException

Specified by:

getNodes in interface Node

Throws:

RepositoryException

getNodes

@Nonnull
public NodeIterator getNodes(String[] nameGlobs)
                      throws RepositoryException

Specified by:

getNodes in interface Node

Throws:

RepositoryException

getProperty

@Nonnull
public Property getProperty(String relPath)
                     throws RepositoryException

Specified by:

getProperty in interface Node

Throws:

RepositoryException

getProperties

@Nonnull
public PropertyIterator getProperties()
                               throws RepositoryException

Specified by:

getProperties in interface Node

Throws:

RepositoryException

getProperties

@Nonnull
public PropertyIterator getProperties(String namePattern)
                               throws RepositoryException

Specified by:

getProperties in interface Node

Throws:

RepositoryException

getProperties

@Nonnull
public PropertyIterator getProperties(String[] nameGlobs)
                               throws RepositoryException

Specified by:

getProperties in interface Node

Throws:

RepositoryException

getPrimaryItem

@Nonnull
public Item getPrimaryItem()
                    throws RepositoryException

Specified by:

getPrimaryItem in interface Node

Throws:

RepositoryException

See Also:

Node.getPrimaryItem()

getUUID

@Nonnull
public String getUUID()
               throws RepositoryException

Specified by:

getUUID in interface Node

Throws:

RepositoryException

See Also:

Node.getUUID()

getIdentifier

@Nonnull
public String getIdentifier()
                     throws RepositoryException

Specified by:

getIdentifier in interface Node

Throws:

RepositoryException

getIndex

public int getIndex()
             throws RepositoryException

Specified by:

getIndex in interface Node

Throws:

RepositoryException

getReferences

@Nonnull
public PropertyIterator getReferences()
                               throws RepositoryException

Specified by:

getReferences in interface Node

Throws:

RepositoryException

See Also:

Node.getReferences()

getReferences

@Nonnull
public PropertyIterator getReferences(String name)
                               throws RepositoryException

Specified by:

getReferences in interface Node

Throws:

RepositoryException

getWeakReferences

@Nonnull
public PropertyIterator getWeakReferences()
                                   throws RepositoryException

Specified by:

getWeakReferences in interface Node

Throws:

RepositoryException

See Also:

Node.getWeakReferences()

getWeakReferences

@Nonnull
public PropertyIterator getWeakReferences(String name)
                                   throws RepositoryException

Specified by:

getWeakReferences in interface Node

Throws:

RepositoryException

hasNode

public boolean hasNode(String relPath)
                throws RepositoryException

Specified by:

hasNode in interface Node

Throws:

RepositoryException

hasProperty

public boolean hasProperty(String relPath)
                    throws RepositoryException

Specified by:

hasProperty in interface Node

Throws:

RepositoryException

hasNodes

public boolean hasNodes()
                 throws RepositoryException

Specified by:

hasNodes in interface Node

Throws:

RepositoryException

hasProperties

public boolean hasProperties()
                      throws RepositoryException

Specified by:

hasProperties in interface Node

Throws:

RepositoryException

getPrimaryNodeType

@Nonnull
public NodeType getPrimaryNodeType()
                            throws RepositoryException

Specified by:

getPrimaryNodeType in interface Node

Throws:

RepositoryException

See Also:

Node.getPrimaryNodeType()

getMixinNodeTypes

@Nonnull
public NodeType[] getMixinNodeTypes()
                             throws RepositoryException

Specified by:

getMixinNodeTypes in interface Node

Throws:

RepositoryException

See Also:

Node.getMixinNodeTypes()

isNodeType

public boolean isNodeType(String nodeTypeName)
                   throws RepositoryException

Specified by:

isNodeType in interface Node

Throws:

RepositoryException

setPrimaryType

public void setPrimaryType(String nodeTypeName)
                    throws RepositoryException

Specified by:

setPrimaryType in interface Node

Throws:

RepositoryException

addMixin

public void addMixin(String mixinName)
              throws RepositoryException

Specified by:

addMixin in interface Node

Throws:

RepositoryException

removeMixin

public void removeMixin(String mixinName)
                 throws RepositoryException

Specified by:

removeMixin in interface Node

Throws:

RepositoryException

canAddMixin

public boolean canAddMixin(String mixinName)
                    throws RepositoryException

Specified by:

canAddMixin in interface Node

Throws:

RepositoryException

getDefinition

@Nonnull
public NodeDefinition getDefinition()
                             throws RepositoryException

Specified by:

getDefinition in interface Node

Throws:

RepositoryException

getCorrespondingNodePath

@Nonnull
public String getCorrespondingNodePath(String workspaceName)
                                throws RepositoryException

Specified by:

getCorrespondingNodePath in interface Node

Throws:

RepositoryException

update

public void update(String srcWorkspace)
            throws RepositoryException

Specified by:

update in interface Node

Throws:

RepositoryException

checkin

@Nonnull
public Version checkin()
                throws RepositoryException

Specified by:

checkin in interface Node

Throws:

RepositoryException

See Also:

Node.checkin()

checkout

public void checkout()
              throws RepositoryException

Specified by:

checkout in interface Node

Throws:

RepositoryException

See Also:

Node.checkout()

doneMerge

public void doneMerge(Version version)
               throws RepositoryException

Specified by:

doneMerge in interface Node

Throws:

RepositoryException

See Also:

Node.doneMerge(javax.jcr.version.Version)

cancelMerge

public void cancelMerge(Version version)
                 throws RepositoryException

Specified by:

cancelMerge in interface Node

Throws:

RepositoryException

See Also:

Node.cancelMerge(javax.jcr.version.Version)

merge

@Nonnull
public NodeIterator merge(String srcWorkspace,
                         boolean bestEffort)
                   throws RepositoryException

Specified by:

merge in interface Node

Throws:

RepositoryException

See Also:

Node.merge(String, boolean)

isCheckedOut

public boolean isCheckedOut()
                     throws RepositoryException

Specified by:

isCheckedOut in interface Node

Throws:

RepositoryException

See Also:

Node.isCheckedOut()

restore

public void restore(String versionName,
           boolean removeExisting)
             throws RepositoryException

Specified by:

restore in interface Node

Throws:

RepositoryException

See Also:

Node.restore(String, boolean)

restore

public void restore(Version version,
           boolean removeExisting)
             throws RepositoryException

Specified by:

restore in interface Node

Throws:

RepositoryException

See Also:

Node.restore(javax.jcr.version.Version, boolean)

restore

public void restore(Version version,
           String relPath,
           boolean removeExisting)
             throws RepositoryException

Specified by:

restore in interface Node

Throws:

RepositoryException

See Also:

Node.restore(Version, String, boolean)

restoreByLabel

public void restoreByLabel(String versionLabel,
                  boolean removeExisting)
                    throws RepositoryException

Specified by:

restoreByLabel in interface Node

Throws:

RepositoryException

See Also:

Node.restoreByLabel(String, boolean)

getVersionHistory

@Nonnull
public VersionHistory getVersionHistory()
                                 throws RepositoryException

Specified by:

getVersionHistory in interface Node

Throws:

RepositoryException

See Also:

Node.getVersionHistory()

getBaseVersion

@Nonnull
public Version getBaseVersion()
                       throws RepositoryException

Specified by:

getBaseVersion in interface Node

Throws:

RepositoryException

See Also:

Node.getBaseVersion()

isLocked

public boolean isLocked()
                 throws RepositoryException

Specified by:

isLocked in interface Node

Throws:

RepositoryException

holdsLock

public boolean holdsLock()
                  throws RepositoryException

Specified by:

holdsLock in interface Node

Throws:

RepositoryException

getLock

@Nonnull
public Lock getLock()
             throws RepositoryException

Specified by:

getLock in interface Node

Throws:

RepositoryException

lock

@Nonnull
public Lock lock(boolean isDeep,
                boolean isSessionScoped)
          throws RepositoryException

Specified by:

lock in interface Node

Throws:

RepositoryException

unlock

public void unlock()
            throws RepositoryException

Specified by:

unlock in interface Node

Throws:

RepositoryException

getSharedSet

@Nonnull
public NodeIterator getSharedSet()

Specified by:

getSharedSet in interface Node

removeSharedSet

public void removeSharedSet()
                     throws RepositoryException

Specified by:

removeSharedSet in interface Node

Throws:

RepositoryException

removeShare

public void removeShare()
                 throws RepositoryException

Specified by:

removeShare in interface Node

Throws:

RepositoryException

followLifecycleTransition

public void followLifecycleTransition(String transition)
                               throws RepositoryException

Specified by:

followLifecycleTransition in interface Node

Throws:

RepositoryException

See Also:

Node.followLifecycleTransition(String)

getAllowedLifecycleTransistions

@Nonnull
public String[] getAllowedLifecycleTransistions()
                                         throws RepositoryException

Specified by:

getAllowedLifecycleTransistions in interface Node

Throws:

RepositoryException

See Also:

Node.getAllowedLifecycleTransistions()

rename

public void rename(String newName)
            throws RepositoryException

Simplified implementation of JackrabbitNode.rename(String). In contrast to the implementation in Jackrabbit 2.x which was operating on the NodeState level directly, this implementation does a move plus subsequent reorder on the JCR API due to a missing support for renaming on the OAK API. Note, that this also has an impact on how permissions are enforced: In Jackrabbit 2.x the rename just required permission to modify the child collection on the parent, whereas a move did the full permission check. With this simplified implementation that (somewhat inconsistent) difference has been removed.

Specified by:

rename in interface JackrabbitNode

Parameters:

newName - The new name of this node.

Throws:

RepositoryException - If an error occurs.

setMixins

public void setMixins(String[] mixinNames)
               throws RepositoryException

Simplified implementation of the JackrabbitNode.setMixins(String[]) method that adds all mixin types that are not yet present on this node and removes all mixins that are no longer contained in the specified array. Note, that this implementation will not work exactly like the variant in Jackrabbit 2.x which first created the effective node type and adjusted the set of child items accordingly.

Specified by:

setMixins in interface JackrabbitNode

Parameters:

mixinNames -

Throws:

RepositoryException

perform

@Nonnull
protected final <U> U perform(@Nonnull
                    SessionOperation<U> op)
                   throws RepositoryException

Perform the passed SessionOperation.

Type Parameters:

U - return type of the operation

Parameters:

op - operation to perform

Returns:

the result of op.perform()

Throws:

RepositoryException - as thrown by op.perform().

getName

@Nonnull
public String getName()
               throws RepositoryException

Specified by:

getName in interface Item

Throws:

RepositoryException

See Also:

Item.getName()

getPath

@Nonnull
public String getPath()
               throws RepositoryException

Specified by:

getPath in interface Item

Throws:

RepositoryException

See Also:

Item.getPath()

getSession

@Nonnull
public Session getSession()

Specified by:

getSession in interface Item

getAncestor

public Item getAncestor(int depth)
                 throws RepositoryException

Specified by:

getAncestor in interface Item

Throws:

RepositoryException

getDepth

public int getDepth()
             throws RepositoryException

Specified by:

getDepth in interface Item

Throws:

RepositoryException

isSame

public boolean isSame(Item otherItem)
               throws RepositoryException

Specified by:

isSame in interface Item

Throws:

RepositoryException

See Also:

Item.isSame(javax.jcr.Item)

save

public void save()
          throws RepositoryException

This implementation delegates to Session.save() if SAVE_SESSION is true. Otherwise it only performs the save if the subtree rooted at this item contains all transient changes. That is, if calling Session.save() would have the same effect as calling this method. In all other cases this method will throw an UnsupportedRepositoryOperationException

Specified by:

save in interface Item

Throws:

RepositoryException

See Also:

Item.save()

refresh

public void refresh(boolean keepChanges)
             throws RepositoryException

Specified by:

refresh in interface Item

Throws:

RepositoryException

See Also:

Item.refresh(boolean)

toString

public String toString()

Overrides:

toString in class Object

createSingleState

@Nonnull
protected org.apache.jackrabbit.oak.api.PropertyState createSingleState(String oakName,
                                                                    Value value,
                                                                    org.apache.jackrabbit.oak.api.Type<?> type)
                                                                 throws RepositoryException

Throws:

RepositoryException

createMultiState

@Nonnull
protected org.apache.jackrabbit.oak.api.PropertyState createMultiState(String oakName,
                                                                   List<Value> values,
                                                                   org.apache.jackrabbit.oak.api.Type<?> type)
                                                                throws RepositoryException

Throws:

RepositoryException