com.sun.xml.ws.model.wsdl

Class WSDLOperationImpl

java.lang.Object

com.sun.xml.ws.model.wsdl.WSDLOperationImpl

All Implemented Interfaces:

EditableWSDLOperation, WSDLExtensible, WSDLObject, WSDLOperation

public final class WSDLOperationImpl
extends Object
implements EditableWSDLOperation

Implementaiton of WSDLOperation

Author:

Vivek Pandey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractExtensibleImpl.UnknownWSDLExtension

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<WSDLExtension>	extensions
protected Iterable<EditableWSDLMessage>	messages
protected List<AbstractExtensibleImpl.UnknownWSDLExtension>	notUnderstoodExtensions

Constructor Summary

Constructors

Constructor and Description
WSDLOperationImpl(XMLStreamReader xsr, EditableWSDLPortType owner, QName name)

Method Summary

Modifier and Type	Method and Description
void	addExtension(WSDLExtension ex) Adds a new WSDLExtension to this object.
void	addFault(EditableWSDLFault fault) Add fault
void	addNotUnderstoodExtension(QName extnEl, Locator locator) This can be used if a WSDL extension element that has wsdl:required=true is not understood
boolean	areRequiredExtensionsUnderstood() This method should be called after freezing the WSDLModel
void	freeze(EditableWSDLModel root) Freezes WSDL model to prevent further modification
<T extends WSDLExtension> T	getExtension(Class<T> type) Gets the extension that is assignable to the given type.
Iterable<WSDLExtension>	getExtensions() Gets all the WSDLExtensions added through WSDLExtensible.addExtension(WSDLExtension).
<T extends WSDLExtension> Iterable<T>	getExtensions(Class<T> type) Gets all the extensions that is assignable to the given type.
EditableWSDLFault	getFault(QName faultDetailName) Gives WSDLFault for the given soap fault detail value.
Iterable<EditableWSDLFault>	getFaults() Gets the WSDLFault corresponding to wsdl:fault of this operation.
EditableWSDLInput	getInput() Gets the wsdl:input of this operation
Locator	getLocation() Gets the source location information in the parsed WSDL.
QName	getName() Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace as the namespace uri.
List<? extends AbstractExtensibleImpl.UnknownWSDLExtension>	getNotUnderstoodExtensions() Lists extensions marked as not understood
EditableWSDLOutput	getOutput() Gets the wsdl:output of this operation.
String	getParameterOrder() Returns parameter order
QName	getPortTypeName() Gives the enclosing wsdl:portType@name attribute value.
boolean	isOneWay() Returns true if this operation is an one-way operation.
void	setInput(EditableWSDLInput input) Set input
void	setOutput(EditableWSDLOutput output) Set output
void	setParameterOrder(String parameterOrder) Set parameter order

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.xml.ws.api.model.wsdl.WSDLExtensible

addExtension, addNotUnderstoodExtension, areRequiredExtensionsUnderstood, getExtension, getExtensions, getExtensions, getNotUnderstoodExtensions

Methods inherited from interface com.sun.xml.ws.api.model.wsdl.WSDLObject

getLocation

Field Detail

messages

protected Iterable<EditableWSDLMessage> messages

extensions

protected final Set<WSDLExtension> extensions

notUnderstoodExtensions

protected List<AbstractExtensibleImpl.UnknownWSDLExtension> notUnderstoodExtensions

Constructor Detail

WSDLOperationImpl

public WSDLOperationImpl(XMLStreamReader xsr,
                         EditableWSDLPortType owner,
                         QName name)

Method Detail

getName

public QName getName()

Description copied from interface: WSDLOperation

Gets the name of the wsdl:portType/wsdl:operation@name attribute value as local name and wsdl:definitions@targetNamespace as the namespace uri.

Specified by:

getName in interface WSDLOperation

getParameterOrder

public String getParameterOrder()

Description copied from interface: WSDLOperation

Returns parameter order

Specified by:

getParameterOrder in interface WSDLOperation

Returns:

Parameter order

setParameterOrder

public void setParameterOrder(String parameterOrder)

Description copied from interface: EditableWSDLOperation

Set parameter order

Specified by:

setParameterOrder in interface EditableWSDLOperation

Parameters:

parameterOrder - Parameter order

getInput

public EditableWSDLInput getInput()

Description copied from interface: WSDLOperation

Gets the wsdl:input of this operation

Specified by:

getInput in interface EditableWSDLOperation

Specified by:

getInput in interface WSDLOperation

