This descriptor also acts as the controller descriptor for access to various sub configurations. This descriptor expects the input for the following configuration:
Config Key | Mandatory/Optional | Type | Purpose |
|---|---|---|---|
Category: Other configuration references | |||
CT_SECURITY_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the security configuration for Canvas must be loaded. |
CT_CACHE_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the Cache configuration of the application can be provided to Canvas |
CT_DB_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where CT gets the details of the various data sources that the CT database framework must be aware of. |
CT_EXPORT_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT Export framework must get initialized from. |
CT_MULTILINGUAL_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT multilingual framework must get initialized from. |
CT_WEBUTIL_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT gets the web utilities related configuration. |
CT_IMPL_CLASS | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT gets the list of CT Classes implemented. |
CT_COMP_PREF_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT gets the preferences to enable or disable apps, workspace, and sub workspace features. |
CT_SYSTEM_PREF_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle from where the CT gets the preferences to enable or disable system level features. |
CT_LOGGING_CONFIG_BUNDLE | Mandatory | Bundle Name | This is a pointer to the bundle that provides the configuration details specific to logging done by CT. |
Category: Common Folders needed by Canvas | |||
CT_WORK_FOLDER_PATH | Mandatory | Folder Path | This is the working folder to CT. The CT creates additional child folders within this working folder for its various needs.In a clustered environment, this folder is expected to be specific to the node where the application is running and not shared with other nodes. For example, the log files applicable for that particular node. |
Folder Path | |||
CT_WORK_CENTRALIZED_FOLDER_PATH | Mandatory | This is a folder on the SAN that is available across all the nodes. This is critical on a clustered setup for any content that is shared across nodes. An example could be the user image file that needs to be accessible across all nodes in a cluster. | |
The default descriptor is the input to the ConfigurationManager for loading the configuration. This bundle acts as the controller for identifying other configurations and other common information.
The following is a sample bundle MyImplementation.properties used for initializing the configuration:
# This should be loaded from where the security configuration will be identified CT_SECURITY_BUNDLE=securityconfig # This should be loaded from where the Cache configuration will be identified CT_CACHE_BUNDLE=cacheconfig # This should be loaded from where the DB configuration will be identified CT_DB_BUNDLE =databaseconfig # This should be loaded from where the Export configuration will be identified CT_EXPORT_BUNDLE=exportconfig # This should be loaded from where the Bundle configuration will be identified CT_MULTILINGUAL_BUNDLE=multilingualconfig # This should be loaded from where the Web Utils configuration will be identified CT_WEBUTIL_BUNDLE=webutilconfig # This should be loaded from where the Implementation class will be identified CT_IMPL_CLASS=implclassconfig # This should be loaded from where the components related preferences will be identified. CT_COMP_PREF_BUNDLE=componentspreferences # This should be loaded from where the system related preferences will be identified. CT_SYSTEM_PREF_BUNDLE=systempreferences # This provides the configuration details specific to logging to be done by CT Framework CT_LOGGING_CONFIG_BUNDLE=loggerconfig # This property provides the path for instance level folder CT_WORK_FOLDER_PATH=D:/Canvas/Modelhouse # This property provides the centralized folder path CT_WORK_CENTRALIZED_FOLDER_PATH=D:/Canvas/Modelhouse
This bundle is used to initialize the Canvas configuration as follows:
import com.intellectdesign.canvas.config.ConfigurationException;
import com.intellectdesign.canvas.config.ConfigurationManager;
ConfigurationManager manager = ConfigurationManager.getInstance();
manager.initializeFromBundle("MyImplementation");