Configuring carbon.xml
Users can change the configurations related to the default Carbon functionality by editing the <PRODUCT_HOME>/repository/conf/carbon.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 |
|---|---|---|---|---|---|---|
<Server> |
|
|
|
|
|
|
| xmlns |
|
|
|
|
|
_<Name> |
| Product Name. | String | N/A | Mandatory | <Name>WSO2 Application Server</Name> |
_<ServerKey> |
| Machine readable unique key to identify each product. | String | N/A | Mandatory | <ServerKey>AS</ServerKey> |
_<Version> |
| Product Version. | String | N/A |
| <Version>5.2.0</Version> |
_<HostName> |
| Host name or IP address of the machine hosting this server e.g. www.wso2.org, 192.168.1.10 This is will become part of the End Point Reference of the services deployed on this server instance. | String | N/A | Optional | <HostName>wso2.org</HostName> |
_<MgtHostName> |
| Host name to be used for the Carbon management console. | String | N/A | Optional | <MgtHostName>mgt.wso2.org</MgtHostName> |
_<ServerURL> |
| The URL of the back end server. This is where the admin services are hosted and will be used by the clients in the front end server. This is required only for the Front-end server. This is used when separating the BE server from the FE server. | String | N/A | Mandatory | <ServerURL>local:/${carbon.context}/services/</ServerURL> |
_<IndexPageURL> |
| The URL of the index page. This is where the user will be redirected after signing in to the carbon server. | String | N/A | Optional |
|
_<ServerRoles> |
| For cApp deployment, we have to identify the roles that can be acted by the current server. The following property is used for that purpose. Any number of roles can be defined here. Regular expressions can be used in the role. Ex : <Role>.*</Role> means this server can act as any role. | String | N/A | Mandatory | <ServerRoles>ApplicationServer</ServerRoles> |
__<Role> |
|
|
|
|
|
|
_<BamServerURL> |
|
|
|
|
|
|
_<Package> |
| The fully qualified name of the server. | String | org.wso2.carbon | Mandatory |
|
_<WebContextRoot> |
| Webapp context root of WSO2 Carbon. | String | / | Mandatory | <WebContextRoot>/</WebContextRoot> |
<MgtProxyContextPath> |
| Proxy context path is a useful parameter to add a proxy path when a Carbon server is fronted by reverse proxy. In addition to the proxy host and proxy port this parameter allows you add a path component to external URLs. | String |
| Optional |
|
_<RegistryHttpPort> |
| In-order to get the registry http Port from the back-end when the default http transport is not the same. | Int | N/A | Optional |
|
_<ItemsPerPage> |
| Number of items to be displayed on a management console page. This is used at the backend server for pagination of various items. | Int | N/A | Mandatory |
|
_<InstanceMgtWSEndpoint> |
| The endpoint URL of the cloud instance management Web service. | String | N/A | Optional |
|
_<Ports> |
| Ports used by this server |
|
|
|
|
__<Offset> |
| Ports offset. This entry will set the value of the ports defined below to the define value + Offset. e.g. Offset=2 and HTTPS port=9443 will set the effective HTTPS port to 9445. | Int | 0 | Mandatory | <Offset>15</Offset> |
__<JMX> |
| The JMX Ports. | Int |
| Mandatory |
|
____<RMIRegistryPort> |
| The port RMI registry is exposed. | Int | 9999 | Mandatory |
|
____<RMIServerPort> |
| The port RMI server should be exposed. | Int | 11111 | Mandatory |
|
__<EmbeddedLDAP> |
| Embedded LDAP server specific ports. | Int |
| Mandatory |
|
____<LDAPServerPort> |
| Port which embedded LDAP server runs. | Int | 10389 | Mandatory |
|
____<KDCServerPort> |
| Port which KDC (Kerberos Key Distribution Center) server runs. | Int | 8000 | Mandatory |
|
__<JNDIProviderPort> |
| Override datasources JNDIproviderPort defined in bps.xml and datasources.properties files. |
|
|
|
|
__<ThriftEntitlementReceivePort> |
| Override receive port of thrift based entitlement service. | Int | N/A | Mandatory |
|
_<JNDI> |
| JNDI Configuration. | Int | N/A | Optional |
|
__<DefaultInitialContextFactory> |
| The fully qualified name of the default initial context factory. | String | org.wso2.carbon.tomcat.jndi.CarbonJavaURLContextFactory | Mandatory |
|
_<Restrictions> |
| The restrictions that are done to various JNDI Contexts in a Multi-tenant environment. |
|
|
|
|
___<AllTenants> |
| Contexts that are common to all tenants. | String | N/A | Optional |
|
_____<UrlContexts> |
|
|
|
|
|
|
_______<UrlContext> |
|
|
|
|
|
|
_________<Scheme> |
|
|
|
|
|
|
__<SuperTenantOnly> |
| Contexts that will be available only to the super-tenant. | String | N/A | Optional |
|
_<IsCloudDeployment> |
| Property to determine if the server is running on a cloud deployment environment. This property should only be used to determine deployment specific details that are applicable only in a cloud deployment, i.e when the server is deployed *-as-a-service. | Boolean | FALSE | Mandatory |
|
_<EnableMetering> |
| Property to determine whether usage data should be collected for metering purposes. | Boolean | FALSE | Mandatory |
|
_<MaxThreadExecutionTime> |
| The Max time a thread should take for execution in seconds. | Int | 600 | Mandatory |
|
_<GhostDeployment> |
| A flag to enable or disable Ghost Deployer. By default this is set to false. That is because the Ghost Deployer works only with the HTTP/S transports. If you are using other transports, don't enable Ghost Deployer. | Boolean | FALSE | Optional |
|
___<Enabled> |
| When <GhostDeployment> is enabled, the lazy loading feature will apply to artifacts deployed. That is, when a tenant loads, only the specific artifact requested by the service will be loaded. |
|
|
|
|
_<Axis2Config> |
| Axis2 related configurations. |
|
|
|
|
___<RepositoryLocation> |
| Location of the Axis2 Services & Modules repository This can be a directory in the local file system, or a URL. e.g. 1. /home/wso2wsas/repository/ - An absolute path 2. repository - In this case, the path is relative to CARBON_HOME 3. file:///home/wso2wsas/repository/ 4. http://wso2wsas/repository/. | String | ${carbon.home}/repository/deployment/server/ | Mandatory |
|
___<DeploymentUpdateInterval> |
| Deployment update interval in seconds. This is the interval between repository listener executions. | Int | 15 | Mandatory |
|
___<ConfigurationFile> |
| Location of the main Axis2 configuration descriptor file, a.k.a. axis2.xml file This can be a file on the local file system, or a URL e.g. 1. /home/repository/axis2.xml - An absolute path 2. conf/axis2.xml - In this case, the path is relative to CARBON_HOME 3. file:///home/carbon/repository/axis2.xml 4. http://repository/conf/axis2.xml | String | ${carbon.home}/repository/conf/axis2/axis2.xml | Mandatory |
|
___<ServiceGroupContextIdleTime> |
| ServiceGroupContextIdleTime, which will be set in ConfigurationContex for multiple clients which are going to access the same ServiceGroupContext Default Value is 30 Sec. | String |