org.ow2.easywsdl.wsdl.api
Interface WSDLReader

All Known Implementing Classes:
AbstractWSDLReaderImpl, WSDLReaderImpl, WSDLReaderImpl, WSDLReaderImpl

public interface WSDLReader

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 model.

Author:
Nicolas Salatge - eBM WebSourcing

Nested Class Summary
static class WSDLReader.FeatureConstants
          Constants for the Message Exchange Patterns.
 
Method Summary
 java.lang.Object getFeature(WSDLReader.FeatureConstants name)
          Gets the value of the specified feature.
 java.util.Map<WSDLReader.FeatureConstants,java.lang.Object> getFeatures()
          Get all features.
 Description read(org.w3c.dom.Document document)
           Read the WSDL definition available at the specified DOM Document, and bind it into a Description object.
 Description read(org.xml.sax.InputSource inputSource)
           Read the WSDL definition available at the specified InputSource, and bind it into a Description object.
 Description read(org.xml.sax.InputSource source, java.util.Map<java.net.URI,AbsItfDescription> descriptionImports, java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports)
          Read an WSDL part provided by an InputSource, description imports/includes and schema imports/includes provided by descriptionImports and schemaImports are not read.
 Description read(java.net.URL wsdlURL)
           Read the WSDL definition available at the location identified by the specified URL, and bind it into a Description object.
 void setFeature(WSDLReader.FeatureConstants name, java.lang.Object value)
          Sets the specified feature to the specified value.
 void setFeatures(java.util.Map<WSDLReader.FeatureConstants,java.lang.Object> features)
          Set all features.
 

Method Detail

setFeature

void setFeature(WSDLReader.FeatureConstants name,
                java.lang.Object value)
                throws 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:
WSDLException - TODO
See Also:
#getFeature(String)

getFeature

java.lang.Object getFeature(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<WSDLReader.FeatureConstants,java.lang.Object> getFeatures()
Get all features.

Returns:
the features
See Also:
#setFeature(String, boolean)

setFeatures

void setFeatures(java.util.Map<WSDLReader.FeatureConstants,java.lang.Object> features)
Set all features.


read

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

Read the WSDL definition available at the location identified by the specified URL, and bind it into a 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:
WSDLException - 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(org.w3c.dom.Document document)
                 throws WSDLException,
                        java.net.URISyntaxException

Read the WSDL definition available at the specified DOM Document, and bind it into a 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:
WSDLException - 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 inputSource)
                 throws WSDLException,
                        java.net.MalformedURLException,
                        java.net.URISyntaxException

Read the WSDL definition available at the specified InputSource, and bind it into a 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:
WSDLException - 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.xml.sax.InputSource source,
                 java.util.Map<java.net.URI,AbsItfDescription> descriptionImports,
                 java.util.Map<java.net.URI,org.ow2.easywsdl.schema.api.absItf.AbsItfSchema> schemaImports)
                 throws WSDLException,
                        java.net.MalformedURLException,
                        java.net.URISyntaxException
Read an WSDL part provided by an InputSource, description imports/includes and schema imports/includes provided by descriptionImports and schemaImports are not read.

Throws:
WSDLException
java.net.MalformedURLException - The InputSource systemId is a malformed URL.
java.net.URISyntaxException - The InputSource systemId is an URL not formatted strictly according to to RFC2396 and cannot be converted to a URI.


Copyright © 2008-2010 Petals Link (previously EBM WebSourcing). All Rights Reserved.