Configuration
The Configuration service is used to manage the publishing configuration (adding/updating new publishing channels, processes and MIME types) and is responsible for the following:
-
Managing the configuration files.
-
Capturing updates.
-
Reinitializing corresponding bean definitions.
In a multi-server environment, each node in a cluster must have access to a single .ext folder and the shared location must be appended to the classpth system environment variable.
POST requests only alter config files on a configured app server node. Multi-server deployments can leverage a shared file system location for the config files and avoid needing to manually maintain multiple sets of files on various application servers.
The reInitialize call can be used to avoid restarts even after changing the configuration files manually
on the server .
The configuration capabilities of the API includes the following REST calls:
getAllXmlMimeTypes
|
Function |
Get XML MimeTypes |
||
|
Description |
This request returns all XML MimeTypes that exist on the server. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns the definitions of all xml mime-types. |
||
|
Examples |
URL:
Result:
|
||
getXmlMimeType
|
Function |
Get XML MimeType |
||
|
Description |
This request returns a specified XML MimeType. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The desired MimeType. (Mandatory) |
|
|
Returns |
Returns the definition of the desired XML MimeType, including the parent MimeType, xpath and the processing instruction name and value based on which given MimeType is detected. |
||
|
Examples |
URL:
Result:
|
||
createXmlMimeType
|
Function |
Create a custom XML MimeType. |
||
|
Description |
This request creates a MimeType for an XML document. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The MimeType to be created. (Mandatory) |
|
|
|
string |
The parent MimeType. (Mandatory) |
|
|
|
string |
The xPath. (It is mandatory to specify either the xPath or the piName and piValue.) |
|
|
|
string |
The processing instruction. (It is mandatory to specify either the xPath or the piName and piValue.) |
|
|
|
string |
The processing value. (It is mandatory to specify either the xPath or the piName and piValue.) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getMappedMimeTypes
|
Function |
Get mapped MimeTypes |
||
|
Description |
This request returns a list of MimeTypes mapped to the given content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The content type. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
mapMimeTypes
|
Function |
Map custom XML MimeType with ContentType. |
||
|
Description |
This request maps a content type to a list of mime types. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The content type to be mapped. (Mandatory) |
|
|
|
string |
The mimetypes to be mapped. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
unmapMimeTypes
|
Function |
Unmap custom XML MimeType with ContentType. |
||
|
Description |
This request deletes the content type mappings for given mime types. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The mimetypes to be unmapped. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deleteXmlMimeType
|
Function |
Delete custom XML MimeType. |
||
|
Description |
This request deletes an xml mime type and if this mime type is mapped to a content type, that mapping is also deleted. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The mimetype to be deleted. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getPublishingProcess
|
Function |
Get publishing process |
||
|
Description |
This request returns the xml configuration of the process with the given process name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The process name. (Mandatory) |
|
|
Returns |
Returns the xml configuration of the process with the given process name. |
||
|
Examples |
URL:
Result:
|
||
createPublishingProcess
|
Function |
Create publishing process |
||
|
Description |
This request creates a new process based on the publishingPocessXML. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The publishing process XML (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deletePublishingProcess
|
Function |
Delete publishing process. |
||
|
Description |
This request deletes the publishing process with the given process name. Deletes the channels where this process is used. Deletes the corresponding configuration file of the process and updates ProcessConfig-ext.xml. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The name of the process to be deleted. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getAllPublishingChannelDefinitions
|
Function |
Get all publishing channels |
||
|
Description |
This request returns all publishing of type publish, delver and datadoc. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPublishingChannelDefinition
|
Function |
Get publishing channel |
||
|
Description |
This request returns the definition of the publishing channel with the given Id, including the channel Id, name, channel type, the channel's process name and channel parameters. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The channel Id of the desired publishing channel. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getPublishingChannelDefinitions
|
Function |
Get the publishing channel for a specific content type. |
||
|
Description |
This request returns the definition of the publishing channels of type publish, deliver and datadoc that are mapped to a particular content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The content type that is mapped to the desired publishing channel. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
createPublishingChannels
|
Function |
Create new publishing channels |
||
|
Description |
This request creates new publishing channels as specified in the publishingChannelList. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The publishing channel list. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createContentChannelMappings
|
Function |
Map publishing channel with content type for publishing. |
||
|
Description |
This request maps content types to channels and updates the "PublishingConfig-ext.xml" file with the new mappings. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The content types to be mapped. (Mandatory) |
|
|
|
string |
The publishing channels. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deleteContentChannelMappings
|
Function |
Delete publishing channel and content type mapping. |
||
|
Description |
This request deletes content types to channel mappins and updates the "PublishingConfig-ext.xml" file. If content type is specified, channel mappings are deleted for this content type only. If content type is not specified, then mappings with all content types of the specified channel are deleted. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The content types to be mapped. (Mandatory) |
|
|
|
string |
The publishing channel. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
createIndexingChannelMapping
|
Function |
Map publishing channel with content type for indexing. |
||
|
Description |
This request maps content types to indexing channels and updates the "IndexingChannels-ext.xml" file with the new mappings. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The content types to be mapped. (Mandatory) |
|
|
|
string |
The indexing channels. (Mandatory) |
|
|
|
string |
|
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getMappedIndexingChannel
|
Function |
Get mapped indexing channels for a given content type. |
||
|
Description |
This request returns the definition of the indexing channel mapped to the given content type. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The content type. (Mandatory) |
|
|
|
boolean |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
|
||
deleteIndexingChannelMapping
|
Function |
Delete publishing channel and content type mapping for indexing. |
||
|
Description |
This request deletes content type to indexing channel mapping and updates the "IndexingChannels-ext.xml" file. If content type is specified, channel mapping is deleted for the given content type only. If content type is not specified, then mappings with all content types of the specified channel are deleted. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The channel. |
|
|
|
string |
The content type. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
deletePublishingChannels
|
Function |
Delete publishing channel. |
||
|
Description |
This request deletes the channels specified. The "ChannelConfig-ext.xml" file is updated and any mapping for the specified channels is also deleted. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
The channel Ids of the channels to be deleted. |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
getDeploymentProperties
|
Function |
Get deployment properties |
||
|
Description |
This request returns all properties specified for the deployment in the "Deployment.properties" file. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getDeploymentVersion
|
Function |
Get deployment version |
||
|
Description |
This request returns the version of the custom deployment. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
This request requires no input parameters. |
||
|
Returns |
Returns the text value of the deployment version specified in the "Deployment.properties" file. |
||
|
Examples |
URL:
Result: 1.2 |
||
reInitialize
|
Function |
ReIntialize |
||
|
Description |
This request reinitializes the mime-type, channel and process definitions using their config files. It will reinitialize the content-mime-type mappings configuration, content type to channel mappings configuration and content type to indexing channel mappings configuration. This request may be used to apply settings assigned directly to config files without restarting the server. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
boolean |
|
|
|
|
boolean |
|
|
|
|
boolean |
|
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
