BaseWSDLReader (Woden

java.lang.Object
- org.apache.woden.internal.BaseWSDLReader

All Implemented Interfaces:

WSDLReader

Direct Known Subclasses:

DOMWSDLReader
```
public abstract class BaseWSDLReader
extends Object
implements WSDLReader
```
This abstract class contains properties and methods common to WSDLReader implementations.
TODO a Template Inheritance pattern that ensures WSDL validation gets invoked (if turned on by some property) after the subclass has parsed the WSDL. Note, this class is currently WSDL version-independent and XML parser-independent; should try to keep it that way.

Author:

John Kaputin (jkaputin@apache.org)

Field Summary

Fields
Modifier and Type Field and Description

protected ReaderFeatures features

protected WSDLContext fWsdlContext
- Fields inherited from interface org.apache.woden.WSDLReader
  FEATURE_CONTINUE_ON_ERROR, FEATURE_VALIDATION, FEATURE_VERBOSE, PROPERTY_TYPE_SYSTEM_API, PROPERTY_XML_PARSER_API, TYPE_XSD_2001

Fields
Modifier and Type	Field and Description
`protected ReaderFeatures`	`features`
`protected WSDLContext`	`fWsdlContext`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BaseWSDLReader(WSDLContext wsdlContext)

Constructors
Modifier	Constructor and Description
`protected`	`BaseWSDLReader(WSDLContext wsdlContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract XMLElement`	`createXMLElement(Object elem)` Returns an XMLElement object representing the specified element object.
`ErrorReporter`	`getErrorReporter()`
`ExtensionRegistry`	`getExtensionRegistry()`
`protected WSDLFactory`	`getFactory()` Get the cached WSDLFactory if there is one, otherwise create and cache a new one.
`String`	`getFactoryImplName()`
`boolean`	`getFeature(String name)` Returns the on/off setting of the named feature, represented as a boolean.
`Object`	`getProperty(String name)` Returns the value of the named property.
`protected URI`	`getURI(String anyURI)`
`URIResolver`	`getURIResolver()` Find the current URI Resolver
`protected abstract DescriptionElement`	`getWSDLFromLocation(String locationURI, DescriptionElement desc, Map wsdlModules)`
`protected DescriptionElement`	`parseDescription(String documentBaseURI, XMLElement descEl, Map wsdlModules)`
`protected DocumentationElement`	`parseDocumentation(XMLElement docEl, DescriptionElement desc, DocumentableElement parent)`
`protected abstract void`	`parseExtensionAttributes(XMLElement extEl, Class wsdlClass, WSDLElement wsdlObj, DescriptionElement desc)`
`protected ExtensionElement`	`parseExtensionElement(Class parentType, WSDLElement parent, XMLElement el, DescriptionElement desc)`
`protected abstract void`	`parseNamespaceDeclarations(XMLElement xmlElem, WSDLElement wsdlElem)`
`protected void`	`parseSchemaForXMLSchema(DescriptionElement desc)`
`protected abstract Schema`	`parseSchemaImport(XMLElement importEl, DescriptionElement desc)`
`protected abstract Schema`	`parseSchemaInline(XMLElement schemaEl, DescriptionElement desc)`
`protected String`	`resolveURI(String uri)`
`protected URI`	`resolveURI(URI uri)`
`void`	`setExtensionRegistry(ExtensionRegistry extReg)` Set the extension registry to the specified registry reference.
`void`	`setFactoryImplName(String factoryImplName)` Stores the name of the WSDLFactory implementation class to be used for any subsequent WSDLFactory requests, first discarding any cached factory object.
`void`	`setFeature(String name, boolean value)` Set a named feature on or off with a boolean.
`void`	`setProperty(String name, Object value)` Set a named property to the specified object.
`void`	`setURIResolver(URIResolver resolver)` Provides the capability of setting a custom URI Resolver.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.woden.WSDLReader
createWSDLSource, readWSDL, readWSDL

- Field Detail
  - fWsdlContext
```
protected WSDLContext fWsdlContext
```
  - features
```
protected final ReaderFeatures features
```
- Constructor Detail
  - BaseWSDLReader
```
protected BaseWSDLReader(WSDLContext wsdlContext)
                  throws WSDLException
```
    Throws:
    
    WSDLException
- Method Detail
  - getErrorReporter
```
public ErrorReporter getErrorReporter()
```
    Specified by:
    
    getErrorReporter in interface WSDLReader
    
    Returns:
    Returns the fErrorReporter.
  - getFactory
```
protected WSDLFactory getFactory()
                          throws WSDLException
```
    Get the cached WSDLFactory if there is one, otherwise create and cache a new one. TODO see setFactoryImplName todo
    
    Returns:
    Returns a.
    
    Throws:
    
    WSDLException
  - setFactoryImplName
```
public void setFactoryImplName(String factoryImplName)
```
    Stores the name of the WSDLFactory implementation class to be used for any subsequent WSDLFactory requests, first discarding any cached factory object. TODO the use case is changing the factory that creates Description objects. Decide if/how this works with WSDLContext.
    
    Specified by:
    
    setFactoryImplName in interface WSDLReader
    
    Parameters:
    factoryImplName - the WSDLFactory implementation classname
  - getFactoryImplName
```
public String getFactoryImplName()
```
    Specified by:
    
    getFactoryImplName in interface WSDLReader
    
    Returns:
    the WSDLFactory implementation classname
  - setExtensionRegistry
```
public void setExtensionRegistry(ExtensionRegistry extReg)
```
    Description copied from interface: WSDLReader
    
    Set the extension registry to the specified registry reference. The registry parameter cannot be null.
    
    Specified by:
    
    setExtensionRegistry in interface WSDLReader
    
    Parameters:
    extReg - an ExtensionRegistry
  - getExtensionRegistry
```
public ExtensionRegistry getExtensionRegistry()
```
    Specified by:
    
    getExtensionRegistry in interface WSDLReader
  - setFeature
```
public void setFeature(String name,
              boolean value)
```
    Set a named feature on or off with a boolean.
    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
    
    Specified by:
    
    setFeature in interface WSDLReader
    
    Parameters:
    name - the name of the feature to be set
    value - a boolean value where true sets the feature on, false sets it off
    
    Throws:
    
    IllegalArgumentException - if the feature name is not recognized.
  - getFeature
```
public boolean getFeature(String name)
```
    Returns the on/off setting of the named feature, represented as a boolean.
    
    Specified by:
    
    getFeature in interface WSDLReader
    
    Parameters:
    name - the name of the feature to get the value of
    
    Returns:
    a boolean representing the on/off state of the named feature
    
    Throws:
    
    IllegalArgumentException - if the feature name is not recognized.
  - setProperty
```
public void setProperty(String name,
               Object value)
```
    Set a named property to the specified object.
    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
    
    Specified by:
    
    setProperty in interface WSDLReader
    
    Parameters:
    name - the name of the property to be set
    value - an Object representing the value to set the property to
    
    Throws:
    
    IllegalArgumentException - if the property name is not recognized.
  - getProperty
```
public Object getProperty(String name)
```
    Returns the value of the named property.
    
    Specified by:
    
    getProperty in interface WSDLReader
    
    Parameters:
    name - the name of the property to get the value of
    
    Returns:
    an Object representing the property's value
    
    Throws:
    
    IllegalArgumentException - if the property name is not recognized.
  - parseDescription
```
protected DescriptionElement parseDescription(String documentBaseURI,
                                  XMLElement descEl,
                                  Map wsdlModules)
                                       throws WSDLException
```
    Throws:
    
    WSDLException
  - parseDocumentation
```
protected DocumentationElement parseDocumentation(XMLElement docEl,
                                      DescriptionElement desc,
                                      DocumentableElement parent)
                                           throws WSDLException
```
    Throws:
    
    WSDLException
  - parseSchemaImport
```
protected abstract Schema parseSchemaImport(XMLElement importEl,
                       DescriptionElement desc)
                                     throws WSDLException
```
    Throws:
    
    WSDLException
  - parseSchemaInline
```
protected abstract Schema parseSchemaInline(XMLElement schemaEl,
                       DescriptionElement desc)
                                     throws WSDLException
```
    Throws:
    
    WSDLException
  - parseExtensionElement
```
protected ExtensionElement parseExtensionElement(Class parentType,
                                     WSDLElement parent,
                                     XMLElement el,
                                     DescriptionElement desc)
                                          throws WSDLException
```
    Throws:
    
    WSDLException
  - parseExtensionAttributes
```
protected abstract void parseExtensionAttributes(XMLElement extEl,
                            Class wsdlClass,
                            WSDLElement wsdlObj,
                            DescriptionElement desc)
                                          throws WSDLException
```
    Throws:
    
    WSDLException
  - parseNamespaceDeclarations
```
protected abstract void parseNamespaceDeclarations(XMLElement xmlElem,
                              WSDLElement wsdlElem)
                                            throws WSDLException
```
    Throws:
    
    WSDLException
  - parseSchemaForXMLSchema
```
protected void parseSchemaForXMLSchema(DescriptionElement desc)
                                throws WSDLException
```
    Throws:
    
    WSDLException
  - createXMLElement
```
protected abstract XMLElement createXMLElement(Object elem)
                                        throws IllegalArgumentException
```
    Returns an XMLElement object representing the specified element object. The element object argument must be compatible with the concrete reader implementation. If so, this method returns an XMLElement object that is type-compatible with the reader implementatation (e.g. a DOMXMLElement for DOMWSDLReader).
    
    Throws:
    
    IllegalArgumentException - if elem is not a type recognized by the WSDLReader implementation.
  - getURI
```
protected URI getURI(String anyURI)
              throws WSDLException
```
    Throws:
    
    WSDLException
  - getWSDLFromLocation
```
protected abstract DescriptionElement getWSDLFromLocation(String locationURI,
                                     DescriptionElement desc,
                                     Map wsdlModules)
                                                   throws WSDLException
```
    Throws:
    
    WSDLException
  - setURIResolver
```
public void setURIResolver(URIResolver resolver)
```
    Provides the capability of setting a custom URI Resolver.
    
    Specified by:
    
    setURIResolver in interface WSDLReader
    
    Parameters:
    resolver - the custom URIResolver
    
    Throws:
    
    NullPointerException - if the 'resolver' parameter is null.
  - resolveURI
```
protected URI resolveURI(URI uri)
                  throws WSDLException
```
    Throws:
    
    WSDLException
  - resolveURI
```
protected String resolveURI(String uri)
```
  - getURIResolver
```
public URIResolver getURIResolver()
```
    Find the current URI Resolver
    
    Specified by:
    
    getURIResolver in interface WSDLReader
    
    Returns:
    the URI resolver currently in use

Class BaseWSDLReader

Field Summary

Fields inherited from interface org.apache.woden.WSDLReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.woden.WSDLReader

Field Detail

fWsdlContext

features

Constructor Detail

BaseWSDLReader

Method Detail

getErrorReporter

getFactory

setFactoryImplName

getFactoryImplName

setExtensionRegistry

getExtensionRegistry

setFeature

getFeature

setProperty

getProperty

parseDescription

parseDocumentation

parseSchemaImport

parseSchemaInline

parseExtensionElement

parseExtensionAttributes

parseNamespaceDeclarations

parseSchemaForXMLSchema

createXMLElement

getURI

getWSDLFromLocation

setURIResolver

resolveURI

resolveURI

getURIResolver