javax.wsdl.xml
Interface WSDLReader
- 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.
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.
|
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.
|
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.
|
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.
|
getExtensionRegistry
public ExtensionRegistry getExtensionRegistry()
Get the extension registry, if one was set. Default is
null.
getFactoryImplName
public String getFactoryImplName()
Get the factoryImplName, if one was set. Default is null.
getFeature
public boolean getFeature(String name)
throws IllegalArgumentException
Gets the value of the specified feature.
name
- the name of the feature to get the value of.
readWSDL
public Definition readWSDL(String wsdlURI)
throws WSDLException
Read the WSDL document accessible via the specified
URI into a WSDL definition.
wsdlURI
- a URI (can be a filename or URL) pointing to a
WSDL XML definition.
readWSDL
public Definition readWSDL(String documentBaseURI,
Document wsdlDocument)
throws WSDLException
Read the specified WSDL document into a WSDL definition.
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.
- the definition described in the document.
readWSDL
public Definition readWSDL(String documentBaseURI,
Element definitionsElement)
throws WSDLException
Read the specified <wsdl:definitions> element into a WSDL
definition.
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
- the definition described by the element.
readWSDL
public Definition readWSDL(String documentBaseURI,
InputSource inputSource)
throws WSDLException
Read a WSDL document into a WSDL definition.
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.
- the definition described in the document pointed to
by the InputSource.
readWSDL
public Definition readWSDL(String contextURI,
String wsdlURI)
throws WSDLException
Read the WSDL document accessible via the specified
URI into a WSDL definition.
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.
readWSDL
public Definition readWSDL(WSDLLocator locator)
throws WSDLException
Read a WSDL document into a WSDL definition.
locator
- A WSDLLocator object used to provide InputSources
pointing to the wsdl file.
- the definition described in the document
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.
extReg
- the extension registry to use for new
definitions
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.
factoryImplName
- the fully-qualified class name of the
class which provides a concrete implementation of the abstract
class WSDLFactory.
setFeature
public void setFeature(String name,
boolean value)
throws IllegalArgumentException
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
name
- the name of the feature to be set.value
- the value to set the feature to.
Copyright B) 2003,2005 IBM. All Rights Reserved.