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/.

Server Roles

A Server Role is a parameter that is mentioned in carbon.xml for wso2carbon based products. Each product has a different default ServerRoles property in its carbon.xml. The Default Server Role value for WSO2 Governance Registry is GovernanceRegistry.

Another Server Role values:

  • WSO2 AppServer - "ApplicationServer"
  • WSO2 BAM - "BusinessActivityMonitor"
  • WSO2 BPS - "BusinessProcessServer"
  • WSO2 BRS - "BusinessRulesServer"
  • WSO2 DSS - "DataServicesServer"
  • WSO2 ESB - "EnterpriseServiceBus"
  • WSO2 GS - "GadgetServer"
  • WSO2 IS - "IdentityServer"
  • WSO2 MS - "MashupServer"

This property value is used for deployment of C-App archives. Generally, a C-App consists of a set of resources that is to be deployed in different products. So if a user deploys a C-App in a carbon product, all of the resources cannot be deployed in that particular product instance. To sort out which can be deployed and which cannot, the Server Role property is used. When a C-App is deployed, it reads the ServerRoles property in carbon.xml and deploys only the resources which match the Server Role values there.

The Server Roles Manager is a component to manage server roles property for WSO2Carbon-based products.

As Carbon supports adding different product features into one product instance, the original concept of the server role property being added into carbon.xml is hard to manage because users may have to manually modify the carbon.xml to include the Server Roles related to the product feature they have added to a carbon product instance.

To overcome those issues, the Server Role Manager is introduced. The server role manager will store the both carbon.xml default product roles and the user/tenant specified server roles in the "Configuration" registry. So when a C-App is deploying in carbon, the C-App deployer will check for the aforementioned server roles from the registry instead of carbon.xml.

See also Adding a Server Role, Configuring Server Role and Deleting a Server Role.