com.ibm.wsdl.xml

Class WSDLReaderImpl

java.lang.Object

com.ibm.wsdl.xml.WSDLReaderImpl

All Implemented Interfaces:

WSDLReader

public class WSDLReaderImpl
extends Object
implements WSDLReader

This class describes a collection of methods that enable conversion of a WSDL document (in XML, following the WSDL schema described in the WSDL specification) into a WSDL model.

Author:

Matthew J. Duftler, Nirmal Mukhi

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	allSchemas
protected ExtensionRegistry	extReg
protected WSDLFactory	factory
protected String	factoryImplName
protected boolean	importDocuments
protected WSDLLocator	loc
protected boolean	parseSchema
protected boolean	verbose

Constructor Summary

Constructors

Constructor and Description
WSDLReaderImpl()

Method Summary

Modifier and Type	Method and Description
ExtensionRegistry	getExtensionRegistry() Get the extension registry, if one was set.
String	getFactoryImplName() Get the factoryImplName, if one was set.
boolean	getFeature(String name) Gets the value of the specified feature.
protected WSDLFactory	getWSDLFactory() Get the WSDLFactory object cached in the reader, or use lazy instantiation if it is not cached yet.
protected Binding	parseBinding(Element bindingEl, Definition def)
protected BindingFault	parseBindingFault(Element bindingFaultEl, Definition def)
protected BindingInput	parseBindingInput(Element bindingInputEl, Definition def)
protected BindingOperation	parseBindingOperation(Element bindingOperationEl, PortType portType, Definition def)
protected BindingOutput	parseBindingOutput(Element bindingOutputEl, Definition def)
protected Definition	parseDefinitions(String documentBaseURI, Element defEl, Map importedDefs)
protected Object	parseExtensibilityAttribute(Element el, int attrType, String attrValue, Definition def)
protected void	parseExtensibilityAttributes(Element el, Class parentType, AttributeExtensible attrExt, Definition def)
protected ExtensibilityElement	parseExtensibilityElement(Class parentType, Element el, Definition def)
protected ExtensibilityElement	parseExtensibilityElementAsDefaultExtensiblityElement(Class parentType, Element el, Definition def) Parse the element using the ExtensionRegistry default deserializer instead using the one registered.
protected Fault	parseFault(Element faultEl, Definition def)
protected Import	parseImport(Element importEl, Definition def, Map importedDefs)
protected Input	parseInput(Element inputEl, Definition def)
protected Message	parseMessage(Element msgEl, Definition def)
protected Operation	parseOperation(Element opEl, PortType portType, Definition def)
protected Output	parseOutput(Element outputEl, Definition def)
protected Part	parsePart(Element partEl, Definition def)
protected Port	parsePort(Element portEl, Definition def)
protected PortType	parsePortType(Element portTypeEl, Definition def)
protected ExtensibilityElement	parseSchema(Class parentType, Element el, Definition def)
protected ExtensibilityElement	parseSchema(Class parentType, Element el, Definition def, ExtensionRegistry extReg)
protected Service	parseService(Element serviceEl, Definition def)
protected Types	parseTypes(Element typesEl, Definition def)
Definition	readWSDL(String wsdlURI) Read the WSDL document accessible via the specified URI into a WSDL definition.
Definition	readWSDL(String documentBaseURI, Document wsdlDocument) Read the specified WSDL document into a WSDL definition.
Definition	readWSDL(String documentBaseURI, Element definitionsElement) Read the specified <wsdl:definitions> element into a WSDL definition.
protected Definition	readWSDL(String documentBaseURI, Element definitionsElement, Map importedDefs)
Definition	readWSDL(String documentBaseURI, InputSource inputSource) Read a WSDL document into a WSDL definition.
Definition	readWSDL(String contextURI, String wsdlURI) Read the WSDL document accessible via the specified URI into a WSDL definition.
Definition	readWSDL(WSDLLocator locator) Read a WSDL document into a WSDL definition.
Definition	readWSDL(WSDLLocator locator, Element definitionsElement) Read the specified <wsdl:definitions> element into a WSDL definition.
void	setExtensionRegistry(ExtensionRegistry extReg) Set the extension registry to be used when reading WSDL documents into a WSDL definition.
void	setFactoryImplName(String factoryImplName) Set a different factory implementation to use for creating definitions when reading WSDL documents.
void	setFeature(String name, boolean value) Sets the specified feature to the specified value.

Methods inherited from class java.lang.Object

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

Field Detail

verbose

protected boolean verbose

importDocuments

protected boolean importDocuments

parseSchema

protected boolean parseSchema

extReg

protected ExtensionRegistry extReg

factoryImplName

protected String factoryImplName

loc

protected WSDLLocator loc

factory

protected WSDLFactory factory

allSchemas

protected Map allSchemas

Constructor Detail

WSDLReaderImpl

public WSDLReaderImpl()

Method Detail

setFeature

public void setFeature(String name,
                       boolean value)
                throws IllegalArgumentException

Sets the specified feature to the specified value.

The supported features are:

