|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WSDLReader
This interface declares an API for reading WSDL descriptions from different sources
such as WSDL documents or files, parsed XML elements and input byte streams.
It contains various readWSDL
methods that obtain the WSDL infoset from
the specified source, parse it into the Woden object model and return this as a WSDL
Description
component containing the WSDL components derived from that infoset.
If the WSDL is comprised of a composite set of documents nested via wsdl:import
or wsdl:include, the Description component will represent the abstract, 'flattened' view
of the WSDL tree, containing all of the WSDL components derived from the various WSDL
documents, but without the document structure.
Field Summary | |
---|---|
static java.lang.String |
FEATURE_CONTINUE_ON_ERROR
Set to true if parsing should continue after
encountering a non-fatal error in the WSDL which might result
in incomplete WSDL model being returned by the reader,
false otherwise. |
static java.lang.String |
FEATURE_VALIDATION
Set to true to enable the WSDL validation feature, false otherwise. |
static java.lang.String |
FEATURE_VERBOSE
Set to true to enable verbose diagnostic tracing, false otherwise. |
static java.lang.String |
PROPERTY_TYPE_SYSTEM_API
|
static java.lang.String |
PROPERTY_XML_PARSER_API
Constants for reader configuration property names. |
static java.lang.String |
TYPE_XSD_2001
A constant representing the W3C XML Schema type system. |
Method Summary | |
---|---|
WSDLSource |
createWSDLSource()
Returns a WSDLSource object that is compatible with the WSDLReader implementation. |
ErrorReporter |
getErrorReporter()
|
ExtensionRegistry |
getExtensionRegistry()
|
java.lang.String |
getFactoryImplName()
|
boolean |
getFeature(java.lang.String name)
Returns the on/off setting of the named feature, represented as a boolean. |
java.lang.Object |
getProperty(java.lang.String name)
Returns the value of the named property. |
URIResolver |
getURIResolver()
Gets the URI Resolver currently in use |
Description |
readWSDL(java.lang.String wsdlURI)
Read the WSDL document at the specified URI and return a WSDL Description component containing the WSDL components derived from that document. |
Description |
readWSDL(WSDLSource wsdlSource)
Read the WSDL obtained from the specified WSDLSource object and return a WSDL Description component containing the WSDL components derived from that WSDL source. |
void |
setExtensionRegistry(ExtensionRegistry extReg)
Set the extension registry to the specified registry reference. |
void |
setFactoryImplName(java.lang.String factoryImplName)
Store the name of the WSDLFactory implementation class to be used for any subsequent WSDLFactory requests. |
void |
setFeature(java.lang.String name,
boolean value)
Set a named feature on or off with a boolean. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
Set a named property to the specified object. |
void |
setURIResolver(URIResolver resolver)
Sets the URI resolver to be used. |
Field Detail |
---|
static final java.lang.String FEATURE_VERBOSE
true
to enable verbose diagnostic tracing, false
otherwise.
static final java.lang.String FEATURE_VALIDATION
true
to enable the WSDL validation feature, false
otherwise.
static final java.lang.String FEATURE_CONTINUE_ON_ERROR
true
if parsing should continue after
encountering a non-fatal error in the WSDL which might result
in incomplete WSDL model being returned by the reader,
false
otherwise.
static final java.lang.String PROPERTY_XML_PARSER_API
static final java.lang.String PROPERTY_TYPE_SYSTEM_API
static final java.lang.String TYPE_XSD_2001
Method Detail |
---|
Description readWSDL(java.lang.String wsdlURI) throws WSDLException
wsdlURI
- a URI (absolute filename or URL) pointing to a
WSDL document.
WSDLException
- for terminating errors and as wrapper
for checked exceptions.Description readWSDL(WSDLSource wsdlSource) throws WSDLException
The WSDLSource object must represent the WSDL using a type that the WSDLReader implementation can understand. That is, the WSDLSource and WSDLReader implementations must be compatible. For example, a DOM-based WSDLReader implementation will likely require the WSDLSource object to represent the WSDL as a DOM Document or Element (org.w3c.dom.Document or org.w3c.dom.Element), both of which should be type compatible the DOM-based reader.
wsdlSource
- contains an object representing the WSDL
WSDLException
- for terminating errors and as a wrapper
for checked exceptionsWSDLSource createWSDLSource()
This WSDLSource object can be used to encapsulate the WSDL and is then passed to the
WSDLReader as a parameter to its readWSDL
methods.
ErrorReporter getErrorReporter()
void setFactoryImplName(java.lang.String factoryImplName)
factoryImplName
- the WSDLFactory implementation classnamejava.lang.String getFactoryImplName()
void setExtensionRegistry(ExtensionRegistry extReg)
extReg
- an ExtensionRegistry
java.lang.NullPointerException
- if extReg is nullExtensionRegistry getExtensionRegistry()
void setFeature(java.lang.String name, boolean value)
All feature names should be fully-qualified, Java package style to avoid name clashes. All names starting with org.apache.woden. are reserved for features defined by the Woden implementation. Features specific to other implementations should be fully-qualified to match the package name structure of that implementation. For example: com.abc.featureName
name
- the name of the feature to be setvalue
- a boolean value where true sets the feature on, false sets it off
java.lang.IllegalArgumentException
- if the feature name is not recognized.boolean getFeature(java.lang.String name)
name
- the name of the feature to get the value of
java.lang.IllegalArgumentException
- if the feature name is not recognized.void setProperty(java.lang.String name, java.lang.Object value)
All property names should be fully-qualified, Java package style to avoid name clashes. All names starting with org.apache.woden. are reserved for properties defined by the Woden implementation. Properties specific to other implementations should be fully-qualified to match the package name structure of that implementation. For example: com.abc.propertyName
name
- the name of the property to be setvalue
- an Object representing the value to set the property to
java.lang.IllegalArgumentException
- if the property name is not recognized.java.lang.Object getProperty(java.lang.String name)
name
- the name of the property to get the value of
java.lang.IllegalArgumentException
- if the property name is not recognized.void setURIResolver(URIResolver resolver)
resolver
- URIResolver getURIResolver()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |