This documentation is for WSO2 Message Broker 3.0.0. View documentation for the latest release.
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.

Versions Compared

Key

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

...

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

<virtualhost>

Define a virtual host and all it's configurations under this element. All sub sections are included under this element.

Configurable Sub Elements
Element NameDescriptionTypeDefault ValueFixed ValuesMandatory/OptionalNotes
<name>This parameter sets an identifiable name for the virtualhostStringcarbonN/AMandatory 

<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 NameDescriptionTypeDefault ValueFixed ValuesMandatory/
Optional
Notes
<threadCount>The number of clean-up threads.Integer2N/AMandatory 
<expiredMessageCheckPeriod>The time intervals at which the QPID broker checks for expired messages.Integer20000N/AMandatoryThe value is specified in milliseconds.

<exchanges>

This element is commented out by default and is not mandatory. If required, you can use this to define additional AMQP exchanges for this virtual host. For example, if you want queues to be automatically created in the message broker during server startup, you need to specify the type of AMQP exchange to use and you need to update the <queues> element in this file with the required queue information. Note that amq.direct is the default exchange that should be used for queue creation.

<queues>

You can use this <queues> section and the <exchanges> element explained above to create new queues during server startup. You can find detailed instructions on the different methods of creating queues in WSO2 MB from here.

 The following additional sub elements are available for queues:

Element NameDescription
<maximumQueueDepth>Defines the maximum number of messages that can be kept in the internal queue buffer for delivery. You can disable the parameter by setting it to 0.
<maximumMessageSize>The maximum size, in bytes, of the messages that can be kept in the queue. You can disable the parameter by setting it to 0.
<maximumMessageAge>The maximum duration of time a message can be kept in the broker. A message will be dropped when it has been kept for the time duration specified. You can disable the parameter by setting it to 0.
<maximumMessageCount>The maximum message count of a queue. You can disable the parameter by setting it to 0.