This documentation is for WSO2 Enterprise Service Bus version 4.8.1 . View documentation for the latest release.

All docs This doc
Skip to end of metadata
Go to start of metadata

The WSO2 SOA platform has the capabilities of Axis2 to add modules to extend its capabilities. The global modules will affect all the services deployed within the server.

A Module is an archive file that bundles a set of classes, related libraries and third party library dependencies. The WSO2 Carbon provides a user friendly interface to engage, disengage and configure these modules. You can learn more about Axis2 modules from the Working with Modules section.

Modules can be engaged on two levels:

  • Service level - A module will be engaged only for a certain service.
  • Global Level - A module will be engaged for all the services.


To upload your module archive, all the class files and the module.xml descriptor file have to be available in the archive.

Follow the instructions bellow to engage modules to a service.

1. Sign in. Enter your user name and password to log on to the ESB Management Console.

2. Click on "Main" in the left menu to access the "Manage" menu.

3. In the "Manage" menu, click on "List" under "Web Services."

4. The "Deployed Services" screen appears.

5. Click on the necessary service to see the "Service Dashboard" page.

6. Click "Modules" in the "Quality of Service Configuration" panel.

7. The "Engage Modules to Service" page appears.

8. Choose one of the following modules, and then click Engage to add the module to the list.

  • WSO2xfer-3.20 - Is an implementation of WS-Transfer.
  • WSO2mex-3.20 - Provides MetadataExchange services for any services that the module is engaged.
  • rampart-1.61-wso2v1 - Provides the WS-Security and WS-SecureConversation functionalities for Axis2, based on Apache WSS4J, Apache XML-Security and Apache Rahas implementations.
  • rahas-1.61-wso2v1 - Is used to STS enable a service, where it adds the RequestSecurityToken operation to a service that the module is engaged to.
  • relay-3.20 - Unwraps the binary messages coming from the Message Relay for Admin Services.
  • sandesha2-3.2 - Implements WS-ReliableMessaging for Axis2. This implements both the WSRM submitted spec and up to the version CD4 of the new WSRM 1.1 spec.

See more information about modules in Working with Modules.

  • No labels