org.ow2.easywsdl.extensions.wsdl4complexwsdl.api
Interface WSDL4ComplexWsdlReader

All Known Implementing Classes:

WSDL4ComplexWsdlReaderImpl

public interface WSDL4ComplexWsdlReader

This interface 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 tag.

Author:

Nicolas Salatge - eBM WebSourcing

Method Summary

java.lang.Object	getFeature(org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants name) Gets the value of the specified feature.
java.util.Map<org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants,java.lang.Object>	getFeatures() Gets all features.
Description	read(org.w3c.dom.Document wsdlDocument) Read the WSDL complex definition available at the specified DOM Document, and bind it into a complex Description object.
Description	read(org.xml.sax.InputSource wsdlInputSource) Read the WSDL complex definition available at the specified InputSource, and bind it into a complex Description object.
Description	read(org.xml.sax.InputSource doc, java.util.Map<java.net.URI,org.ow2.easywsdl.wsdl.api.abstractItf.AbsItfDescription> descriptionImports, java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports) Read a WSDL document into a WSDL definition.
Description	read(java.net.URL wsdlURL) Read the WSDL complex definition available at the location identified by the specified URL, and bind it into a complex Description object.
Description	read(java.net.URL wsdlURL, java.util.Map<java.net.URI,org.ow2.easywsdl.wsdl.api.abstractItf.AbsItfDescription> descImports, java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports)
void	setFeature(org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants name, java.lang.Object value) Sets the specified feature to the specified value.

Method Detail

setFeature

void setFeature(org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants name,
                java.lang.Object value)
                throws org.ow2.easywsdl.wsdl.api.WSDLException

Sets the specified feature to the specified value.

The minimum features that must be supported are:

Name	DescriptionImpl	Default Value
org.ow2.easywsdl.schema.test.verbose	If set to true, status messages will be displayed.	type: boolean - default value: false
org.ow2.easywsdl.schema.test.importDocuments	If set to true, imported WSDL documents will be retrieved and processed.	type: boolean - default value: true
org.ow2.easywsdl.schema.test.pathDirectoryOfImportLocations	If the location is set, imported WSDL documents will be retrieved at this location (Set the importDocuments Features at true).	type: String

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

Parameters:

name - the name of the feature to be set.

value - the value to set the feature to.

Throws:

org.ow2.easywsdl.wsdl.api.WSDLException - TODO

See Also:

#getFeature(String)

getFeature

java.lang.Object getFeature(org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants name)

Gets the value of the specified feature.

Parameters:

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

Returns:

the value of feature

Throws:

java.lang.IllegalArgumentException - if the feature name is not recognized.

See Also:

#setFeature(String, boolean)

getFeatures

java.util.Map<org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants,java.lang.Object> getFeatures()

Gets all features.

Returns:

the features

See Also:

#setFeature(String, boolean)

read

Description read(java.net.URL wsdlURL)
                 throws WSDL4ComplexWsdlException,
                        java.net.URISyntaxException,
                        java.io.IOException

Read the WSDL complex definition available at the location identified by the specified URL, and bind it into a complex Description object.

Note: all relative URIs are resolved according to the specified URL.

Parameters:

wsdlURL - an URL pointing to a WSDL definition.

Returns:

the Description definition.

Throws:

WSDL4ComplexWsdlException - An error occurs during the parsing or the binding of the WSDL definition

java.net.URISyntaxException - If the URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

java.io.IOException - An I/O error occurs openning the URL stream.

read

Description read(java.net.URL wsdlURL,
                 java.util.Map<java.net.URI,org.ow2.easywsdl.wsdl.api.abstractItf.AbsItfDescription> descImports,
                 java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports)
                 throws org.ow2.easywsdl.wsdl.api.WSDLException

Throws:

org.ow2.easywsdl.wsdl.api.WSDLException

read

Description read(org.xml.sax.InputSource wsdlInputSource)
                 throws WSDL4ComplexWsdlException,
                        java.net.MalformedURLException,
                        java.net.URISyntaxException

Read the WSDL complex definition available at the specified InputSource, and bind it into a complex Description object.

Note: To be able to resolve relative URIs, the InputSource system identifier must be set.

Parameters:

inputSource - an InputSource pointing to a WSDL definition.

Returns:

the Description definition.@throws MalformedURLException The InputSource system identifier is not a well-formed URL.

Throws:

WSDL4ComplexWsdlException - An error occurs during the parsing or the binding of the WSDL definition.

java.net.MalformedURLException - The InputSource system identifier is not a well-formed URL.

java.net.URISyntaxException - the InputSource system identifier is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

read

Description read(org.w3c.dom.Document wsdlDocument)
                 throws WSDL4ComplexWsdlException,
                        java.net.URISyntaxException

Read the WSDL complex definition available at the specified DOM Document, and bind it into a complex Description object.

Note: To be able to resolve relative URIs, the Document base URI must be set.

Parameters:

document - a DOM Document pointing to a WSDL definition.

Returns:

the Description definition.

Throws:

WSDL4ComplexWsdlException - An error occurs during the parsing or the binding of the WSDL definition

java.net.URISyntaxException - the DOM Document base URI is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

read

Description read(org.xml.sax.InputSource doc,
                 java.util.Map<java.net.URI,org.ow2.easywsdl.wsdl.api.abstractItf.AbsItfDescription> descriptionImports,
                 java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports)
                 throws org.ow2.easywsdl.wsdl.api.WSDLException

Read a WSDL document into a WSDL definition.

Parameters:

wslURI - uri of the wsdl

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:

org.ow2.easywsdl.wsdl.api.WSDLException