Save This Page
Home » axis2-1.5-src » org.apache » axis2 » description » [javadoc | source]
org.apache.axis2.description
abstract public class: AxisDescription [javadoc | source]
java.lang.Object
   org.apache.axis2.description.AxisDescription

All Implemented Interfaces:
    ParameterInclude, DescriptionConstants

Direct Known Subclasses:
    AxisOperation, AxisConfiguration, InOnlyAxisOperation, AxisService, OutInAxisOperation, AxisBinding, AxisMessage, InOutAxisOperation, AxisBindingOperation, AxisServiceGroup, AxisBindingMessage, TwoChannelAxisOperation, AxisEndpoint, RobustOutOnlyAxisOperation, OutOnlyAxisOperation

Field Summary
protected  AxisDescription parent     
protected  Map engagedModules     
protected  List parameterObservers    List of ParameterObservers who want to be notified of changes 
static  Collection NULL_MODULES     
Constructor:
 public AxisDescription() 
Method from org.apache.axis2.description.AxisDescription Summary:
addChild,   addChild,   addParameter,   addParameter,   addParameterObserver,   applyPolicy,   applyPolicy,   deserializeParameters,   disengageModule,   engageModule,   engageModule,   getAxisConfiguration,   getChild,   getChildren,   getDocumentation,   getDocumentationNode,   getEngagedModules,   getKey,   getParameter,   getParameterValue,   getParameters,   getParent,   getPolicyInclude,   getPolicySubject,   isEngaged,   isEngaged,   isParameterLocked,   isParameterTrue,   onDisengage,   onEngage,   removeChild,   removeParameter,   removeParameterObserver,   setDocumentation,   setDocumentation,   setParent,   setPolicyInclude
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.axis2.description.AxisDescription Detail:
 public  void addChild(AxisDescription child) 
 public  void addChild(Object key,
    AxisDescription child) 
 public  void addParameter(Parameter param) throws AxisFault 
 public  void addParameter(String name,
    Object value) throws AxisFault 
 public  void addParameterObserver(ParameterObserver observer) 
 public  void applyPolicy() throws AxisFault 
    Applies the policies on the Description Hierarchy recursively.
 public  void applyPolicy(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.

 public  void deserializeParameters(OMElement parameterElement) throws AxisFault 
 public  void disengageModule(AxisModule module) throws AxisFault 
 public  void engageModule(AxisModule axisModule) throws AxisFault 
    Engage a Module at this level
 public  void engageModule(AxisModule axisModule,
    AxisDescription source) throws AxisFault 
    Engage a Module at this level, keeping track of which level the engage was originally called from. This is meant for internal use only.
 public AxisConfiguration getAxisConfiguration() 
 public AxisDescription getChild(Object key) 
 public Iterator getChildren() 
 public String getDocumentation() 
 public OMNode getDocumentationNode() 
 public Collection getEngagedModules() 
 abstract public Object getKey()
 public Parameter getParameter(String name) 
    If the parameter is found in the current description then the Parameter will be writable else it will be read only
 public Object getParameterValue(String name) 
 public ArrayList getParameters() 
 public AxisDescription getParent() 
 public PolicyInclude getPolicyInclude() 
Deprecated! As - of release 1.4, replaced by #getPolicySubject()

 public PolicySubject getPolicySubject() 
 public boolean isEngaged(String moduleName) 
    Check if a given module is engaged at this level.
 public boolean isEngaged(AxisModule axisModule) 
 public boolean isParameterLocked(String parameterName) 
 public boolean isParameterTrue(String name) 
 protected  void onDisengage(AxisModule module) throws AxisFault 
 protected  void onEngage(AxisModule module,
    AxisDescription engager) throws AxisFault 
 public  void removeChild(Object key) 
 public  void removeParameter(Parameter param) throws AxisFault 
 public  void removeParameterObserver(ParameterObserver observer) 
 public  void setDocumentation(OMNode documentation) 
 public  void setDocumentation(String documentation) 
 public  void setParent(AxisDescription parent) 
 public  void setPolicyInclude(PolicyInclude policyInclude) 
Deprecated! As - of release 1.4, if you want to access the policy cache of a particular AxisDescription object use #getPolicySubject() instead.