org.jvnet.wom.api
Class WSDLOperation

java.lang.Object
  org.jvnet.wom.api.WSDLEntity
      org.jvnet.wom.api.WSDLOperation

All Implemented Interfaces:

WSDLExtensible

Direct Known Subclasses:

WSDLOperationImpl

public abstract class WSDLOperation
extends WSDLEntity

Provides abstraction of wsdl:portType/wsdl:operation.

Author:

Vivek Pandey

Constructor Summary

protected

WSDLOperation(org.xml.sax.Locator locator, javax.xml.namespace.QName name)

Method Summary

abstract WSDLFault	getFault(javax.xml.namespace.QName faultDetailName) Gives WSDLFault for the given soap fault detail value.
abstract java.lang.Iterable<? extends WSDLFault>	getFaults() Gets the WSDLFault corresponding to wsdl:fault of this operation.
abstract WSDLInput	getInput() Gets the wsdl:input of this operation
abstract WSDLOutput	getOutput() Gets the wsdl:output of this operation.
abstract java.util.List<java.lang.String>	getParameterOrder() Gives parameterOrder attribute defined on wsdl:operation.
abstract WSDLPortType	getPortType() Gives enclosing wsdl:portType
abstract boolean	isOneWay() Returns true if this operation is an one-way operation.

Methods inherited from class org.jvnet.wom.api.WSDLEntity

addExtension, getDocumentation, getExtension, getExtensions, getFirstExtension, getLocation, getName, getOwnerWSDLModel, getWSDLDocument, setOwnerWSDLDocument, visit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WSDLOperation

protected WSDLOperation(org.xml.sax.Locator locator,
                        javax.xml.namespace.QName name)

Method Detail

getInput

public abstract WSDLInput getInput()

Gets the wsdl:input of this operation

Returns:

non-null WSDLInput

getOutput

public abstract WSDLOutput getOutput()

Gets the wsdl:output of this operation.

Returns:

null if this is an one-way operation.

isOneWay

public abstract boolean isOneWay()

Returns true if this operation is an one-way operation.

getFaults

public abstract java.lang.Iterable<? extends WSDLFault> getFaults()

Gets the WSDLFault corresponding to wsdl:fault of this operation.

getFault

public abstract WSDLFault getFault(javax.xml.namespace.QName faultDetailName)

Gives WSDLFault for the given soap fault detail value.

 

 Given a wsdl fault:
 

 <wsdl:message nae="faultMessage">
  <wsdl:part name="fault" element="ns:myException/>
 </wsdl:message>
 

 <wsdl:portType>
  <wsdl:operation ...>
      <wsdl:fault name="aFault" message="faultMessage"/>
  </wsdl:operation>
 <wsdl:portType>
 

 

 For example given a soap 11 soap message:
 

 <soapenv:Fault>
      ...
      <soapenv:detail>
          <ns:myException>
              ...
          </ns:myException>
      </soapenv:detail>
 

 QName faultQName = new QName(ns, "myException");
 WSDLFault wsdlFault  = getFault(faultQName);
 

 The above call will return a WSDLFault that abstracts wsdl:portType/wsdl:operation/wsdl:fault.
 

 

Parameters:

faultDetailName - tag name of the element inside soaenv:Fault/detail/, must be non-null.

Returns:

returns null if a wsdl fault corresponding to the detail entry name not found.

getPortType

public abstract WSDLPortType getPortType()

Gives enclosing wsdl:portType

Returns:

always non-null

getParameterOrder

public abstract java.util.List<java.lang.String> getParameterOrder()

Gives parameterOrder attribute defined on wsdl:operation. The returned List is read only.