org.apache.axis2.description
Class AxisModule

java.lang.Object
  org.apache.axis2.description.AxisModule

All Implemented Interfaces:

ParameterInclude

public class AxisModule
extends Object
implements ParameterInclude

This holds the information about a Module.

1. parameters
3. handlers

4. Handler are registered once they are available. They are available to all services if axis2.xml has a module ref="." or available to a single service if services.xml have module ref=".."

   Constructor Summary

   AxisModule()
   Constructor ModuleDescription.

   AxisModule(String name)
   Constructor ModuleDescription.

   Method Summary

   void	addOperation(AxisOperation axisOperation)
   void	addParameter(Parameter param) Method addParameter.
   void	deserializeParameters(org.apache.axiom.om.OMElement parameterElement)
   Flow	getFaultInFlow()
   Flow	getFaultOutFlow()
   URL	getFileName()
   Flow	getInFlow()
   QName[]	getLocalPolicyAssertions()
   Module	getModule()
   ClassLoader	getModuleClassLoader()
   String	getModuleDescription()
   String	getName() Get the name of this Module
   HashMap	getOperations()
   Flow	getOutFlow()
   Parameter	getParameter(String name) Method getParameter.
   ArrayList	getParameters() Gets all the parameters in a given description.
   AxisConfiguration	getParent()
   PolicyInclude	getPolicyInclude()
   String[]	getSupportedPolicyNamespaces()
   boolean	isParameterLocked(String parameterName) Checks whether the parameter is locked at any level.
   void	removeParameter(Parameter param)
   void	setFaultInFlow(Flow faultFlow)
   void	setFaultOutFlow(Flow faultFlow)
   void	setFileName(URL fileName)
   void	setInFlow(Flow inFlow)
   void	setLocalPolicyAssertions(QName[] localPolicyAssertions)
   void	setModule(Module module)
   void	setModuleClassLoader(ClassLoader moduleClassLoader)
   void	setModuleDescription(String moduleDescription)
   void	setName(String name)
   void	setOutFlow(Flow outFlow)
   void	setParent(AxisConfiguration parent)
   void	setPolicyInclude(PolicyInclude policyInclude)
   void	setSupportedPolicyNamespaces(String[] supportedPolicyNamespaces)

   Methods inherited from class java.lang.Object

   clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

   Constructor Detail

   AxisModule

   public AxisModule()

   Constructor ModuleDescription.

   AxisModule

   public AxisModule(String name)

   Constructor ModuleDescription.

   Parameters:

   name -

   Method Detail

   addOperation

   public void addOperation(AxisOperation axisOperation)

   addParameter

   public void addParameter(Parameter param)
                     throws AxisFault

   Description copied from interface: ParameterInclude

   Method addParameter.

   Specified by:

   addParameter in interface ParameterInclude

   Parameters:

   param -

   Throws:

   AxisFault

   removeParameter

   public void removeParameter(Parameter param)
                        throws AxisFault

   Specified by:

   removeParameter in interface ParameterInclude

   Throws:

   AxisFault

   deserializeParameters

   public void deserializeParameters(org.apache.axiom.om.OMElement parameterElement)
                              throws AxisFault

   Specified by:

   deserializeParameters in interface ParameterInclude

   Throws:

   AxisFault

   getFaultInFlow

   public Flow getFaultInFlow()

   Returns:

   Returns Flow.

   getFaultOutFlow

   public Flow getFaultOutFlow()

   getInFlow

   public Flow getInFlow()

   Returns:

   Returns Flow.

   getModule

   public Module getModule()

   Returns:

   Returns Module.

   getModuleClassLoader

   public ClassLoader getModuleClassLoader()

   getName

   public String getName()

   Get the name of this Module

   Returns:

   a String name.

   getOperations

   public HashMap getOperations()

   getOutFlow

   public Flow getOutFlow()

   Returns:

   Returns Flow.

   getParameter

   public Parameter getParameter(String name)

   Description copied from interface: ParameterInclude

   Method getParameter.

   Specified by:

   getParameter in interface ParameterInclude

   Parameters:

   name -

   Returns:

   Returns Parameter.

   getParameters

   public ArrayList getParameters()

   Description copied from interface: ParameterInclude

   Gets all the parameters in a given description.

   Specified by:

   getParameters in interface ParameterInclude

   Returns:

   Returns ArrayList.

   getParent

   public AxisConfiguration getParent()

   isParameterLocked

   public boolean isParameterLocked(String parameterName)

   Description copied from interface: ParameterInclude

   Checks whether the parameter is locked at any level.

   Specified by:

   isParameterLocked in interface ParameterInclude

   setFaultInFlow

   public void setFaultInFlow(Flow faultFlow)

   Parameters:

   faultFlow -

   setFaultOutFlow

   public void setFaultOutFlow(Flow faultFlow)

   Parameters:

   faultFlow -

   setInFlow

   public void setInFlow(Flow inFlow)

   Parameters:

   inFlow -

   setModule

   public void setModule(Module module)

   Parameters:

   module -

   setModuleClassLoader

   public void setModuleClassLoader(ClassLoader moduleClassLoader)

   setName

   public void setName(String name)

   Parameters:

   name -

   setOutFlow

   public void setOutFlow(Flow outFlow)

   Parameters:

   outFlow -

   setParent

   public void setParent(AxisConfiguration parent)

   setPolicyInclude

   public void setPolicyInclude(PolicyInclude policyInclude)

   getPolicyInclude

   public PolicyInclude getPolicyInclude()

   getModuleDescription

   public String getModuleDescription()

   setModuleDescription

   public void setModuleDescription(String moduleDescription)

   getSupportedPolicyNamespaces

   public String[] getSupportedPolicyNamespaces()

   setSupportedPolicyNamespaces

   public void setSupportedPolicyNamespaces(String[] supportedPolicyNamespaces)

   getLocalPolicyAssertions

   public QName[] getLocalPolicyAssertions()

   setLocalPolicyAssertions

   public void setLocalPolicyAssertions(QName[] localPolicyAssertions)

   getFileName

   public URL getFileName()

   setFileName

   public void setFileName(URL fileName)