com.ebmwebsourcing.commons.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() Gets all features.
Description	readWSDL(org.w3c.dom.Document wsdlDocument) Read the specified WSDL document into a WSDL definition.
Description	readWSDL(java.net.URI wsdlURI) Read the WSDL document accessible via the specified URI into a WSDL definition.
Description	readWSDL(java.net.URI wsdlURI, javax.xml.transform.dom.DOMSource inputSource) Read a WSDL document into a WSDL definition.
void	setFeature(WSDLReader.FeatureConstants name, java.lang.Object value) Sets the specified feature to the specified value.

Method Detail

setFeature

void setFeature(WSDLReader.FeatureConstants name,
                java.lang.Object value)
                throws java.lang.IllegalArgumentException

Sets the specified feature to the specified value.

The minimum features that must be supported are:

Name	DescriptionImpl	Default Value
com.ebmwebsourcing.commons.wsdl.verbose	If set to true, status messages will be displayed.	type: boolean - default value: false
com.ebmwebsourcing.commons.wsdl.importDocuments	If set to true, imported WSDL documents will be retrieved and processed.	type: boolean - default value: true
com.ebmwebsourcing.commons.wsdl.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:

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

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()

Gets all features.

Returns:

the features

See Also:

#setFeature(String, boolean)

readWSDL

Description readWSDL(java.net.URI wsdlURI)
                     throws WSDLException

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

Parameters:

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

Returns:

the definition.

Throws:

WSDLException

readWSDL

Description readWSDL(org.w3c.dom.Document wsdlDocument)
                     throws WSDLException

Read the specified WSDL document into a WSDL definition.

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

Description readWSDL(java.net.URI wsdlURI,
                     javax.xml.transform.dom.DOMSource inputSource)
                     throws 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:

WSDLException