org.apache.axis2.description
Class ModuleDescription

java.lang.Object
  extended byorg.apache.axis2.description.ModuleDescription
All Implemented Interfaces:
FlowInclude, ParameterInclude

public class ModuleDescription
extends java.lang.Object
implements FlowInclude, ParameterInclude

This holds the information about a Module.

  1. parameters
  2. handlers
    1. Handler are registered once they are avlible but they avalibe to all services if axis2.xml has a module ref="." or avalible to a single service if services.xml have module ref=".."


      Constructor Summary
      ModuleDescription()
                Constructor ModuleDescription
      ModuleDescription(javax.xml.namespace.QName name)
                Constructor ModuleDescription
       
      Method Summary
       void addOperation(OperationDescription operation)
                 
       void addParameter(Parameter param)
                Method addParameter
       Flow getFaultInFlow()
                Method getFaultInFlow
       Flow getFaultOutFlow()
                 
       Flow getInFlow()
                Method getInFlow
       Module getModule()
                 
       javax.xml.namespace.QName getName()
                 
       java.util.HashMap getOperations()
                 
       Flow getOutFlow()
                Method getOutFlow
       Parameter getParameter(java.lang.String name)
                Method getParameter
       java.util.ArrayList getParameters()
                To get all the parameters in a given description
       AxisConfiguration getParent()
                 
       boolean isParamterLocked(java.lang.String paramterName)
                 
       void setFaultInFlow(Flow faultFlow)
                Method setFaultInFlow
       void setFaultOutFlow(Flow faultFlow)
                Method setFaultInFlow
       void setInFlow(Flow inFlow)
                Method setInFlow
       void setModule(Module module)
                 
       void setName(javax.xml.namespace.QName name)
                 
       void setOutFlow(Flow outFlow)
                Method setOutFlow
       void setParent(AxisConfiguration parent)
                 
       
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
       

      Constructor Detail

      ModuleDescription

      public ModuleDescription()
      Constructor ModuleDescription


      ModuleDescription

      public ModuleDescription(javax.xml.namespace.QName name)
      Constructor ModuleDescription

      Parameters:
      name -
      Method Detail

      getFaultInFlow

      public Flow getFaultInFlow()
      Description copied from interface: FlowInclude
      Method getFaultInFlow

      Specified by:
      getFaultInFlow in interface FlowInclude
      Returns:

      getFaultOutFlow

      public Flow getFaultOutFlow()
      Specified by:
      getFaultOutFlow in interface FlowInclude

      getInFlow

      public Flow getInFlow()
      Description copied from interface: FlowInclude
      Method getInFlow

      Specified by:
      getInFlow in interface FlowInclude
      Returns:

      getOutFlow

      public Flow getOutFlow()
      Description copied from interface: FlowInclude
      Method getOutFlow

      Specified by:
      getOutFlow in interface FlowInclude
      Returns:

      setFaultInFlow

      public void setFaultInFlow(Flow faultFlow)
      Description copied from interface: FlowInclude
      Method setFaultInFlow

      Specified by:
      setFaultInFlow in interface FlowInclude
      Parameters:
      faultFlow -

      setFaultOutFlow

      public void setFaultOutFlow(Flow faultFlow)
      Description copied from interface: FlowInclude
      Method setFaultInFlow

      Specified by:
      setFaultOutFlow in interface FlowInclude
      Parameters:
      faultFlow -

      setInFlow

      public void setInFlow(Flow inFlow)
      Description copied from interface: FlowInclude
      Method setInFlow

      Specified by:
      setInFlow in interface FlowInclude
      Parameters:
      inFlow -

      setOutFlow

      public void setOutFlow(Flow outFlow)
      Description copied from interface: FlowInclude
      Method setOutFlow

      Specified by:
      setOutFlow in interface FlowInclude
      Parameters:
      outFlow -

      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

      getParameter

      public Parameter getParameter(java.lang.String name)
      Description copied from interface: ParameterInclude
      Method getParameter

      Specified by:
      getParameter in interface ParameterInclude
      Parameters:
      name -
      Returns:

      getParameters

      public java.util.ArrayList getParameters()
      Description copied from interface: ParameterInclude
      To get all the parameters in a given description

      Specified by:
      getParameters in interface ParameterInclude
      Returns:

      getName

      public javax.xml.namespace.QName getName()
      Returns:

      setName

      public void setName(javax.xml.namespace.QName name)
      Parameters:
      name -

      getModule

      public Module getModule()
      Returns:

      setModule

      public void setModule(Module module)
      Parameters:
      module -

      addOperation

      public void addOperation(OperationDescription operation)

      getOperations

      public java.util.HashMap getOperations()

      getParent

      public AxisConfiguration getParent()

      setParent

      public void setParent(AxisConfiguration parent)

      isParamterLocked

      public boolean isParamterLocked(java.lang.String paramterName)
      Specified by:
      isParamterLocked in interface ParameterInclude