Package org.apache.jackrabbit.oak.plugins.nodetype

Class ReadOnlyNodeTypeManager

java.lang.Object

org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager

All Implemented Interfaces:

NodeTypeManager, DefinitionProvider, EffectiveNodeTypeProvider

Direct Known Subclasses:

ReadWriteNodeTypeManager

public abstract class ReadOnlyNodeTypeManager
extends java.lang.Object
implements NodeTypeManager, EffectiveNodeTypeProvider, DefinitionProvider

Base implementation of a NodeTypeManager with support for reading node types from the Tree returned by getTypes(). Methods related to node type modifications throw UnsupportedRepositoryOperationException.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyNodeTypeManager()

Method Summary

Modifier and Type	Method	Description
NodeDefinitionTemplate	createNodeDefinitionTemplate()	Returns an empty NodeDefinitionTemplate which can then be used to create a child node definition and attached to a NodeTypeTemplate.
NodeTypeTemplate	createNodeTypeTemplate()	Returns an empty NodeTypeTemplate which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.
NodeTypeTemplate	createNodeTypeTemplate(NodeTypeDefinition ntd)	Returns a NodeTypeTemplate holding the specified node type definition.
PropertyDefinitionTemplate	createPropertyDefinitionTemplate()	Returns an empty PropertyDefinitionTemplate which can then be used to create a property definition and attached to a NodeTypeTemplate.
NodeTypeIterator	getAllNodeTypes()	Returns an iterator over all available node types (primary and mixin).
@NotNull NodeDefinition	getDefinition(@NotNull Tree parent, @NotNull java.lang.String nodeName)	Returns the node definition for a child node of parent named nodeName with a default primary type.
@NotNull PropertyDefinition	getDefinition(@NotNull Tree parent, @NotNull PropertyState property, boolean exactTypeMatch)	Calculates the applicable definition for the property state under the given parent tree.
@NotNull NodeDefinition	getDefinition(@NotNull Tree parent, @NotNull Tree targetNode)	Calculates the applicable definition for the child node under the given parent node.
@NotNull EffectiveNodeType	getEffectiveNodeType(@NotNull Node node)	Returns all the node types of the given node, in a breadth-first traversal order of the type hierarchy.
@NotNull EffectiveNodeType	getEffectiveNodeType(@NotNull Tree tree)	Calculates and returns the effective node types of the given tree.
static @NotNull ReadOnlyNodeTypeManager	getInstance(Root root, NamePathMapper namePathMapper)	Return a new instance of ReadOnlyNodeTypeManager that reads node type information from the tree at NodeTypeConstants.NODE_TYPES_PATH.
NodeTypeIterator	getMixinNodeTypes()	Returns an iterator over all available mixin node types.
NodeType	getNodeType(java.lang.String name)	Returns the named node type.
NodeTypeIterator	getPrimaryNodeTypes()	Returns an iterator over all available primary node types.
@NotNull NodeDefinition	getRootDefinition()
boolean	hasNodeType(java.lang.String name)	Returns true if a node type with the specified name is registered.
boolean	isNodeType(@NotNull java.lang.String typeName, @NotNull java.lang.String superName)	Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof.
boolean	isNodeType(@NotNull Tree tree, @NotNull java.lang.String oakNtName)	Returns true if this tree is of the specified primary node type or mixin type, or a subtype thereof respecting the effective node type of the tree.
boolean	isNodeType(@Nullable java.lang.String primaryTypeName, @NotNull java.lang.Iterable<java.lang.String> mixinTypes, @NotNull java.lang.String nodeTypeName)	Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof.
NodeType	registerNodeType(NodeTypeDefinition ntd, boolean allowUpdate)	This implementation always throws a UnsupportedRepositoryOperationException.
NodeTypeIterator	registerNodeTypes(NodeTypeDefinition[] ntds, boolean allowUpdate)	This implementation always throws a UnsupportedRepositoryOperationException.
void	unregisterNodeType(java.lang.String name)	This implementation always throws a UnsupportedRepositoryOperationException.
void	unregisterNodeTypes(java.lang.String[] names)	This implementation always throws a UnsupportedRepositoryOperationException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.spi.nodetype.EffectiveNodeTypeProvider

isNodeType

Constructor Detail

ReadOnlyNodeTypeManager

public ReadOnlyNodeTypeManager()

Method Detail

getInstance

@NotNull
public static @NotNull ReadOnlyNodeTypeManager getInstance(Root root,
                                                           NamePathMapper namePathMapper)

Return a new instance of ReadOnlyNodeTypeManager that reads node type information from the tree at NodeTypeConstants.NODE_TYPES_PATH.

Parameters:

root - The root to read node types from.

namePathMapper - The NamePathMapper to use.

Returns:

a new instance of ReadOnlyNodeTypeManager.

hasNodeType

public boolean hasNodeType(java.lang.String name)
                    throws RepositoryException

Description copied from interface: NodeTypeManager

Returns true if a node type with the specified name is registered. Returns false otherwise.

Specified by:

hasNodeType in interface NodeTypeManager

Parameters:

