Module com.sun.xml.ws

Package com.sun.xml.ws.model.wsdl

Class WSDLOutputImpl

java.lang.Object

com.sun.xml.ws.model.wsdl.WSDLOutputImpl

All Implemented Interfaces:

EditableWSDLOutput, WSDLExtensible, WSDLObject, WSDLOutput

public final class WSDLOutputImpl
extends Object
implements EditableWSDLOutput

Author:

Vivek Pandey

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
WSDLOutputImpl(XMLStreamReader xsr, String name, QName messageName, EditableWSDLOperation operation)

Method Summary

Modifier and Type	Method	Description
void	addExtension(WSDLExtension ex)	Adds a new WSDLExtension to this object.
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
String	getAction()	Gives the Action Message Addressing Property value for WSDLOutput message.
<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.
Locator	getLocation()	Gets the source location information in the parsed WSDL.
EditableWSDLMessage	getMessage()	Gives the WSDLMessage corresponding to wsdl:output@message This method should not be called before the entire WSDLModel is built.
String	getName()	Gives the wsdl:portType/wsdl:operation/wsdl:output@name
List<? extends AbstractExtensibleImpl.UnknownWSDLExtension>	getNotUnderstoodExtensions()	Lists extensions marked as not understood
EditableWSDLOperation	getOperation()	Gives the owning WSDLOperation
QName	getQName()	Gives qualified name of the wsdl:output 'name' attribute value.
boolean	isDefaultAction()	Checks if the Action value is implicitly derived using the rules defined in WS-Addressing.
void	setAction(String action)	Sets action
void	setDefaultAction(boolean defaultAction)	Set to true if this is the default action

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

extensions

protected final Set<WSDLExtension> extensions

notUnderstoodExtensions

protected List<AbstractExtensibleImpl.UnknownWSDLExtension> notUnderstoodExtensions

Constructor Detail

WSDLOutputImpl

public WSDLOutputImpl(XMLStreamReader xsr,
                      String name,
                      QName messageName,
                      EditableWSDLOperation operation)

Method Detail

getName

public String getName()

Description copied from interface: WSDLOutput

Gives the wsdl:portType/wsdl:operation/wsdl:output@name

Specified by:

getName in interface WSDLOutput

getMessage

public EditableWSDLMessage getMessage()

Description copied from interface: WSDLOutput

Gives the WSDLMessage corresponding to wsdl:output@message
This method should not be called before the entire WSDLModel is built. Basically after the WSDLModel is built all the references are resolve in a post processing phase. IOW, the WSDL extensions should not call this method.

Specified by:

getMessage in interface EditableWSDLOutput

Specified by:

getMessage in interface WSDLOutput

Returns:

Always returns null when called from inside WSDL extensions.

getAction

public String getAction()

Description copied from interface: WSDLOutput

Gives the Action Message Addressing Property value for WSDLOutput message.
This method provides the correct value irrespective of whether the Action is explicitly specified in the WSDL or implicitly derived using the rules defined in WS-Addressing.

Specified by:

getAction in interface WSDLOutput

Returns:

Action

isDefaultAction

public boolean isDefaultAction()

Description copied from interface: WSDLOutput

Checks if the Action value is implicitly derived using the rules defined in WS-Addressing.

Specified by:

isDefaultAction in interface WSDLOutput

Returns:

true if the Action value is implicitly derived using the rules defined in WS-Addressing.

setDefaultAction

public void setDefaultAction(boolean defaultAction)

Description copied from interface: EditableWSDLOutput

Set to true if this is the default action

Specified by:

setDefaultAction in interface EditableWSDLOutput

Parameters:

defaultAction - True, if default action

getOperation

@NotNull
public EditableWSDLOperation getOperation()

Description copied from interface: WSDLOutput

Gives the owning WSDLOperation

Specified by:

getOperation in interface EditableWSDLOutput

Specified by:

getOperation in interface WSDLOutput

getQName

@NotNull
public QName getQName()

Description copied from interface: WSDLOutput

Gives qualified name of the wsdl:output 'name' attribute value. If there is no name, then it computes the name from: wsdl:operation@name+"Response", which is local name of WSDLOperation.getName() + "Response"
The namespace uri is determined from the enclosing wsdl:operation.

Specified by:

getQName in interface WSDLOutput

setAction

public void setAction(String action)

Description copied from interface: EditableWSDLOutput

Sets action

Specified by:

setAction in interface EditableWSDLOutput

Parameters:

action - Action

freeze

public void freeze(EditableWSDLModel root)

Description copied from interface: EditableWSDLOutput

Freezes WSDL model to prevent further modification

Specified by:

freeze in interface EditableWSDLOutput

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