Class AxisDescription

    • Constructor Detail

      • AxisDescription

        public AxisDescription()
    • Method Detail

      • addParameterObserver

        public void addParameterObserver​(ParameterObserver observer)
      • removeParameterObserver

        public void removeParameterObserver​(ParameterObserver observer)
      • getParameter

        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
        Specified by:
        getParameter in interface ParameterInclude
        Parameters:
        name - name of Parameter to retrieve
        Returns:
        the Parameter, if found anywhere in the stack, or null if not
      • getParameterValue

        public Object getParameterValue​(String name)
      • isParameterTrue

        public boolean isParameterTrue​(String name)
      • getDocumentation

        public String getDocumentation()
      • getDocumentationNode

        public OMNode getDocumentationNode()
      • setDocumentation

        public void setDocumentation​(OMNode documentation)
      • setDocumentation

        public void setDocumentation​(String documentation)
      • setPolicyInclude

        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.
        Parameters:
        policyInclude - PolicyInclude value
        See Also:
        setPolicyInclude(PolicyInclude)
      • removeChild

        public void removeChild​(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 - an error occurred applying the policy
      • getKey

        public abstract Object getKey()
      • engageModule

        public void engageModule​(AxisModule axisModule)
                          throws AxisFault
        Engage a Module at this level
        Parameters:
        axisModule - the Module to engage
        Throws:
        AxisFault - if there's a problem engaging
      • engageModule

        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.
        Parameters:
        axisModule - module to engage
        source - the AxisDescription which originally called engageModule()
        Throws:
        AxisFault - if there's a problem engaging
      • isEngaged

        public boolean isEngaged​(String moduleName)
        Check if a given module is engaged at this level.
        Parameters:
        moduleName - module to investigate.
        Returns:
        true if engaged, false if not. TODO: Handle versions? isEngaged("addressing") should be true even for versioned modulename...
      • isEngaged

        public boolean isEngaged​(AxisModule axisModule)