Package org.apache.axis2.description

Class HandlerDescription

java.lang.Object
org.apache.axis2.description.HandlerDescription
All Implemented Interfaces:
ParameterInclude
public class HandlerDescription extends Object implements ParameterInclude
Represents the deployment information about the handler

  • Constructor Details

    • HandlerDescription

      public HandlerDescription()
      Constructor HandlerDescription.

    • HandlerDescription

      public HandlerDescription(String name)
      Constructor HandlerDescription.
      Parameters:
      name - name of handler

  • Method Details

    • addParameter

      public void addParameter(Parameter param) throws AxisFault
      Add a Parameter
      Specified by:
      addParameter in interface ParameterInclude
      Parameters:
      param - the Parameter to associate with this HandlerDescription
      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

    • getClassName

      public String getClassName()
      Method getClassName.
      Returns:
      Returns String.

    • getHandler

      public Handler getHandler()
      Returns:
      Returns Handler.

    • getName

      public String getName()
      Returns:
      Returns QName.

    • getParameter

      public Parameter getParameter(String name)
      Get a named Parameter
      Specified by:
      getParameter in interface ParameterInclude
      Parameters:
      name - name of Parameter to search
      Returns:
      a Parameter, which may come from us or from some parent up the tree, or null.

    • getParameters

      public ArrayList<Parameter> 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 ParameterInclude getParent()

    • getRules

      public PhaseRule getRules()
      Method getRules.
      Returns:
      Returns PhaseRule.

    • 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

    • setClassName

      public void setClassName(String className)
      Method setClassName.
      Parameters:
      className - the class name of the Handler class

    • setHandler

      public void setHandler(Handler handler)
      Explicitly set the Handler object
      Parameters:
      handler - a Handler instance, which will be deployed wherever this HandlerDescription is

    • setName

      public void setName(String name)
      Set the name
      Parameters:
      name - the desired name

    • setParent

      public void setParent(ParameterInclude parent)

    • setRules

      public void setRules(PhaseRule rules)
      Set the deployment rules for this HandlerDescription
      Parameters:
      rules - a PhaseRule object