How to define JCR node types and workspaces
This page provides an overview of all ways to define custom JCR node types and create new workspaces with Magnolia.
Even though it has always been possible to define node types and create workspaces within Magnolia Maven modules, the Content Types module brings this functionality also to the light modules. Both approaches are valid.
Whichever approach you choose, we recommend not to develop and refine these definitions in a productive environment. Editing node type and workspace definitions can lead to new node type
definitions and workspaces which are registered again, whereas the
system keeps the |
With content types
By utilizing the magnolia-content-types
module you can define custom
JCR content types and workspaces within light modules.
Defining content types within light modules can be accomplished on a running Magnolia system without redeploying the WAR file of your Magnolia instances and without restarting the instance or a module. This makes it a perfect approach if you have a Magnolia Cloud subscription package. |
A content type definition in one file
You can define all of the following in just one file:
-
JCR workspace
-
JCR nodetype
This node type inherits from the Magnolia node typemgnl:content
. To define more sophisticated node types, you can create a node type definition file in a light module. -
JCR namespace
Example
datasource:
workspace: tourguides
namespaces:
mt: https://www.magnolia-cms.com/jcr/mgnl
autoCreate: true
model:
nodeType: mt:tourGuide
properties:
- name: birthday
type: Date
- name: gender
- name: shortBio
If a node type inheriting from mgnl:content
complies with your
requirements, we recommend defining all of the items – namespace, node
type and workspace – in the content type definition, all in one file.
what is CND - Compact Namespace and Node Type Definition
The Compact Namespace and Node Type Definition (CND) notation provides a compact standardized syntax for defining node types and making namespace declarations. The notation is intended both for documentation and for programmatically registering node types. See http://jackrabbit.apache.org/jcr/node-type-notation.html for more details.
While XML-based node type definitions are still supported, we recommend using CND.
Since this definition must be readable as a
Magnolia Resource, it can be a file in a
light module or in a JAR file or in the resources
JCR workspace.
The CND node type definition resource is loaded only if the CND resource is referenced in the Content type Data source definition of a Content type definition. |
Once the resource is loaded, the system registers the defined JCR node types and namespaces. If required and Jackrabbit allows it, the system may update the definitions.
Example:
-
Create a CND file in your light module and define a namespace and node types:
/content-type-examples/jcr-node-type-files/travellers-node-types.cnd<mt = 'http://www.example.com/jcr/mt'> [mt:traveller] > mgnl:content orderable [mt:tourGuide] > mt:traveller orderable [mt:happyCustomer] > mt:traveller orderable
-
Reference the node type definition from a content type definition:
/content-type-examples/contentTypes/happyCustomer.yamldatasource: workspace: happycustomers autoCreate: true nodeTypeDefinition: /content-type-examples/jcr-node-type-files/travellers-node-types.cnd (4) model: nodeType: mt:happyCustomer properties: - name: country - name: age type: Double
Line 4: References the node type definition resource via
nodeTypeDefinition
.
With a Magnolia Maven module descriptor
With Magnolia Maven modules you can register new JCR workspaces and node types. The registration involves the XML-based module descriptor.
Magnolia registers workspaces and node types during a module’s start-up phase in case they have not yet been registered.
Example of a module descriptor:
my-maven-module/src/main/resources/META-INF/magnolia/my-module.xml
<!DOCTYPE module SYSTEM "module.dtd" >
<module>
<name>my-module</name>
<displayName>${project.name}</displayName>
<description>${project.description}</description>
<class>com.example.magnolia.myModule.MyModuleDefinition</class>
<versionHandler>com.example.magnolia.myModule.setup.MyModuleVersionHandler</versionHandler>
<version>${project.version}</version>
<dependencies>
<dependency>
<name>core</name>
<version>6.0/*</version>
</dependency>
</dependencies>
<repositories>
<repository>
<name>magnolia</name>
<workspaces>
<workspace>products</workspace>
</workspaces>
<nodeTypeFile>/mgnl-nodetypes/products-nodetypes.cnd</nodeTypeFile>
</repository>
</repositories>
</module>
Workspaces
In the
XML-based
module descriptor you can add a <workspace />
section in
/repositories/repository/workspaces
.
<workspaces>
<workspace>products</workspace>
</workspaces>
Node types
To define and register new node types requires two things:
-
Creating a node type definition file (CND or XML) where you define the required node types and name spaces. Create the file in the
my-maven-module/src/main/resources/mgnl-nodetypes/
folder.
Example:my-maven-module/src/main/resources/mgnl-nodetypes/my-node-types.cnd<'mgnl' = 'https://www.magnolia-cms.com/jcr/mgnl'> [mt:product] > mgnl:content orderable
-
Referencing the node type file in the XML-based module descriptor:
Example:my-maven-module/src/main/resources/META-INF/magnolia/my-module.xml(fragment)
<nodeTypeFile>/mgnl-nodetypes/my-node-types.cnd</nodeTypeFile>