org.apache.axis2.description
Class AxisDescription

java.lang.Object
  extended byorg.apache.axis2.description.AxisDescription
All Implemented Interfaces:
DescriptionConstants, ParameterInclude
Direct Known Subclasses:
AxisBinding, AxisBindingMessage, AxisBindingOperation, AxisConfiguration, AxisEndpoint, AxisMessage, AxisOperation, AxisService, AxisServiceGroup

public abstract class AxisDescription
extends java.lang.Object
implements ParameterInclude, DescriptionConstants


Field Summary
 
Fields inherited from interface org.apache.axis2.description.DescriptionConstants
CLASSLOADER_KEY, CONTEXTPATH_KEY, EXECUTION_CHAIN_KEY, EXECUTION_FAULT_CHAIN_KEY, EXECUTION_OUT_CHAIN_KEY, IN_FAULTFLOW_KEY, INFLOW_KEY, MESSAGE_RECEIVER_KEY, MODULEREF_KEY, OPERATION_KEY, OUT_FAULTFLOW_KEY, OUTFLOW_KEY, PARAMETER_KEY, PHASES_KEY, SERVICE_CLASS_NAME, STYLE_KEY
 
Constructor Summary
AxisDescription()
           
 
Method Summary
 void addChild(AxisDescription child)
           
 void addChild(java.lang.Object key, AxisDescription child)
           
 void addParameter(Parameter param)
          Method addParameter.
 void applyPolicy()
          Applies the policies on the Description Hierarchy recursively.
 void applyPolicy(org.apache.neethi.Policy policy)
          This method sets the policy as the default of this AxisDescription instance.
 void deserializeParameters(org.apache.axiom.om.OMElement parameterElement)
           
abstract  void engageModule(AxisModule axisModule, AxisConfiguration axisConfig)
          Engaging a module to different level
 AxisConfiguration getAxisConfiguration()
           
 AxisDescription getChild(java.lang.Object key)
           
 java.util.Iterator getChildren()
           
abstract  java.lang.Object getKey()
           
 Parameter getParameter(java.lang.String name)
          Method getParameter.
 java.util.ArrayList getParameters()
          Gets all the parameters in a given description.
 java.lang.Object getParameterValue(java.lang.String name)
           
 AxisDescription getParent()
           
 PolicyInclude getPolicyInclude()
           
abstract  boolean isEngaged(java.lang.String moduleName)
           
 boolean isParameterLocked(java.lang.String parameterName)
          Checks whether the parameter is locked at any level.
 void removeChild(java.lang.Object key)
           
 void removeParameter(Parameter param)
           
 void setParent(AxisDescription parent)
           
 void setPolicyInclude(PolicyInclude policyInclude)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AxisDescription

public AxisDescription()
Method Detail

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

getParameter

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

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

getParameterValue

public java.lang.Object getParameterValue(java.lang.String name)

getParameters

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

Specified by:
getParameters in interface ParameterInclude
Returns:
Returns ArrayList.

isParameterLocked

public boolean isParameterLocked(java.lang.String parameterName)
Description copied from interface: ParameterInclude
Checks whether the parameter is locked at any level.

Specified by:
isParameterLocked in interface ParameterInclude

setParent

public void setParent(AxisDescription parent)

getParent

public AxisDescription getParent()

setPolicyInclude

public void setPolicyInclude(PolicyInclude policyInclude)

getPolicyInclude

public PolicyInclude getPolicyInclude()

addChild

public void addChild(AxisDescription child)

addChild

public void addChild(java.lang.Object key,
                     AxisDescription child)

getChildren

public java.util.Iterator getChildren()

getChild

public AxisDescription getChild(java.lang.Object key)

removeChild

public void removeChild(java.lang.Object key)

applyPolicy

public void applyPolicy(org.apache.neethi.Policy policy)
                 throws AxisFault
This method sets the policy as the default of this AxisDescription instance. Further more this method does the followings.

(1) Engage whatever modules necessary to execute new the effective policy of this AxisDescription instance. (2) Disengage whatever modules that are not necessary to execute the new effective policy of this AxisDescription instance. (3) Check whether each module can execute the new effective policy of this AxisDescription instance. (4) If not throw an AxisFault to notify the user. (5) Else notify each module about the new effective policy.

Parameters:
policy - the new policy of this AxisDescription instance. The effective policy is the merge of this argument with effective policy of parent of this AxisDescription.
Throws:
AxisFault - if any module is unable to execute the effective policy of this AxisDescription instance successfully or no module to execute some portion (one or more PrimtiveAssertions ) of that effective policy.

applyPolicy

public void applyPolicy()
                 throws AxisFault
Applies the policies on the Description Hierarchy recursively.

Throws:
AxisFault

getAxisConfiguration

public AxisConfiguration getAxisConfiguration()

getKey

public abstract java.lang.Object getKey()

engageModule

public abstract void engageModule(AxisModule axisModule,
                                  AxisConfiguration axisConfig)
                           throws AxisFault
Engaging a module to different level

Parameters:
axisModule -
axisConfig -
Throws:
AxisFault

isEngaged

public abstract boolean isEngaged(java.lang.String moduleName)


Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.