qpid-virtualhosts.xml

The file <MB_HOME>/repository/conf/advanced/qpid-virtualhosts.xml allows you to configure virtual hosts for WSO2 Message Broker. Following is the tree of the XML elements in this file:

virtualhosts
        default
        virtualhost  
            name
            carbon
                store
                    class
                    username
                    password
                    cluster
                    idGenerator
                    connectionString
                    advanced
                           replicationFactor
                           readConsistencyLevel
                           writeConsistencyLevel
                           strategyClass 
              housekeeping
                    threadCount
                    expiredMessageCheckPeriod
              exchanges
              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 config under here. All sub sections from here will come 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>

Under this tag all configuration options are coming for "carbon" virtualhost.

<store>

Defines the store properties used by this virtual host to keep messages. By default apache Cassandra based message store is configured.

Configurable Sub Elements

Element Name	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
<class>	Class that implementing the message store.	String	org.wso2.andes.server.store. CassandraMessageStore	N/A	Mandatory	This should be in the classpath when the broker is staring
<username>	User name for message store access	String	admin		Mandatory	This can be any carbon user with no special permissions.
<password>	Password for message store access	String	admin		Mandatory
<cluster>	Name of the cluster this broker instance should be registered	String	ClusterOne		Mandatory
<idGenerator>	Class generating message IDs for global sync across the cluster	String	org.wso2.andes.server.cluster.coordination. TimeStampBasedMessageIdGenerator		Mandatory
<connectionString>	Connection string for the message store		localhost:9160			if you have external Cassandra server running or Cassandra cluster running this should point to that running instance or cluster.

<advanced>

This section is used to change the default configurations of the Cassandra instance. These values will be used when running broker in a clustered Cassandra set up.

Configurable Sub Elements

Element Name	Description	Type	Default Value	Fixed Values	Mandatory/Optional	Notes
<replicationFactor>	The replication factor specifies how many copies of each data will be stored and distributed throughout the cassandra cluster	Int	1	N/A	Mandatory	If the strategy class is set to 'org.apache.cassandra.locator.NetworkTopologyStrategy' do not set this value in replication factor.
<readConsistencyLevel>	This specifies how many replicas must respond before a result is returned to the client.	String	QUORUM	ONE, TWO, THREE, QUORUM, ALL, ANY, EACH_QUORUM, LOCAL_QUORUM	Mandatory	QUORUM = (replication_factor / 2) + 1
<writeConsistencyLevel>	This specifies how many replicas the write must succeed before returning an acknowledgement to the client.	String	QUORUM	ONE, TWO, THREE, QUORUM, ALL, ANY, EACH_QUORUM, LOCAL_QUORUM	Mandatory
<strategyClass>		String	org.apache.cassandra.locator.SimpleStrategy	SimpleStrategy/NetworkTopologyStrategy	Mandatory

<housekeeping>

Housekeeping task configurations for virtualhosts

Configurable Sub Elements

Element Name	Description	Type	Default Value	Fixed Values	Mandatory/ Optional	Notes
<threadCount>		Int	2	N/A	Mandatory
<expiredMessageCheckPeriod>		Milliseconds	20000	N/A	Mandatory

<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. Declaring an additional exchanges type for developer use only.

<queues>

Note that if you do not a dd 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	Default Value	Fixed Values	Mandatory/ Optional
<maximumQueueDepth>	Defines the maximum number of messages that can be kept in internal queue buffer for delivery	4235264	N/A	Mandatory
<maximumMessageSize>		2117632	N/A	Mandatory
<maximumMessageAge>	messages kept in the broker this much time will be dropped	3600000	N/A	Mandatory
<maximumMessageCount>		50000	N/A	Mandatory