Package javax.wsdl.xml
Interface WSDLReader
- All Known Implementing Classes:
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:
- Matthew J. Duftler
-
Method Summary
Modifier and TypeMethodDescriptionGet the extension registry, if one was set.Get the factoryImplName, if one was set.boolean
getFeature
(String name) Gets the value of the specified feature.Read the WSDL document accessible via the specified URI into a WSDL definition.Read the WSDL document accessible via the specified URI into a WSDL definition.Read the specified WSDL document into a WSDL definition.Read the specified <wsdl:definitions> element into a WSDL definition.readWSDL
(String documentBaseURI, InputSource inputSource) Read a WSDL document into a WSDL definition.readWSDL
(WSDLLocator locator) Read a WSDL document into a WSDL definition.readWSDL
(WSDLLocator locator, Element definitionsElement) Read the specified <wsdl:definitions> element into a WSDL definition.void
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.
-
Method Details
-
setFeature
Sets the specified feature to the specified value.The minimum features that must be supported 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 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
- 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
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:
IllegalArgumentException
- if the feature name is not recognized.- See Also:
-
setExtensionRegistry
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.- Parameters:
extReg
- the extension registry to use for new definitions
-
getExtensionRegistry
ExtensionRegistry getExtensionRegistry()Get the extension registry, if one was set. Default is null. -
setFactoryImplName
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.- 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
String getFactoryImplName()Get the factoryImplName, if one was set. Default is null. -
readWSDL
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
Read the WSDL document accessible via the specified URI into a WSDL definition.- 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
Read the specified <wsdl:definitions> element into a WSDL definition.- 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
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.- 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
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
Read a 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.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
Read a WSDL document into a WSDL definition.- Parameters:
locator
- A WSDLLocator object used to provide InputSources pointing to the wsdl file.- Returns:
- the definition described in the document
- Throws:
WSDLException
-