Class OperationDesc

  • All Implemented Interfaces:
    java.io.Serializable

    public class OperationDesc
    extends java.lang.Object
    implements java.io.Serializable
    An OperationDesc is an abstract description of an operation on a service. !!! WORK IN PROGRESS
    Author:
    Glen Daniels (gdaniels@apache.org)
    See Also:
    Serialized Form
    • Field Detail

      • MSG_METHOD_SOAPENVELOPE

        public static final int MSG_METHOD_SOAPENVELOPE
        See Also:
        Constant Field Values
      • MSG_METHOD_ELEMENTARRAY

        public static final int MSG_METHOD_ELEMENTARRAY
        See Also:
        Constant Field Values
      • MSG_METHOD_NONCONFORMING

        public static final int MSG_METHOD_NONCONFORMING
        See Also:
        Constant Field Values
      • mepStrings

        public static java.util.Map mepStrings
      • log

        protected static org.apache.commons.logging.Log log
    • Constructor Detail

      • OperationDesc

        public OperationDesc()
        Default constructor.
      • OperationDesc

        public OperationDesc​(java.lang.String name,
                             ParameterDesc[] parameters,
                             QName returnQName)
        "Complete" constructor
    • Method Detail

      • getName

        public java.lang.String getName()
        Return the operation's name
      • setName

        public void setName​(java.lang.String name)
        Set the operation's name
      • getDocumentation

        public java.lang.String getDocumentation()
        get the documentation for the operation
      • setDocumentation

        public void setDocumentation​(java.lang.String documentation)
        set the documentation for the operation
      • getReturnQName

        public QName getReturnQName()
      • setReturnQName

        public void setReturnQName​(QName returnQName)
      • getReturnType

        public QName getReturnType()
      • setReturnType

        public void setReturnType​(QName returnType)
      • getReturnClass

        public java.lang.Class getReturnClass()
      • setReturnClass

        public void setReturnClass​(java.lang.Class returnClass)
      • getElementQName

        public QName getElementQName()
      • setElementQName

        public void setElementQName​(QName elementQName)
      • setParent

        public void setParent​(ServiceDesc parent)
      • getSoapAction

        public java.lang.String getSoapAction()
      • setSoapAction

        public void setSoapAction​(java.lang.String soapAction)
      • setStyle

        public void setStyle​(Style style)
      • getStyle

        public Style getStyle()
        Return the style of the operation, defaulting to the parent ServiceDesc's style if we don't have one explicitly set.
      • setUse

        public void setUse​(Use use)
      • getUse

        public Use getUse()
        Return the use of the operation, defaulting to the parent ServiceDesc's use if we don't have one explicitly set.
      • addParameter

        public void addParameter​(ParameterDesc param)
      • addParameter

        public void addParameter​(QName paramName,
                                 QName xmlType,
                                 java.lang.Class javaType,
                                 byte parameterMode,
                                 boolean inHeader,
                                 boolean outHeader)
      • getParameters

        public java.util.ArrayList getParameters()
      • setParameters

        public void setParameters​(java.util.ArrayList newParameters)
        Set the parameters wholesale.
        Parameters:
        newParameters - an ArrayList of ParameterDescs
      • getNumInParams

        public int getNumInParams()
      • getNumOutParams

        public int getNumOutParams()
      • getNumParams

        public int getNumParams()
      • getMethod

        public java.lang.reflect.Method getMethod()
      • setMethod

        public void setMethod​(java.lang.reflect.Method method)
      • isReturnHeader

        public boolean isReturnHeader()
        Is the return value in the header of the response message?
      • setReturnHeader

        public void setReturnHeader​(boolean value)
        Set whether the return value is in the response message.
      • getAllInParams

        public java.util.ArrayList getAllInParams()
        Return a list of ALL "in" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
        Returns:
      • getAllOutParams

        public java.util.ArrayList getAllOutParams()
        Return a list of ALL "out" params (including INOUTs) Note: if we were sure the order went IN->INOUT->OUT, we could optimize this.
        Returns:
      • getOutParams

        public java.util.ArrayList getOutParams()
        Returns an ordered list of out params (NOT inouts)
      • addFault

        public void addFault​(FaultDesc fault)
      • getFaults

        public java.util.ArrayList getFaults()
      • getFaultByClass

        public FaultDesc getFaultByClass​(java.lang.Class cls)
        Returns the FaultDesc for the fault class given. Returns null if not found.
      • getFaultByClass

        public FaultDesc getFaultByClass​(java.lang.Class cls,
                                         boolean checkParents)
        Returns the FaultDesc for the fault class given. Returns null if not found.
      • getFaultByQName

        public FaultDesc getFaultByQName​(QName qname)
        Returns the FaultDesc for a QName (which is typically found in the details element of a SOAP fault). Returns null if not found.
      • getFaultByXmlType

        public FaultDesc getFaultByXmlType​(QName xmlType)
        Returns the FaultDesc for an XMLType. Returns null if not found.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • toString

        public java.lang.String toString​(java.lang.String indent)
      • getMessageOperationStyle

        public int getMessageOperationStyle()
      • setMessageOperationStyle

        public void setMessageOperationStyle​(int messageOperationStyle)
      • getMep

        public javax.wsdl.OperationType getMep()
      • setMep

        public void setMep​(javax.wsdl.OperationType mep)
      • setMep

        public void setMep​(java.lang.String mepString)
        Set the MEP using a string like "request-response"
        Parameters:
        mepString -