The following file allows you to configure virtual hosts for WSO2 Message Broker: <MB_HOME>/repository/conf/advanced/qpid-virtualhosts.xml. Following is the tree of the XML elements in this file:
<virtualhosts>
<default>
<virtualhost>
<name>
<carbon>
<housekeeping>
<threadCount>
<expiredMessageCheckPeriod>
<exchanges>
<type>
<name>
<durable>
<exchange>
<type>
<name>
<queues>
<maximumQueueDepth>
<maximumMessageSize>
<maximumMessageAge>
<maximumMessageCount>
Click an element below for more information about that element.
<virtualhosts>
This configuration file contains details of all queues and topics, and associated properties, to be created on broker startup. These details are configured on a per virtual host basis. Note that if you do not add details of a queue or topic you intend to use to this file, you must first create a consumer on a queue/topic before you can publish to it using WSO2 MB. Thus, most application deployments need a virtualhosts.xml file with at least some minimal detail.
Configurable Sub Elements
| Element Name | Description | Type | Default Value | Fixed Values | Mandatory/ Optional | Notes |
|---|---|---|---|---|---|---|
| <default> | Sets the default virtual host for connections which do not specify a vh | String | carbon | one of defined virtual-hosts | Mandatory |
<virtualhost>
Define a virtual host and all it's configurations under this element. All sub sections are under this element.
Configurable Sub Elements
| Element Name | Description | Type | Default Value | Fixed Values | Mandatory/Optional | Notes |
|---|---|---|---|---|---|---|
| <name> | Sets the identifiable name for the virtualhost | String | carbon | N/A | Mandatory |
<carbon>
All configuration options for "carbon" virtual host are defined under this element.
<housekeeping>
Housekeeping task configurations for virtualhosts. This section configures the clean-up threads that work on flushing out obsolete/expired messages from the AMQP exchanges.
Configurable Sub Elements
| Element Name | Description | Type | Default Value | Fixed Values | Mandatory/ Optional | Notes |
|---|---|---|---|---|---|---|
| <threadCount> | The number of clean-up threads. | Integer | 2 | N/A | Mandatory | |
| <expiredMessageCheckPeriod> | The time intervals at which the QPID broker checks for expired messages. | Integer | 20000 | N/A | Mandatory | The value is specified in milliseconds. |
<exchanges>
Define the types of additional AMQP exchange available for this vh. Always get amq.direct (for queues) and amq.topic (for topics) by default. Declare an additional exchange type for developer use only.
<queues>
Note that if you do not add details of a queue or topic you intend to use to this file, you must first create a consumer on a queue/topic before you can publish to it using WSO2 MB.
Configurable Sub Elements
| Element Name | Description | Type | Default Value | Fixed Values | Mandatory/ Optional | Notes |
|---|---|---|---|---|---|---|
| <maximumQueueDepth> | Defines the maximum number of messages that can be kept in the internal queue buffer for delivery. You can switch it off by setting it to 0. | 0 | N/A | Mandatory | ||
| <maximumMessageSize> | The maximum size, in bytes, of the messages that can be kept in the queue. You can switch it off by setting it to 0. | 0 | N/A | Mandatory | ||
| <maximumMessageAge> | Messages kept for this amount of time in the broker will be dropped. You can switch it off by setting it to 0. | 0 | N/A | Mandatory | ||
| <maximumMessageCount> | The maximum message count of a queue. You can switch it off by setting it to 0. | 0 | N/A | Mandatory |