Name	Description	Default Value
javax.wsdl.verbose	If set to true, status messages will be displayed.	true
javax.wsdl.importDocuments	If set to true, imported WSDL documents will be retrieved and processed.	true
com.ibm.wsdl.parseXMLSchemas	If set to true, the schema documents inlined and import directly or indrectly will be retrieved as javax.wsdl.extensions.schema.Schema objects and referred to in the Definition. This is the default (only) behaviour from JWSDL 1.2. Which is why the default for this feature is true. However, prior to JWSDL 1.2 the only behaviour was not to parse the schema files. Setting this feature to false will prevent the schemas being parsed.	true

All feature names must be fully-qualified, Java package style. All names starting with javax.wsdl. are reserved for features defined by the JWSDL specification. It is recommended that implementation- specific features be fully-qualified to match the package name of that implementation. For example: com.abc.featureName

Specified by:

setFeature in interface WSDLReader

Parameters:

name - the name of the feature to be set.

value - the value to set the feature to.

Throws:

IllegalArgumentException - if the feature name is not recognized.

See Also:

getFeature(String)

getFeature

public boolean getFeature(String name)
                   throws IllegalArgumentException

Gets the value of the specified feature.

Specified by:

getFeature in interface WSDLReader

Parameters:

name - the name of the feature to get the value of.

Returns:

the value of the feature.

Throws:

IllegalArgumentException - if the feature name is not recognized.

See Also:

setFeature(String, boolean)

setExtensionRegistry

public void setExtensionRegistry(ExtensionRegistry extReg)

Set the extension registry to be used when reading WSDL documents into a WSDL definition. If an extension registry is set, that is the extension registry that will be set as the extensionRegistry property of the definitions resulting from invoking readWSDL(...). Default is null.

Specified by:

setExtensionRegistry in interface WSDLReader

Parameters:

extReg - the extension registry to use for new definitions

getExtensionRegistry

public ExtensionRegistry getExtensionRegistry()

Get the extension registry, if one was set. Default is null.

Specified by:

getExtensionRegistry in interface WSDLReader

getWSDLFactory

protected WSDLFactory getWSDLFactory()
                              throws WSDLException

Get the WSDLFactory object cached in the reader, or use lazy instantiation if it is not cached yet.

Throws:

WSDLException

setFactoryImplName

public void setFactoryImplName(String factoryImplName)
                        throws UnsupportedOperationException

Set a different factory implementation to use for creating definitions when reading WSDL documents. As some WSDLReader implementations may only be capable of creating definitions using the same factory implementation from which the reader was obtained, this method is optional. Default is null.

Specified by:

setFactoryImplName in interface WSDLReader

Parameters:

factoryImplName - the fully-qualified class name of the class which provides a concrete implementation of the abstract class WSDLFactory.

Throws:

UnsupportedOperationException - if this method is invoked on an implementation which does not support it.

getFactoryImplName

public String getFactoryImplName()

Get the factoryImplName, if one was set. Default is null.

Specified by:

getFactoryImplName in interface WSDLReader

parseDefinitions

protected Definition parseDefinitions(String documentBaseURI,
                                      Element defEl,
                                      Map importedDefs)
                               throws WSDLException

Throws:

WSDLException

parseImport

protected Import parseImport(Element importEl,
                             Definition def,
                             Map importedDefs)
                      throws WSDLException

Throws:

WSDLException

parseTypes

protected Types parseTypes(Element typesEl,
                           Definition def)
                    throws WSDLException

Throws:

WSDLException

parseSchema

protected ExtensibilityElement parseSchema(Class parentType,
                                           Element el,
                                           Definition def)
                                    throws WSDLException

Throws:

WSDLException

parseSchema

protected ExtensibilityElement parseSchema(Class parentType,
                                           Element el,
                                           Definition def,
                                           ExtensionRegistry extReg)
                                    throws WSDLException

Throws:

WSDLException

parseBinding

protected Binding parseBinding(Element bindingEl,
                               Definition def)
                        throws WSDLException

Throws:

WSDLException

parseBindingOperation

protected BindingOperation parseBindingOperation(Element bindingOperationEl,
                                                 PortType portType,
                                                 Definition def)
                                          throws WSDLException

Throws:

WSDLException

parseBindingInput

protected BindingInput parseBindingInput(Element bindingInputEl,
                                         Definition def)
                                  throws WSDLException

Throws:

WSDLException

parseBindingOutput

protected BindingOutput parseBindingOutput(Element bindingOutputEl,
                                           Definition def)
                                    throws WSDLException

Throws:

WSDLException

parseBindingFault

protected BindingFault parseBindingFault(Element bindingFaultEl,
                                         Definition def)
                                  throws WSDLException

Throws:

WSDLException

parseMessage

protected Message parseMessage(Element msgEl,
                               Definition def)
                        throws WSDLException

Throws:

WSDLException

parsePart

protected Part parsePart(Element partEl,
                         Definition def)
                  throws WSDLException

Throws:

WSDLException

parseExtensibilityAttributes

protected void parseExtensibilityAttributes(Element el,
                                            Class parentType,
                                            AttributeExtensible attrExt,
                                            Definition def)
                                     throws WSDLException

Throws:

WSDLException

