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 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.
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 org.apache.jackrabbit.oak.plugins.nodetype.ReadOnlyNodeTypeManager

getAllNodeTypes, getDefinition, getDefinition, getDefinition, getEffectiveNodeType, getEffectiveNodeType, getInstance, getMixinNodeTypes, getNodeType, getPrimaryNodeTypes, getRootDefinition, hasNodeType, isNodeType, isNodeType, isNodeType

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

ReadWriteNodeTypeManager

public ReadWriteNodeTypeManager()

Method Detail

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate()

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

Overrides:

createNodeTypeTemplate in class ReadOnlyNodeTypeManager

Returns:

A NodeTypeTemplate.

createNodeTypeTemplate

public NodeTypeTemplate createNodeTypeTemplate(NodeTypeDefinition ntd)
                                        throws ConstraintViolationException

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

Overrides:

createNodeTypeTemplate in class ReadOnlyNodeTypeManager

Parameters:

ntd - a NodeTypeDefinition.

Returns:

A NodeTypeTemplate.

Throws:

ConstraintViolationException

createNodeDefinitionTemplate

public NodeDefinitionTemplate createNodeDefinitionTemplate()

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

Overrides:

createNodeDefinitionTemplate in class ReadOnlyNodeTypeManager

Returns:

A NodeDefinitionTemplate.

createPropertyDefinitionTemplate

public PropertyDefinitionTemplate createPropertyDefinitionTemplate()

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

Overrides:

createPropertyDefinitionTemplate in class ReadOnlyNodeTypeManager

Returns:

A PropertyDefinitionTemplate.

registerNodeType

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

Description copied from class: ReadOnlyNodeTypeManager

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

registerNodeType in interface NodeTypeManager

Overrides:

registerNodeType in class ReadOnlyNodeTypeManager

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 final NodeTypeIterator registerNodeTypes(NodeTypeDefinition[] ntds,
                                                boolean allowUpdate)
                                         throws RepositoryException

Description copied from class: ReadOnlyNodeTypeManager

This implementation always throws a UnsupportedRepositoryOperationException.

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:

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

Description copied from class: ReadOnlyNodeTypeManager

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

unregisterNodeType in interface NodeTypeManager

Overrides:

unregisterNodeType in class ReadOnlyNodeTypeManager

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

Description copied from class: ReadOnlyNodeTypeManager

This implementation always throws a UnsupportedRepositoryOperationException.

Specified by:

unregisterNodeTypes in interface NodeTypeManager

Overrides:

unregisterNodeTypes in class ReadOnlyNodeTypeManager

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.