Skip to end of metadata
Go to start of metadata

A server-role is a parameter that is mentioned in carbon.xml for WSO2 Carbon based products. Each product has a different default ServerRole property in its carbon.xml. Default server role values for WSO2 Carbon based products are as follows:

  • WSO2 Gadget Server - "GadgetServer"
  • WSO2 Application Server - "ApplicationServer"
  • WSO2 Business Activity Monitor - "BusinessActivityMonitor"
  • WSO2 Business Process Server - "BusinessProcessServer"
  • WSO2 Business Rules Server - "BusinessRulesServer"
  • WSO2 Data Services Server - "DataServicesServer"
  • WSO2 Enterprise Service Bus - "EnterpriseServiceBus"
  • WSO2 Governance Registry - "GovernanceRegistry"
  • WSO2 Identity Server - "IdentityServer"
  • WSO2 Mashup Server - "MashupServer"

This property value is used for deployment of C-App archives. (For more information about C-App archives, refer to Carbon Applications).

Generally a C-App consists of a set of resources that is to be deployed in different products. So, if an 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 and which cannot be deployed, the server-role property is used. When a C-App is being deployed, it reads the ServerRoles property in carbon.xml and deploys only the resources which match the server-role values in there. Here is an example list of C-App resources that map to default server roles.

  • ApplicationServer - foo.aar, jax-wx.jar
  • EnterpriseServiceBus - proxy.xml
  • BusinessProcessServer -
  • GadgetServer - gadget.xml

Server Roles Manager

Server roles manager is a component to manage server roles property for WSO2 Carbon based products.

As Carbon supports adding different product features into one product instance original concept of the server role property being added into carbon.xml is hard to manage as 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. As WSO2 Stratos, which is the WSO2 Carbon based Cloud Middleware Platform, is introduced, the above action is not possible for a tenant since the tenant user is remote to the server instance.

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

In server-roles manager, the server-roles properties will be of two types:

  • Default - All the server roles picked from that particular product instance's carbon.xml. In Gadget Server, the carbon.xml file can be found at <GS_HOME>{color}repository\conf folder.
  • Custom - All other server roles added by the users.

WSO2 Gadget Server allows to add and delete server roles.

  • No labels