Engaging Modules

A module is an archive file that bundles a set of classes, related libraries and third party library dependencies. After uploading a module to the system, you can engage the module to make it active. You can engage a module on a global level as well as at service level.

To engage a module at service level

Add the engagedModules service parameter to the proxy service and specify the modules you want to engage as comma separated values. For example, if you need to engage the rampart module and the sample-logging module, add the following parameter to the proxy service:

<parameter name="engagedModules">rampart,sample-logging</parameter>

Following is a sample proxy service where the engagedModules parameter is specified to engage the sample-logging module:

 <proxy xmlns="http://ws.apache.org/ns/synapse"
      		name="Pass"
      		transports="http,https"
      		statistics="disable"
      		trace="disable"
      		startOnLoad="true">
  	<target>
     		<outSequence>
        		<send/>
     		</outSequence>
     		<endpoint>
        		<address uri="http://localhost:9000/services/SimpleStockQuoteService"/>
     		</endpoint>
  	</target>
 	<parameter name="engagedModules">sample-logging</parameter>
 	<description/>
</proxy>

To engage a module on a global level  

1. In the <EI_HOME>/conf/axis2/axis2.xml file, under the Global Engaged Modules section, add a <module ref="modulename"/> entry for every module that you want to engage on a global level.
2. Restart the server.

For example, to engage the rampart module on a global level, add the following entry and restart the server.

<module ref=“rampart"/>