Node types

Magnolia stores data in a Java Content Repository. The repository is a hierarchical object database that is particularly well-suited for storing content. In a content management system you need to be able to store text, documents, images and other binary objects along with their metadata. The data is structured as a tree of nodes. Each node can have one or more types. The type defines what kind of properties the node has, the number and type of its child nodes, and its behavior. See Jackrabbit Node Types for more information and Node Type Visualization for a diagram of the node type hierarchy.

In Magnolia we define custom node types that define Magnolia's custom content model. The JCR in turn enforces the constraints of that model at the repository level. If you need to reference JCR node types in your code, Jackrabbit's JcrConstants is useful. We provide constants also for Magnolia's custom node types but also convenience methods. For example, to update the last modification date of a node, use the NodeTypes.LastModified.update(node) convenience method. Magnolia node types are registered by the  NodeTypes Java class.

Prefixes

Node type hierarchy

In this simplified node type hierarchy diagram you can see what extends what. For example, mgnl:page extends mgnl:versionable. This means that page is an object you can version. In contrast, mgnl:area and mgnl:component are not versionable – they are subnodes that must be activated together with the parent page. However, all three node types (page, area, component) are renderable which means you can render a component on its own without its parent page. See the magnolia-nodetypes.cnd  file for a full view of the Magnolia node type hierarchy.

Primary node types

Every node has a primary node type assigned to it upon creation. The primary node type defines node structure such as allowed and required child nodes and properties. Primary types reflect the business that is represented in the repository. Magnolia's primary node types define content management nodes such as pages, areas, components and resources.

JCR primary node types

Magnolia primary node types

The primary Magnolia node types are defined in:

<'mgnl'='http://www.magnolia.info/jcr/mgnl'>
<'mix'='http://www.jcp.org/jcr/mix/1.0'>
<'nt'='http://www.jcp.org/jcr/nt/1.0'>

[mgnl:metaData] > mix:referenceable, nt:hierarchyNode
  orderable
  - * (undefined) nofulltext noqueryorder

[mgnl:lastModified]
  mixin
  - mgnl:lastModifiedBy (string) nofulltext noqueryorder
  - mgnl:lastModified (date) nofulltext noqueryorder

[mgnl:activatable] > mix:lockable
  mixin
  - mgnl:activationStatus (string) nofulltext noqueryorder
  - mgnl:lastActivatedBy (string) nofulltext noqueryorder
  - mgnl:lastActivatedVersionCreated (date) nofulltext noqueryorder
  - mgnl:lastActivated (date) nofulltext noqueryorder
  - mgnl:lastActivatedVersion (string) nofulltext noqueryorder

[mgnl:renderable]
  mixin
  - mgnl:template (string) nofulltext noqueryorder

[mgnl:created]
  mixin
  - mgnl:createdBy (string) nofulltext noqueryorder
  - mgnl:created (date) nofulltext noqueryorder

[mgnl:versionable] > mix:lockable
  mixin
  - mgnl:comment (string) nofulltext noqueryorder

[mgnl:deleted] > mgnl:versionable
  mixin
  - mgnl:deleted (date) nofulltext noqueryorder
  - mgnl:deletedBy (string) nofulltext noqueryorder

[mgnl:content] > mgnl:activatable, mgnl:created, mgnl:lastModified, mgnl:renderable, mgnl:versionable, mix:referenceable, nt:hierarchyNode
  orderable
  - * (undefined) multiple nofulltext noqueryorder
  - * (undefined) nofulltext noqueryorder
  + * (nt:base)

[mgnl:contentNode] > mgnl:activatable, mgnl:created, mgnl:lastModified, mgnl:renderable, mix:referenceable, nt:hierarchyNode
  orderable
  - * (undefined) multiple nofulltext noqueryorder
  - * (undefined) nofulltext noqueryorder
  + * (nt:base)

[mgnl:folder] > mgnl:activatable, mgnl:created, mgnl:lastModified, mix:referenceable, nt:folder
  orderable
  - * (undefined) nofulltext noqueryorder
  - * (undefined) multiple nofulltext noqueryorder
  + * (nt:base)

