org.jahia.services.render.scripting.bundle

Class BundleScriptingConfigurationConstants

java.lang.Object

org.jahia.services.render.scripting.bundle.BundleScriptingConfigurationConstants

public class BundleScriptingConfigurationConstants
extends Object

A class gathering constants used for bundles providing configuration targeted at providing new scripting language support.

Author:

Christophe Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAHIA_MODULE_HAS_VIEWS OSGi header specifying whether the module provides any views so that it can be skipped by DX when looking for views.
static String	JAHIA_MODULE_SCRIPTING_VIEWS OSGi header specifying a comma-separated list of script languages for which this module provides views.
static String	JAHIA_SCRIPTING_EXTENSIONS_PRIORITIES OSGi header to allow modules providing new scripting languages to control the order of how views are resolved by DX by controlling the priority of file extensions associated with specific view technologies.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

JAHIA_MODULE_HAS_VIEWS

public static final String JAHIA_MODULE_HAS_VIEWS

OSGi header specifying whether the module provides any views so that it can be skipped by DX when looking for views. A no value for this header specifies that the module doesn't provide any view and will therefore be skipped when DX scans modules for views. Any other value is ignored and will result in the module being scanned for views. This header is useful to prevent any form of view-related inspection of your module in order to speed-up deployment and/or DX startup.

See Also:

Constant Field Values

JAHIA_MODULE_SCRIPTING_VIEWS

public static final String JAHIA_MODULE_SCRIPTING_VIEWS

OSGi header specifying a comma-separated list of script languages for which this module provides views. Script languages in this case are identified by engine name, language name and/or file extension. This header is mandatory for modules wishing to provide views for non-default scripting languages as DX will not scan bundles for non-default scripting languages views by default. It is therefore important for a module to specify which scripting languages it provides views for so that it is properly scanned and its views, registered. This header is not needed if you only provide views using scripting languages supported by default.

The following example specifies that the bundle provides views for the Thymeleaf and PHP scripting languages:

  <Jahia-Module-Scripting-Views>thymeleaf,php</Jahia-Module-Scripting-Views>
 

See Also:

Constant Field Values

JAHIA_SCRIPTING_EXTENSIONS_PRIORITIES

public static final String JAHIA_SCRIPTING_EXTENSIONS_PRIORITIES

OSGi header to allow modules providing new scripting languages to control the order of how views are resolved by DX by controlling the priority of file extensions associated with specific view technologies.

Its value should consist of a space-separated list of extension=priority pairs specifying the new ordering of extensions.

The following example specifies that the foo extension will have a priority of 1000 while the bar extension will have a priority of 250, thus making it of higher priority.

  <Jahia-Scripting-Extensions-Priorities>foo=1000 bar=250</Jahia-Scripting-Extensions-Priorities>
 

See Also:

Constant Field Values