setInput

public void setInput(EditableWSDLInput input)

Description copied from interface: EditableWSDLOperation

Set input

Specified by:

setInput in interface EditableWSDLOperation

Parameters:

input - Input

getOutput

public EditableWSDLOutput getOutput()

Description copied from interface: WSDLOperation

Gets the wsdl:output of this operation.

Specified by:

getOutput in interface EditableWSDLOperation

Specified by:

getOutput in interface WSDLOperation

Returns:

null if this is an one-way operation.

isOneWay

public boolean isOneWay()

Description copied from interface: WSDLOperation

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

Specified by:

isOneWay in interface WSDLOperation

setOutput

public void setOutput(EditableWSDLOutput output)

Description copied from interface: EditableWSDLOperation

Set output

Specified by:

setOutput in interface EditableWSDLOperation

Parameters:

output - Output

getFaults

public Iterable<EditableWSDLFault> getFaults()

Description copied from interface: WSDLOperation

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

Specified by:

getFaults in interface EditableWSDLOperation

Specified by:

getFaults in interface WSDLOperation

getFault

public EditableWSDLFault getFault(QName faultDetailName)

Description copied from interface: WSDLOperation

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.

 

Specified by:

getFault in interface EditableWSDLOperation

Specified by:

getFault in interface WSDLOperation

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.

getPortTypeName

@NotNull
public QName getPortTypeName()

Description copied from interface: WSDLOperation

Gives the enclosing wsdl:portType@name attribute value.

Specified by:

getPortTypeName in interface WSDLOperation

addFault

public void addFault(EditableWSDLFault fault)

Description copied from interface: EditableWSDLOperation

Add fault

Specified by:

addFault in interface EditableWSDLOperation

Parameters:

fault - Fault

freeze

public void freeze(EditableWSDLModel root)

Description copied from interface: EditableWSDLOperation

Freezes WSDL model to prevent further modification

Specified by:

freeze in interface EditableWSDLOperation

Parameters:

root - WSDL Model

getExtensions

public final Iterable<WSDLExtension> getExtensions()

Description copied from interface: WSDLExtensible

Gets all the WSDLExtensions added through WSDLExtensible.addExtension(WSDLExtension).

Specified by:

getExtensions in interface WSDLExtensible

Returns:

never null.

getExtensions

public final <T extends WSDLExtension> Iterable<T> getExtensions(Class<T> type)

Description copied from interface: WSDLExtensible

Gets all the extensions that is assignable to the given type.

This allows clients to find specific extensions in a type-safe and convenient way.

Specified by:

getExtensions in interface WSDLExtensible

Parameters:

type - The type of the extension to obtain. Must not be null.

Returns:

Can be an empty fromjava.collection but never null.

getExtension

public <T extends WSDLExtension> T getExtension(Class<T> type)

Description copied from interface: WSDLExtensible

Gets the extension that is assignable to the given type.

This is just a convenient version that does

 Iterator itr = getExtensions(type);
 if(itr.hasNext())  return itr.next();
 else               return null;
 

Specified by:

getExtension in interface WSDLExtensible

Returns:

null if the extension was not found.

addExtension

public void addExtension(WSDLExtension ex)

Description copied from interface: WSDLExtensible

Adds a new WSDLExtension to this object.

Specified by:

addExtension in interface WSDLExtensible

Parameters:

ex - must not be null.

getNotUnderstoodExtensions

public List<? extends AbstractExtensibleImpl.UnknownWSDLExtension> getNotUnderstoodExtensions()

Description copied from interface: WSDLExtensible

Lists extensions marked as not understood

Specified by:

getNotUnderstoodExtensions in interface WSDLExtensible

Returns:

List of not understood extensions

addNotUnderstoodExtension

public void addNotUnderstoodExtension(QName extnEl,
                                      Locator locator)

This can be used if a WSDL extension element that has wsdl:required=true is not understood

Specified by:

addNotUnderstoodExtension in interface WSDLExtensible

Parameters:

extnEl -

locator -

areRequiredExtensionsUnderstood

public boolean areRequiredExtensionsUnderstood()

This method should be called after freezing the WSDLModel

Specified by:

areRequiredExtensionsUnderstood in interface WSDLExtensible

Returns:

true if all wsdl required extensions on Port and Binding are understood

getLocation

@NotNull
public final Locator getLocation()

Description copied from interface: WSDLObject

Gets the source location information in the parsed WSDL. This is useful when producing error messages.

Specified by:

getLocation in interface WSDLObject