[mgnl:resource] > mgnl:activatable, mgnl:created, mgnl:lastModified, nt:resource
  - * (undefined) nofulltext noqueryorder

[mgnl:reserve] > nt:hierarchyNode
  orderable
  - * (undefined) nofulltext noqueryorder
  + * (nt:base)

[mgnl:page] > mgnl:content
  orderable

[mgnl:area] > mgnl:contentNode
  orderable

[mgnl:component] > mgnl:contentNode
  orderable

[mgnl:user] > mgnl:content
  orderable

[mgnl:role] > mgnl:content
  orderable

[mgnl:group] > mgnl:content
  orderable

[mgnl:hasVersion]
  mixin

Mixin node types

Mixin node types specify additional properties or characteristics to the node. A node can have a primary type and several mixin types at the same time. JCR mixins add repository-level functionality such as versioning and locking. Magnolia mixins add content management capabilities such as activating and rendering.

JCR mixin node types

Magnolia mixin node types

Same name siblings are not allowed

The Magnolia node type definition magnolia-nodetypes.cnd  does not allow same name siblings. This means that you cannot have two nodes at the same level in the node hierarchy with the same name. Typically same name siblings is not an issue because Magnolia enforces the constraint automatically during normal usage. However, if prior to Magnolia 5.2 you imported an XML file that was created outside of Magnolia or was edited by hand, it is possible that the XML import created a same name sibling.

Use the siblings.groovy script to find same name siblings in your repository. The example below searches for identically named areas (returnItemType is mgnl:area) in the website workspace under the /travel/about page. See Groovy module for instructions on how to execute Groovy scripts.

import info.magnolia.cms.util.QueryUtil;
import info.magnolia.cms.core.search.Query;
import info.magnolia.cms.core.Path;
import info.magnolia.jcr.util.NodeUtil;
import info.magnolia.context.MgnlContext;
import javax.jcr.Session;
import javax.jcr.Node;
import javax.jcr.NodeIterator;
import org.apache.commons.lang.StringUtils;
import java.util.LinkedList;
def siblings(workspace,path,returnItemType) {
    query = "/jcr:root" + path + "//* order by @name";  //i.e. path=/travel/about
    try {
        NodeIterator nodes = QueryUtil.search(workspace,query,Query.XPATH,returnItemType);
        
        Session session = MgnlContext.getJCRSession(workspace);
        def siblings = []; 
        while (nodes.hasNext()) {
            Node node = nodes.nextNode();
            nodePath = node.getPath();
            if (StringUtils.contains(nodePath,"[")) {
              println "found same name sibling of '${node.getName()}' at ${nodePath}";
              siblings.add(node);
            }
        }
        siblings.each {
            nodePath = node.getPath();
            newName = Path.getUniqueLabel(session,nodePath,node.getName());
            NodeUtil.renameNode(node,newName);
            println "${nodePath} was renamed to ${newName}";
        }
        session.save();
    } catch (Exception e) {
        println e;
    }
}
//example
siblings("website", "/travel/about", "mgnl:area");

Options from the expandable Groovy script above:

• workspace: Any Magnolia workspace.
• path: A valid path in the workspace. / will search for everything under the workspace root.
• returnItemType: A valid JCR node type. The query goes through all node types but the results are filtered to the node type you specify. Use nt:base as a "wildcard". 

Module-specific node types

The following sections list node types that are provided by individual Magnolia modules. You can define several node types per module if you so require. Almost all the node types added inherit from mgnl:contentNode or mgnl:content.

Categorization module

Defined in  magnolia-category-nodetypes.xml .

Content Editor module

Defined in  content-editor-nodetypes.xml .

Content Tags module

Defined in  content-tags-nodetypes.xml .

Marketing Tags module

Defined in  magnolia-tags-nodetypes.xml .

Password manager module

Defined in  magnolia-keystore-nodetypes.xml .

Custom node types

To meet your needs you can define custom content types and with the Magnolia Content Types module you can define them (together with workspaces) also in light modules.

Please read the page Defining JCR node types and workspaces, which provides an overview of all ways to define custom JCR node types and create new workspaces with Magnolia.