Global Module Configurations

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. If you want to globally engage a particular module, click Manage > Modules > List. On the Deployed Modules page, you can globally engage any listed module.

Deploying Module Archives (.mar)

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 Axis2 manuals at: http://ws.apache.org/axis2/1_5_1/modules.html

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

The folder structure of the module archive file will look as follows.

    Test.mar
        - META-INF
            - module.xml
    TestModule.class
    TestHandler.class

Figure 1: Uploading module archive files.

1. In the navigator under Manage > Modules, click Add. The Add a Module page appears.
2. Click Browse to select the module archive file (.mar) you want to upload. Multiple (.mar) archives can be uploaded by clicking on the "+" button.
3. Click Upload. If the file was uploaded successfully, a message will appear prompting you to restart the server to activate the module.
4. Click OK.

Once the server has been restarted, the module will be active and displayed on the Deployed Modules page. You can engage, disengage or delete the module as required.

Listing of Globally Engaged Modules

The WSO2 Carbon management console provides you with an interface to engage, disengage, configure or delete available modules.

The module list contains the following entries for each module.

• Name
• Version
• Description
• Actions

You can perform the following actions on engaged modules

• Disengage: If the module is already engaged, you can disengage the module.
• Configure: Some modules can be configured. Use this option to access the configuration page of these modules.
• Engage: If the module is not already engaged, use this option to engage the module.
• Delete: Delete the module

Global Modules UI before engaging any module

Figure 2: Available modules

All the available modules are shown above the currently engaged modules. The WS-Addressing module is always globally engaged. This list will be updated when you engage other available modules.

For example, the Throttle module is available to be configured globally. Once you click the Configure icon, a new page appears with the configuring options available for that module.

Throttle Global Configuration UI

Figure 3: Throttle Configuration

After you have engaged a module (for example, throttling), the Global Configurations page will be updated. (Figure: 4)

There are some modules (for example, savan), doesn't have a global configuration page. But those can be globally engaged, just by clicking on the Engage action and can be disengaged by clicking on the Disengage action.

Global Configuration UI after engaging modules

Figure 4: After Engaging Modules