Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
This page describes data source definition of a Magnolia Content type. A data source defines how content type items are persisted.
Example configuration:
datasource: workspace: tourguides namespaces: mt: https://www.magnolia-travel.com/jcr/1.0/mt autoCreate: true model: nodeType: mt:tourGuide properties: - name: birthday type: Date - name: gender - name: shortBio
datasource
properties:type | optional, default is The type of the data source. If the value is JCR, the definition class must implement JcrDataSourceDefinition. |
workspace | required The name of the JCR workspace to store the content items. When the definition item is loaded, and if there is no workspace registered by the given name and the |
rootPath | optional, default is The root path for content type items in the given JCR workspace. |
namespaces | optional A list of JCR namespace names. |
| A JCR namespace name. When the definition item is loaded, and if the given JCR namespace hasn't been registered yet, the system will register the namespace. The namespace name must comply with the rules for XML namespaces, see https://www.w3.org/TR/REC-xml-names/#NT-NCName, https://www.w3.org/TR/REC-xml/#sec-common-syn. |
autoCreate | optional, default is If set to
|
nodeTypeDefinition | optional The path to an CND file which defines a JCR node type definition. The file must be a Magnolia Resource. When the definition item is loaded, and if the node type defined in the file is not yet registered, the system will register it. (See Using the |
The model
, explained in more detail on the Content type Model definition page, defines which nodeType
is used. The model itself does not define the nature of the node type. In the example above the nodetype
chosen is mt:tourGuide
.
Let's assume that the mt:tourGuide
nodetype has not been registered yet. How to make sure that the model can utilize it?
There are two approaches.
nodeTypeDefinition
property and a CND file for the node type definition.The example above defines all the JCR parameters in one YAML file. In most cases this is the recommended approach.
Namespace
If you intend to use a JCR namespace that hasn't been defined yet, you can define the new namespace, for example mt
, with the namespaces
property.
Node type
In the above example, assuming that mt:tourGuide
has not been registered yet, the system will automatically register a new node type with the given namespace mt
, and the new node type inherits from the Magnolia mgnl:content
node type.
nodeTypeDefinition
and CND node type definition fileWith the nodeTypeDefinition
property you can define a path to a CND file to define a JCR node type definition.
While XML-based node type definitions are still supported, we recommend using CND.
Using a CND file allows you to define various JCR namespace and node type definitions. Node type definitions based on a CND file can be more complex than the automatically generated node types, which inherit from mgnl:content
automatically.
Example of a CND-based node type definition:
<mt = 'http://www.magnolia.info/jcr/mt'> [mt:traveller] > mgnl:content orderable [mt:tourGuide] > mt:traveller orderable [mt:happyCustomer] > mt:traveller orderable
datasource: workspace: happycustomers autoCreate: true nodeTypeDefinition: /content-type-examples/jcr-node-type-files/travellers-node-types.cnd model: nodeType: mt:happyCustomer properties: - name: country - name: age type: Double
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.
Access to JCR workspaces is controlled by role-based access control lists (ACLs).
When the system detects and registers a new JCR workspace from a data source definition, it also automatically updates the superuser
role by adding an ACL for the given workspace and granting read/write permissions for the /
path.
In a production system, if you want to provide anonymous website visitors with (read) access to a specific JCR workspace, you must update the anonymous
role by adding an ACL for the workspace.
For further information please read:
The base DataSourceDefinition interface is agnostic of any data source type. To specify a JCR data source, Magnolia provides the JcrDataSourceDefinition interface and the ConfiguredJcrDataSourceDefinition implementation class.
For DataSourceDefinition the ConfiguredJcrDataSourceDefinition is the default implementation class via type mapping on the XML-based module descriptor of the magnolia-content-types
module.
By default Magnolia expects you to configure properties for ConfiguredJcrDataSourceDefinition to define a JCR data source.