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

java.lang.Object
  extended by com.sun.xml.ws.model.wsdl.WSDLOutputImpl
All Implemented Interfaces:
WSDLExtensible, WSDLObject, WSDLOutput

public final class WSDLOutputImpl
extends java.lang.Object
implements WSDLOutput


Nested Class Summary
protected static class AbstractExtensibleImpl.UnknownWSDLExtension
           
 
Field Summary
protected  java.util.Set<WSDLExtension> extensions
           
protected  java.util.List<AbstractExtensibleImpl.UnknownWSDLExtension> notUnderstoodExtensions
           
 
Constructor Summary
WSDLOutputImpl(javax.xml.stream.XMLStreamReader xsr, java.lang.String name, javax.xml.namespace.QName messageName, WSDLOperationImpl operation)
           
 
Method Summary
 void addExtension(WSDLExtension ex)
          Adds a new WSDLExtension to this object.
 void addNotUnderstoodExtension(javax.xml.namespace.QName extnEl, org.xml.sax.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
 java.lang.String getAction()
          Gives the Action Message Addressing Property value for WSDLOutput message.
<T extends WSDLExtension>
T
getExtension(java.lang.Class<T> type)
          Gets the extension that is assignable to the given type.
 java.lang.Iterable<WSDLExtension> getExtensions()
          Gets all the WSDLExtensions added through WSDLExtensible.addExtension(WSDLExtension).
<T extends WSDLExtension>
java.lang.Iterable<T>
getExtensions(java.lang.Class<T> type)
          Gets all the extensions that is assignable to the given type.
 org.xml.sax.Locator getLocation()
          Gets the source location information in the parsed WSDL.
 WSDLMessage getMessage()
          Gives the WSDLMessage corresponding to wsdl:output@message

This method should not be called before the entire WSDLModel is built.

 java.lang.String getName()
          Gives the wsdl:portType/wsdl:operation/wsdl:output@name
 WSDLOperation getOperation()
          Gives the owning WSDLOperation
 javax.xml.namespace.QName getQName()
          Gives qualified name of the wsdl:output 'name' attribute value.
 boolean isDefaultAction()
           
 void setAction(java.lang.String action)
           
 void setDefaultAction(boolean defaultAction)
           
 
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, getExtension, getExtensions, getExtensions
 
Methods inherited from interface com.sun.xml.ws.api.model.wsdl.WSDLObject
getLocation
 

Field Detail

extensions

protected final java.util.Set<WSDLExtension> extensions

notUnderstoodExtensions

protected java.util.List<AbstractExtensibleImpl.UnknownWSDLExtension> notUnderstoodExtensions
Constructor Detail

WSDLOutputImpl

public WSDLOutputImpl(javax.xml.stream.XMLStreamReader xsr,
                      java.lang.String name,
                      javax.xml.namespace.QName messageName,
                      WSDLOperationImpl operation)
Method Detail

getName

public java.lang.String getName()
Description copied from interface: WSDLOutput
Gives the wsdl:portType/wsdl:operation/wsdl:output@name

Specified by:
getName in interface WSDLOutput

getMessage

public WSDLMessage 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 WSDLOutput
Returns:
Always returns null when called from inside WSDL extensions.

getAction

public java.lang.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()

setDefaultAction

public void setDefaultAction(boolean defaultAction)

getOperation

@NotNull
public WSDLOperation getOperation()
Description copied from interface: WSDLOutput
Gives the owning WSDLOperation

Specified by:
getOperation in interface WSDLOutput

getQName

@NotNull
public javax.xml.namespace.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(java.lang.String action)

getExtensions

public final java.lang.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> java.lang.Iterable<T> getExtensions(java.lang.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(java.lang.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.

addNotUnderstoodExtension

public void addNotUnderstoodExtension(javax.xml.namespace.QName extnEl,
                                      org.xml.sax.Locator locator)
This can be used if a WSDL extension element that has wsdl:required=true is not understood

Parameters:
extnEl -
locator -

areRequiredExtensionsUnderstood

public boolean areRequiredExtensionsUnderstood()
This method should be called after freezing the WSDLModel

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

getLocation

@NotNull
public final org.xml.sax.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


Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.