Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configurable Sub Elements
Element NameDescriptionTypeDefault ValueFixed ValuesMandatory/
Optional
Notes
<default>Sets the default virtual host for connections which do not specify a vhStringcarbonone of defined virtual-hostsMandatory 

<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 NameDescriptionTypeDefault ValueFixed ValuesMandatory/OptionalNotes
<name>Sets the identifiable name for the virtualhostStringcarbonN/AMandatory 

<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 NameDescriptionTypeDefault ValueFixed ValuesMandatory/
Optional
Notes
<class> Class that implementing the message store.String  org.wso2.andes.server.store.
CassandraMessageStore
 N/AMandatory 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 StringClusterOne Mandatory 
<idGenerator>Class generating message IDs for global sync across the cluster Stringorg.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 NameDescriptionTypeDefault ValueFixed Values

Mandatory/Optional

Notes
<replicationFactor>The replication factor specifies how many copies of each data will be stored and distributed throughout the cassandra clusterInt1N/AMandatory

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.StringQUORUMONE, TWO, THREE, QUORUM, ALL, ANY, EACH_QUORUM, LOCAL_QUORUMMandatory
QUORUM = (replication_factor  / 2) + 1
<writeConsistencyLevel>This specifies how many replicas the write must succeed before returning an acknowledgement to the client.StringQUORUMONE, TWO, THREE, QUORUM, ALL, ANY, EACH_QUORUM, LOCAL_QUORUMMandatory 
<strategyClass> Stringorg.apache.cassandra.locator.SimpleStrategySimpleStrategy/NetworkTopologyStrategyMandatory 

 

<housekeeping>

Housekeeping task configurations for virtualhosts

Configurable Sub Elements
Element NameDescriptionTypeDefault ValueFixed ValuesMandatory/
Optional
Notes
<threadCount> Int2N/AMandatory 
<expiredMessageCheckPeriod> Milliseconds20000N/AMandatory 

<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 NameDescriptionTypeDefault ValueFixed ValuesMandatory/
Optional
Notes
<maximumQueueDepth> Defines the maximum number of messages that can be kept in internal queue buffer for delivery 4235264N/A Mandatory 
<maximumMessageSize>  2117632N/A Mandatory 
<maximumMessageAge> messages kept in the broker this much time will be dropped 3600000 N/A Mandatory 
<maximumMessageCount>   50000N/A Mandatory