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

Class ReadWriteNodeTypeManager

java.lang.Object

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

org.apache.jackrabbit.oak.plugins.nodetype.write.ReadWriteNodeTypeManager

All Implemented Interfaces:

NodeTypeManager, DefinitionProvider, EffectiveNodeTypeProvider

public abstract class ReadWriteNodeTypeManager
extends ReadOnlyNodeTypeManager

ReadWriteNodeTypeManager extends the ReadOnlyNodeTypeManager with support for operations that modify node types.

• registerNodeType(NodeTypeDefinition, boolean)
• registerNodeTypes(NodeTypeDefinition[], boolean)
• unregisterNodeType(String)
• unregisterNodeTypes(String[])
• plus related template factory methods

Calling any of the above methods will result in a refresh() callback to e.g. inform an associated session that it should refresh to make the changes visible.

Subclass responsibility is to provide an implementation of ReadOnlyNodeTypeManager.getTypes() for read only access to the tree where node types are stored in content and getWriteRoot() for write access to the repository in order to modify node types stored in content. A subclass may also want to override the default implementation of ReadOnlyNodeTypeManager for the following methods:

• ReadOnlyNodeTypeManager.getValueFactory()
• ReadOnlyNodeTypeManager.getNamePathMapper()

Constructor Summary

Constructors

Constructor	Description
ReadWriteNodeTypeManager()

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 from the given definition, which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.
PropertyDefinitionTemplate	createPropertyDefinitionTemplate()	Returns an empty PropertyDefinitionTemplate which can then be used to create a property definition and attached to a NodeTypeTemplate.
protected @NotNull Root	getWriteRoot()	Called by the methods registerNodeType(NodeTypeDefinition, boolean), registerNodeTypes(NodeTypeDefinition[], boolean), unregisterNodeType(String) and unregisterNodeTypes(String[]) to acquire a fresh Root instance that can be used to persist the requested node type changes (and nothing else).
protected void	refresh()	Called by the ReadWriteNodeTypeManager implementation methods to refresh the state of the session associated with this instance.
NodeType	registerNodeType(NodeTypeDefinition ntd, boolean allowUpdate)	Registers a new node type or updates an existing node type using the specified definition and returns the resulting NodeType object.
NodeTypeIterator	registerNodeTypes(NodeTypeDefinition[] ntds, boolean allowUpdate)	Registers or updates the specified array of NodeTypeDefinition objects.
void	unregisterNodeType(String name)	Unregisters the specified node type.
void	unregisterNodeTypes(String[] names)	Unregisters the specified set of node types.

Methods inherited from class org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager

getAllNodeTypes, getDefinition, getDefinition, getDefinition, getEffectiveNodeType, getEffectiveNodeType, getInstance, getMixinNodeTypes, getNamePathMapper, getNodeType, getOakName, getPrimaryNodeTypes, getRootDefinition, getTypes, getValueFactory, hasNodeType, isNodeType, isNodeType, isNodeType

Methods inherited from class java.lang.Object

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

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

isNodeType, isNodeType

Constructor Detail

ReadWriteNodeTypeManager

public ReadWriteNodeTypeManager()

Method Detail

getWriteRoot

@NotNull
protected @NotNull Root getWriteRoot()

Called by the methods registerNodeType(NodeTypeDefinition, boolean), registerNodeTypes(NodeTypeDefinition[], boolean), unregisterNodeType(String) and unregisterNodeTypes(String[]) to acquire a fresh Root instance that can be used to persist the requested node type changes (and nothing else).

This default implementation throws an UnsupportedOperationException.

Returns:

fresh Root instance.

refresh

protected void refresh()
                throws RepositoryException

Called by the ReadWriteNodeTypeManager implementation methods to refresh the state of the session associated with this instance. That way the session is kept in sync with the latest global state seen by the node type manager.

Throws:

RepositoryException - if the session could not be refreshed

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate()

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

Overrides:

createNodeTypeTemplate in class ReadOnlyNodeTypeManager

Returns:

A new empty NodeTypeTemplate.

Since:

JCR 2.0

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate(NodeTypeDefinition ntd)
                                        throws ConstraintViolationException

Returns a NodeTypeTemplate from the given definition, which can then be used to define a node type and passed to NodeTypeManager.registerNodeType.

Specified by:

createNodeTypeTemplate in interface NodeTypeManager

Overrides:

createNodeTypeTemplate in class ReadOnlyNodeTypeManager

Returns:

A new NodeTypeTemplate.

Throws:

ConstraintViolationException

Since:

JCR 2.0

createNodeDefinitionTemplate

public NodeDefinitionTemplate createNodeDefinitionTemplate()

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

Overrides:

createNodeDefinitionTemplate in class ReadOnlyNodeTypeManager

Returns:

A new NodeDefinitionTemplate.

Since:

JCR 2.0

createPropertyDefinitionTemplate

public PropertyDefinitionTemplate createPropertyDefinitionTemplate()

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

Overrides:

createPropertyDefinitionTemplate in class ReadOnlyNodeTypeManager

Returns:

A new PropertyDefinitionTemplate.

Since:

JCR 2.0

registerNodeType

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

Registers a new node type or updates an existing node type using the specified definition and returns the resulting NodeType object.

Typically, the object passed to this method will be a NodeTypeTemplate (a subclass of NodeTypeDefinition) acquired from NodeTypeManager.createNodeTypeTemplate and then filled-in with definition information.

Specified by:

registerNodeType in interface NodeTypeManager

Overrides:

registerNodeType in class ReadOnlyNodeTypeManager

Parameters:

ntd - an NodeTypeDefinition.

allowUpdate - a boolean

Returns:

the registered node type

Throws:

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

RepositoryException - if another error occurs.

Since:

JCR 2.0

registerNodeTypes

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

Registers or updates the specified array of NodeTypeDefinition objects. This method is used to register or update a set of node types with mutual dependencies. Returns an iterator over the resulting NodeType objects.

The effect of the method is "all or nothing"; if an error occurs, no node types are registered or updated.

Specified by:

registerNodeTypes in interface NodeTypeManager

Overrides:

registerNodeTypes in class ReadOnlyNodeTypeManager

Parameters:

ntds - a collection of NodeTypeDefinitions

allowUpdate - a boolean

Returns:

the registered node types.

Throws:

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

RepositoryException - if another error occurs.

Since:

JCR 2.0

unregisterNodeType

public void unregisterNodeType(String name)
                        throws RepositoryException

Unregisters the specified node type.

Specified by:

unregisterNodeType in interface NodeTypeManager

Overrides:

unregisterNodeType in class ReadOnlyNodeTypeManager

Parameters:

name - a String.

Throws:

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

RepositoryException - if another error occurs.

Since:

JCR 2.0

unregisterNodeTypes

public void unregisterNodeTypes(String[] names)
                         throws RepositoryException

Unregisters the specified set of node types. Used to unregister a set of node types with mutual dependencies.

Specified by:

unregisterNodeTypes in interface NodeTypeManager

Overrides:

unregisterNodeTypes in class ReadOnlyNodeTypeManager

Parameters:

names - a String array

Throws:

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

RepositoryException - if another error occurs.

Since:

JCR 2.0