This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
Configuring registry.xml
- Former user (Deleted)
Users can change the default configurations by editing the <PRODUCT_HOME>/repository/conf/registry.xml file using the information given below.
Click on the table and use the left and right arrow keys to scroll horizontally.
XML Elements
| XML element | Attribute | Description | Data type | Default value | Mandatory/ Optional | Sample |
|---|---|---|---|---|---|---|
| <wso2registry> | Mandatory | |||||
| __<currentDBConfig> | The server can only handle one active configuration at a time. The currentDBConfig parameter defined in the registry.xml is used to specify the database configuration that is active at present. The value of the currentDBConfig parameter should be a valid name of a database configuration defined on the registry.xml file. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Database+Configuration+Details | String | wso2registry | Mandatory | <currentDBConfig>wso2registry </currentDBConfig> | |
| __<readOnly> | To run the registry in read-only mode, set the readOnly element to true. Setting the read-only mode allows you to run an immutable instance of registry repository. This setting is valid on a global level. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Registry+Configuration+Details | Boolean | false | Mandatory | <readOnly>false</readOnly> | |
| __<enableCache> | To enable registry caching, set the enableCache element to true. Once caching is enabled, repetitive read operations will be executed against the cache instead of the database. This setting is valid on a global level. | Boolean | true | Mandatory | <enableCache>true</enableCache> | |
| __<registryRoot> | The registryRoot parameter can be used to define the apparent root of the running instance of the server. This setting is valid on a global level. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Registry+Configuration+Details | String | / | Mandatory | <registryRoot>/</registryRoot> | |
| __<dbConfig> | String | Mandatory | <dbConfig name="wso2registry"> | |||
| name | String | wso2registry | ||||
| __ __<dataSource> | String | jdbc/WSO2CarbonDB | Mandatory | <dataSource>jdbc/WSO2CarbonDB </dataSource> | ||
| __<handler> | Handlers are pluggable components, that contain custom processing logic for handling resources. All handlers extend an abstract class named Handler, which provides default implementations for resource handling methods as well as a few utilities useful for concrete handler implementations. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Handler+Configuration+Details | String | Optional | |||
| class | String | <handler class="org.wso2.carbon.registry .extensions.handlers.SynapseRepositoryHandler"> | ||||
| __<filter> | String | Optional | ||||
| class | String | <filter class="org.wso2.carbon.registry.core.jdbc .handlers.filters.MediaTypeMatcher"> | ||||
| __<remoteInstance> | In order to mount an external registry, you have to define the remote instance. This could use either the JDBC-based configuration, the Atom-based configuration model or the WebService-based configuration model. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Remote+Instance+and+Mount+Configuration+Details | Optional | ||||
| url | The URL of the remote instance. | String | https://localhost:9443/registry | remoteInstance url="https://localhost:9443/registry"> | ||
| __<ID> | Remote instance ID. | String | instanceid | Optional | <id>instanceid</id> | |
| __<username> | Username of the remote registry login. | String | username | Optional | <username>username</username> | |
| __<password> | Password of the remote registry login. | String | password | Optional | <password>password</password> | |
| __<dbConfig> | The database configuration to use. | String | wso2registry | Optional | <dbConfig>wso2registry</dbConfig> | |
| __<readOnly> | To run the registry in read-only mode set the readOnly element to true. Setting the read-only mode allows you to run an immutable instance of registry repository. This setting is valid only for the specific remote instance. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Registry+Configuration+Details | String | false | Optional | <readOnly>false</readOnly> | |
| __<enableCache> | To enable registry caching, set the enableCache element to true. Once caching is enabled, repetitive read operations will be executed against the cache instead of the database. This setting is valid only for the specific remote instance. | String | true | Optional | <enableCache>true</enableCache> | |
| __<registryRoot> | The registryRoot parameter can be used to define whether the apparent root of the running instance of the server. This setting is valid only for the specific remote instance. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Registry+Configuration+Details | String | / | Optional | <registryRoot>/</registryRoot> | |
| __<mount> | Once a remote instance has been defined, a collection on the remote registry can be mounted to the local instance. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Remote+Instance+and+Mount+Configuration+Details | Mandatory | <mount path="/_system/config" overwrite="true|false|virtual"> | |||
| path | The path to which the mount will be added to. | String | /_system/config | |||
| overwrite | Whether an existing collection at the given path would be overwritten or not. | true|false|virtual | ||||
| __<instanceID> | Remote instance ID. | instanceid | Mandatory | <instanceId>instanceid</instanceId> | ||
| __<targetPath> | The path on the remote registry. | String | /_system/nodes | Mandatory | <targetPath>/_system/nodes</targetPath> | |
| __<versionResourcesOnChange> | You can configure whether you want to auto-version the resources (non-collection) by setting versionResourcesOnChange element to true. In this configuration it will create a version for the resources whenever it is updated. For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Configuration+for+Static+%28One-time%29+and+Auto+Versioning+Resources | Boolean | true | Mandatory | <versionResourcesOnChange>true </versionResourcesOnChange> | |
| __<staticConfiguration> | While most configuration options can be changed after the first run of the WSO2 Governance Registry, changing the Static Configuration (configuration details under the staticConfiguration parameter), will not be fully effective. If you need to change any Static Configuration and expect it to take effect, you will have to erase the contents of the database, and restart the server passing the -Dsetup system property which will re-generate the database. You are supposed to change the static configuration section only before loading any data to the registry. (That is before the first start-up.) For more information, see the Governance Registry documentation here: http://docs.wso2.org/display/Governance501/Configuration+for+Static+%28One-time%29+and+Auto+Versioning+Resources | Mandatory | <staticConfiguration><versioningProperties>true</versioningProperties> <versioningComments>true</versioningComments><versioningTags>true</versioningTags><versioningRatings>true</versioningRatings></staticConfiguration> | |||
| __ __<versioningProperties> | Whether the properties are versioned when a snapshot is created. | Boolean | true | Mandatory | ||
| __ __<versioningComments> | Whether the comments are versioned when a snapshot is created. | Boolean | true | Mandatory | ||
| __ __<versioningTags> | Whether the tags are versioned when a snapshot is created. | Boolean | true | Mandatory | ||
| __ __<versioningRatings> | Whether the ratings are versioned when a snapshot is created. | Boolean | true | Mandatory |