name - a String.

Returns:

a boolean

Throws:

RepositoryException - if an error occurs.

getNodeType

public NodeType getNodeType(java.lang.String name)
                     throws RepositoryException

Description copied from interface: NodeTypeManager

Returns the named node type.

Specified by:

getNodeType in interface NodeTypeManager

Parameters:

name - the name of an existing node type.

Returns:

A NodeType object.

Throws:

NoSuchNodeTypeException - if no node type by the given name exists.

RepositoryException - if another error occurs.

getAllNodeTypes

public NodeTypeIterator getAllNodeTypes()
                                 throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an iterator over all available node types (primary and mixin).

Specified by:

getAllNodeTypes in interface NodeTypeManager

Returns:

An NodeTypeIterator.

Throws:

RepositoryException - if an error occurs.

getPrimaryNodeTypes

public NodeTypeIterator getPrimaryNodeTypes()
                                     throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an iterator over all available primary node types.

Specified by:

getPrimaryNodeTypes in interface NodeTypeManager

Returns:

An NodeTypeIterator.

Throws:

RepositoryException - if an error occurs.

getMixinNodeTypes

public NodeTypeIterator getMixinNodeTypes()
                                   throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an iterator over all available mixin node types. If none are available, an empty iterator is returned.

Specified by:

getMixinNodeTypes in interface NodeTypeManager

Returns:

An NodeTypeIterator.

Throws:

RepositoryException - if an error occurs.

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate()
                                        throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty NodeTypeTemplate which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.

Specified by:

createNodeTypeTemplate in interface NodeTypeManager

Returns:

A NodeTypeTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate(NodeTypeDefinition ntd)
                                        throws RepositoryException

Description copied from interface: NodeTypeManager

Returns a NodeTypeTemplate holding the specified node type definition. This template can then be altered and passed to NodeTypeManager.registerNodeType.

Specified by:

createNodeTypeTemplate in interface NodeTypeManager

Parameters:

ntd - a NodeTypeDefinition.

Returns:

A NodeTypeTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

createNodeDefinitionTemplate

public NodeDefinitionTemplate createNodeDefinitionTemplate()
                                                    throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty NodeDefinitionTemplate which can then be used to create a child node definition and attached to a NodeTypeTemplate.

Specified by:

createNodeDefinitionTemplate in interface NodeTypeManager

Returns:

A NodeDefinitionTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

createPropertyDefinitionTemplate

public PropertyDefinitionTemplate createPropertyDefinitionTemplate()
                                                            throws RepositoryException

Description copied from interface: NodeTypeManager

Returns an empty PropertyDefinitionTemplate which can then be used to create a property definition and attached to a NodeTypeTemplate.

Specified by:

createPropertyDefinitionTemplate in interface NodeTypeManager

Returns:

A PropertyDefinitionTemplate.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

registerNodeType

public NodeType registerNodeType(NodeTypeDefinition ntd,
                                 boolean allowUpdate)
                          throws RepositoryException

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

registerNodeType in interface NodeTypeManager

Parameters:

ntd - an NodeTypeDefinition.

allowUpdate - a boolean

Returns:

the registered node type

Throws:

InvalidNodeTypeDefinitionException - if the NodeTypeDefinition is invalid.

NodeTypeExistsException - if allowUpdate is false and the NodeTypeDefinition specifies a node type name that is already registered.

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

registerNodeTypes

public NodeTypeIterator registerNodeTypes(NodeTypeDefinition[] ntds,
                                          boolean allowUpdate)
                                   throws RepositoryException

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

registerNodeTypes in interface NodeTypeManager

Parameters:

ntds - a collection of NodeTypeDefinitions

allowUpdate - a boolean

Returns:

the registered node types.

Throws:

InvalidNodeTypeDefinitionException - if a NodeTypeDefinition within the Collection is invalid or if the Collection contains an object of a type other than NodeTypeDefinition.

NodeTypeExistsException - if allowUpdate is false and a NodeTypeDefinition within the Collection specifies a node type name that is already registered.

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

RepositoryException - if another error occurs.

unregisterNodeType

public void unregisterNodeType(java.lang.String name)
                        throws RepositoryException

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

unregisterNodeType in interface NodeTypeManager

Parameters:

name - a String.

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

NoSuchNodeTypeException - if no registered node type exists with the specified name.

RepositoryException - if another error occurs.

unregisterNodeTypes

public void unregisterNodeTypes(java.lang.String[] names)
                         throws RepositoryException

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

unregisterNodeTypes in interface NodeTypeManager

Parameters:

names - a String array

Throws:

UnsupportedRepositoryOperationException - if this implementation does not support node type registration.

NoSuchNodeTypeException - if one of the names listed is not a registered node type.

RepositoryException - if another error occurs.

isNodeType

public boolean isNodeType(@NotNull
                          @NotNull Tree tree,
                          @NotNull
                          @NotNull java.lang.String oakNtName)

Description copied from interface: EffectiveNodeTypeProvider

