Global Configurations - User Guide

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.

Note: If you want to engage the modules through a service, in the navigator, under Modules, click List. On the Deployed Modules page, you can select the modules you want to engage.

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_4_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

Adding modules

Figure 1: Uploading a module achieve file.

  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.
  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 each module

    • 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 panel of these modules.
    • Engage: If the module is not already engaged, use this option to engage the module.
    • Delete: Delete the module

      Global Configuration UI before engaging a module

      Global UI before engaging any thing

      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

      Globally engaging throttling

      Figure 3: Throttle Configuration

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

      The icon in front of an already engaged module, will have a red mark to indicate that it can be disengaged or reconfigured by clicking on that icon.

      Global Configuration UI after engaging a module

      Global UI after engaging a module

      Figure 4: After Engaging a Module