org.apache.axis2.modules
Interface Module
- All Known Implementing Classes:
- SecurityModule, SOAPMonitorModule
- public interface Module
Every module provides an implementation of this class. Modules are in one of
three states: "available" and "initialized". All modules that the runtime
detects (from the system modules/ directory or from other means) are said to
be in the "available" state. If some service indicates a dependency on this
module then the module is initialized (once for the life of the system) and
the state changes to "initialized".
Any module which is in the "initialized" state can be engaged as needed
by the engine to respond to a message. Currently module engagement is done
via deployment (using module.xml). In the future we may engage modules
programmatically by introducing an engage() method to this interface, thereby
allowing more dynamic scenarios.
init
public void init(ConfigurationContext configContext,
AxisModule module)
throws AxisFault
- Throws:
AxisFault
engageNotify
public void engageNotify(AxisDescription axisDescription)
throws AxisFault
- When engaging this module to some service or operation , module will be notify by calling this
method there module author can validate , add policy and do any thing that he want , and he can
refuce the engage as well
- Parameters:
axisDescription
-
- Throws:
AxisFault
shutdown
public void shutdown(ConfigurationContext configurationContext)
throws AxisFault
- Throws:
AxisFault