Returns true if this tree is of the specified primary node type or mixin type, or a subtype thereof respecting the effective node type of the tree. Returns false otherwise. Note: caution must be taken while calling this api because it doesn't offer the same strict guarantees as the Node#isNodeType(String) method in the case where the session doesn't have access to the jcr:mixinTypes property.

Specified by:

isNodeType in interface EffectiveNodeTypeProvider

Parameters:

tree - The tree to be tested.

oakNtName - The internal oak name of the node type to be tested.

Returns:

true if the specified node is of the given node type.

isNodeType

public boolean isNodeType(@Nullable
                          @Nullable java.lang.String primaryTypeName,
                          @NotNull
                          @NotNull java.lang.Iterable<java.lang.String> mixinTypes,
                          @NotNull
                          @NotNull java.lang.String nodeTypeName)

Description copied from interface: EffectiveNodeTypeProvider

Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof. Returns false otherwise.

Specified by:

isNodeType in interface EffectiveNodeTypeProvider

Parameters:

primaryTypeName - the internal oak name of the node to test

mixinTypes - the internal oak names of the node to test.

nodeTypeName - The internal oak name of the node type to be tested.

Returns:

true if the specified node type is of the given node type.

isNodeType

public boolean isNodeType(@NotNull
                          @NotNull java.lang.String typeName,
                          @NotNull
                          @NotNull java.lang.String superName)

Description copied from interface: EffectiveNodeTypeProvider

Returns true if typeName is of the specified primary node type or mixin type, or a subtype thereof. Returns false otherwise.

Specified by:

isNodeType in interface EffectiveNodeTypeProvider

Parameters:

typeName - the internal oak name of the node type to test

superName - The internal oak name of the super type to be tested for.

Returns:

true if the specified node type is of the given node type.

getEffectiveNodeType

@NotNull
public @NotNull EffectiveNodeType getEffectiveNodeType(@NotNull
                                                       @NotNull Node node)
                                                throws RepositoryException

Returns all the node types of the given node, in a breadth-first traversal order of the type hierarchy.

Specified by:

getEffectiveNodeType in interface EffectiveNodeTypeProvider

Parameters:

node - node instance

Returns:

all types of the given node

Throws:

RepositoryException - if the type information can not be accessed

See Also:

JCR 2.0 Specification, Section 3.7.6.5

getEffectiveNodeType

@NotNull
public @NotNull EffectiveNodeType getEffectiveNodeType(@NotNull
                                                       @NotNull Tree tree)
                                                throws RepositoryException

Description copied from interface: EffectiveNodeTypeProvider

Calculates and returns the effective node types of the given tree. Also see JCR 2.0 Specification, Section 3.7.6.5 for the definition of the effective node type.

Specified by:

getEffectiveNodeType in interface EffectiveNodeTypeProvider

Parameters:

tree - the tree

Returns:

all node types of the given tree

Throws:

RepositoryException - if the type information can not be accessed,

See Also:

JCR 2.0 Specification, Section 3.7.6.5

getRootDefinition

@NotNull
public @NotNull NodeDefinition getRootDefinition()
                                          throws RepositoryException

Specified by:

getRootDefinition in interface DefinitionProvider

Throws:

RepositoryException

getDefinition

@NotNull
public @NotNull NodeDefinition getDefinition(@NotNull
                                             @NotNull Tree parent,
                                             @NotNull
                                             @NotNull java.lang.String nodeName)
                                      throws RepositoryException

Description copied from interface: DefinitionProvider

Returns the node definition for a child node of parent named nodeName with a default primary type. First the non-residual child node definitions of parent are checked matching the given node name. Then the residual definitions are checked.

Specified by:

getDefinition in interface DefinitionProvider

Parameters:

parent - the parent node.

nodeName - The internal oak name of the child node.

Returns:

the applicable node definition.

Throws:

ConstraintViolationException - If no matching definition can be found.

RepositoryException - If another error occurs.

getDefinition

@NotNull
public @NotNull NodeDefinition getDefinition(@NotNull
                                             @NotNull Tree parent,
                                             @NotNull
                                             @NotNull Tree targetNode)
                                      throws RepositoryException

Description copied from interface: DefinitionProvider

Calculates the applicable definition for the child node under the given parent node.

Specified by:

getDefinition in interface DefinitionProvider

Parameters:

parent - The parent node.

targetNode - The child node for which the definition is calculated.

Returns:

the definition of the target node.

Throws:

ConstraintViolationException - If no matching definition can be found.

RepositoryException - If another error occurs.

getDefinition

@NotNull
public @NotNull PropertyDefinition getDefinition(@NotNull
                                                 @NotNull Tree parent,
                                                 @NotNull
                                                 @NotNull PropertyState property,
                                                 boolean exactTypeMatch)
                                          throws RepositoryException

Description copied from interface: DefinitionProvider

Calculates the applicable definition for the property state under the given parent tree.

Specified by:

getDefinition in interface DefinitionProvider

Parameters:

parent - The parent tree.

property - The target property.

Returns:

the definition for the target property.

Throws:

ConstraintViolationException - If no matching definition can be found.

RepositoryException - If another error occurs.