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.
This documentation is for WSO2 Message Broker version 3.2.0. For the latest documentation, see the documentation for WSO2 Enterprise Integrator.

Versions Compared


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

Prior to installing any WSO2 Carbon based product, it is necessary to have the appropriate prerequisite software installed on your system. Verify that the computer has the supported operating system and development platforms before starting the installation.

System requirements


  • ~ 2 GB minimum
  • ~ 512 MB heap size. This is generally sufficient to process typical JMS messages but the requirements vary with larger message sizes and the number of messages processed concurrently.


  • Disk space (for the database being used) will vary according to your requirements as messages are stored in the database.

Environment compatibility

Operating Systems / Databases

  • All WSO2 Carbon-based products are Java applications that can be run on any platform that is Oracle/IBM JDK 7/8 compliant. Also, we do not recommend or support OpenJDK. See the section on compatibility of WSO2 products for more information. 


    If you are using IBM JDK, the default configurations in the product has to be changed as follows:

      • Open the Owasp.CsrfGuard.Carbon.properties file (stored in the <MB_HOME>/repository/conf/security directory) and change the org.owasp.csrfguard.PRNG.Provider property to IBMJCE as shown below.

        Code Block
      • Open the broker.xml file (stored in the <MB_HOME>/repository/conf directory) and set the <certType> property to IbmX509 as shown below.

        Code Block
  • All WSO2 Carbon-based products are generally compatible with most common DBMSs. For more information, see Working with Databases.
  • It is not recommended to use Apache DS in a production environment due to issues with scalability. Instead, it is recommended to use an LDAP like OpenLDAP for user management.
  • For environments that WSO2 products are tested with, see Compatibility of WSO2 Products.
  • If you have difficulty in setting up any WSO2 product in a specific platform or database, please contact us.

Required applications

The following applications are required for running the Message Broker and its samples or for building from the source code. Mandatory installs are marked with an asterisk *.




Download Links

Oracle Java SE Development Kit (JDK)*

  • To launch the product as each product is a Java application.
  • To build the product from the source distribution (both JDK and Apache Maven are required).
  • To run Apache Ant.

JDK 7 or 8.


Do not use JDK1.8.0_151 due to a known issue. This issue is fixed in JDK 1.8.0_162-ea. However, use JDK 1.8.0_144 until the latter mentioned version is released.


Apache Ant

  • To compile and run the product samples.

1.7.0 or later



Apache Maven

  • To build the product from the source distribution (both JDK and Apache Maven are required). If you are installing by downloading and extracting the binary distribution instead of building from the source code, you do not need to install Maven.


Web Browser

  • To access the product's Management Console. The Web Browser must be JavaScript enabled to take full advantage of the Management console.

On Windows Server 2003, you must not go below the medium security level in Internet Explorer 6.x.