Structure of a Content Delivery Extension configuration in the Add-on manifest
An Extension configuration for Content Delivery lists the name and type of the Extension, as well as the Content Delivery versions it's compatible with. It also require a number of predefined properties to be set.
The basic structure of a Content Delivery Extension configuration is as follows:
{
"type": "EXTENSIONTYPE",
"name": "EXTENSIONNAME",
"supportedVersions": "EXTENSIONVERSION",
"properties": {
"EXTENSIONPROPNAME": "EXTENSIONPROPVALUE"
}
}
where:
- EXTENSIONTYPE is the type of extension point you are extending using your Extension
- EXTENSIONNAME is the name of the Extension
- EXTENSIONVERSION is the JAR manifest version that indicates which Content Delivery release the Extension is compatible with. Set this property to the value 11.1.0.0 if you are extending Content Delivery version 11.1 (which is the Content Delivery version included in SDL Tridion Sites 9.1). The Tridion Sites checks if your Extension is being deployed to a valid Content Delivery version.
- EXTENSIONPROPNAME is the name of a property for this Extension.
- EXTENSIONPROPVALUE is the name of the value for that property.
A Content Delivery Extension has the following properties:
| Property name | Description of value |
|---|---|
entryPoint | A Java activator class that gets control after the Extension is loaded. |
loadingPhase | The moment at which the Extension should be loaded, either before the application has initialized (value BEFORE_APP_INITIALIZED) or after (value AFTER_APP_INITIALIZED). |
configurationSources | An array of one or more configurations associated with this Extension |
name in configurationSources | The name of one configuration associated with this Extension |
type in configurationSources | The format of one configuration associated with this Extension. Possible values are XML or json. |
properties in configurationSources | Any number of custom properties and their values for this configuration. |
capabilities | An array of one or more supported Content Delivery Capabilities. |
Note that the properties section can additionally contain any number of custom properties and their values.