parseExtensibilityAttribute

protected Object parseExtensibilityAttribute(Element el,
                                             int attrType,
                                             String attrValue,
                                             Definition def)
                                      throws WSDLException

Throws:

WSDLException

parsePortType

protected PortType parsePortType(Element portTypeEl,
                                 Definition def)
                          throws WSDLException

Throws:

WSDLException

parseOperation

protected Operation parseOperation(Element opEl,
                                   PortType portType,
                                   Definition def)
                            throws WSDLException

Throws:

WSDLException

parseService

protected Service parseService(Element serviceEl,
                               Definition def)
                        throws WSDLException

Throws:

WSDLException

parsePort

protected Port parsePort(Element portEl,
                         Definition def)
                  throws WSDLException

Throws:

WSDLException

parseExtensibilityElement

protected ExtensibilityElement parseExtensibilityElement(Class parentType,
                                                         Element el,
                                                         Definition def)
                                                  throws WSDLException

Throws:

WSDLException

parseExtensibilityElementAsDefaultExtensiblityElement

protected ExtensibilityElement parseExtensibilityElementAsDefaultExtensiblityElement(Class parentType,
                                                                                     Element el,
                                                                                     Definition def)
                                                                              throws WSDLException

Parse the element using the ExtensionRegistry default deserializer instead using the one registered. The default deserializer will create an UnknownExtensibilityElement from the element.

Parameters:

parentType -

el -

def -

Returns:

An instance of the default ExtensibilityElement as registered with the ExtensionRegistry

Throws:

WSDLException

parseInput

protected Input parseInput(Element inputEl,
                           Definition def)
                    throws WSDLException

Throws:

WSDLException

parseOutput

protected Output parseOutput(Element outputEl,
                             Definition def)
                      throws WSDLException

Throws:

WSDLException

parseFault

protected Fault parseFault(Element faultEl,
                           Definition def)
                    throws WSDLException

Throws:

WSDLException

readWSDL

public Definition readWSDL(String wsdlURI)
                    throws WSDLException

Read the WSDL document accessible via the specified URI into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

wsdlURI - a URI (can be a filename or URL) pointing to a WSDL XML definition.

Returns:

the definition.

Throws:

WSDLException

readWSDL

public Definition readWSDL(String contextURI,
                           String wsdlURI)
                    throws WSDLException

Read the WSDL document accessible via the specified URI into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

contextURI - the context in which to resolve the wsdlURI, if the wsdlURI is relative. Can be null, in which case it will be ignored.

wsdlURI - a URI (can be a filename or URL) pointing to a WSDL XML definition.

Returns:

the definition.

Throws:

WSDLException

readWSDL

public Definition readWSDL(String documentBaseURI,
                           Element definitionsElement)
                    throws WSDLException

Read the specified <wsdl:definitions> element into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

documentBaseURI - the document base URI of the WSDL definition described by the element. Will be set as the documentBaseURI of the returned Definition. Can be null, in which case it will be ignored.

definitionsElement - the <wsdl:definitions> element

Returns:

the definition described by the element.

Throws:

WSDLException

readWSDL

public Definition readWSDL(WSDLLocator locator,
                           Element definitionsElement)
                    throws WSDLException

Read the specified <wsdl:definitions> element into a WSDL definition. The WSDLLocator is used to provide the document base URIs. The InputSource of the WSDLLocator is ignored, instead the WSDL is parsed from the given Element.

Specified by:

readWSDL in interface WSDLReader

Parameters:

locator - A WSDLLocator object used to provide the document base URI of the WSDL definition described by the element.

definitionsElement - the <wsdl:definitions> element

Returns:

the definition described by the element.

Throws:

WSDLException

readWSDL

protected Definition readWSDL(String documentBaseURI,
                              Element definitionsElement,
                              Map importedDefs)
                       throws WSDLException

Throws:

WSDLException

readWSDL

public Definition readWSDL(String documentBaseURI,
                           Document wsdlDocument)
                    throws WSDLException

Read the specified WSDL document into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

documentBaseURI - the document base URI of the WSDL definition described by the document. Will be set as the documentBaseURI of the returned Definition. Can be null, in which case it will be ignored.

wsdlDocument - the WSDL document, an XML document obeying the WSDL schema.

Returns:

the definition described in the document.

Throws:

WSDLException

readWSDL

public Definition readWSDL(String documentBaseURI,
                           InputSource inputSource)
                    throws WSDLException

Read a WSDL document into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

documentBaseURI - the document base URI of the WSDL definition described by the document. Will be set as the documentBaseURI of the returned Definition. Can be null, in which case it will be ignored.

inputSource - an InputSource pointing to the WSDL document, an XML document obeying the WSDL schema.

Returns:

the definition described in the document pointed to by the InputSource.

Throws:

WSDLException

readWSDL

public Definition readWSDL(WSDLLocator locator)
                    throws WSDLException

Read a WSDL document into a WSDL definition.

Specified by:

readWSDL in interface WSDLReader

Parameters:

locator - A WSDLLocator object used to provide InputSources pointing to the wsdl file.

Returns:

the definition described in the document

Throws:

WSDLException