org.ow2.easywsdl.wsdl.api.WSDLReader Maven / Gradle / Ivy
/**
* easyWSDL - easyWSDL toolbox Platform.
* Copyright (c) 2008, eBM Websourcing
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the University of California, Berkeley nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.ow2.easywsdl.wsdl.api;
import java.net.URI;
import java.util.Map;
import javax.xml.transform.dom.DOMSource;
import org.w3c.dom.Document;
/**
* 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
*/
public interface WSDLReader {
/**
* Constants for the Message Exchange Patterns.
*
*/
public enum FeatureConstants {
VERBOSE("org.ow2.easywsdl.schema.test.verbose"), IMPORT_DOCUMENTS(
"org.ow2.easywsdl.schema.test.importDocuments");
private final String value;
/**
* Creates a new instance of {@link FeatureConstants}
*
* @param value
*/
private FeatureConstants(final String value) {
this.value = value;
}
/**
*
* @return
*/
public String value() {
return this.value;
}
/**
* Please use this equals method instead of using :
* value().equals(value)
* which is
* almost 10 times slower...
*
* @param value
* @return
*/
public boolean equals(final String val) {
return this.value().equals(val);
}
/*
* (non-Javadoc)
*
* @see java.lang.Enum#toString()
*/
@Override
public String toString() {
return this.value;
}
}
/**
* Sets the specified feature to the specified value.
*
* The minimum features that must be supported are:
*
*
*
* Name
* DescriptionImpl
* Default Value
*
*
* org.ow2.easywsdl.schema.test.verbose If set to true, status messages will be displayed.
* type: boolean - default value: false
*
* org.ow2.easywsdl.schema.test.importDocuments If set to true, imported WSDL documents will be retrieved and
* processed.
* type: boolean - default value: true
*
*
* org.ow2.easywsdl.schema.test.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
*
* @param name
* the name of the feature to be set.
* @param value
* the value to set the feature to.
* @throws WSDLException
* TODO
* @see #getFeature(String)
*/
void setFeature(FeatureConstants name, Object value) throws WSDLException;
/**
* Gets the value of the specified feature.
*
* @param name
* the name of the feature to get the value of.
* @return the value of feature
* @throws IllegalArgumentException
* if the feature name is not recognized.
* @see #setFeature(String, boolean)
*/
Object getFeature(FeatureConstants name);
/**
* Gets all features.
*
* @return the features
* @see #setFeature(String, boolean)
*/
Map getFeatures();
/**
* Read the WSDL document accessible via the specified URI into a WSDL
* definition.
*
* @param wsdlURI
* a URI (can be a filename or URL) pointing to a WSDL XML
* definition.
* @return the definition.
*/
Description readWSDL(URI wsdlURI) throws WSDLException;
/**
* Read the specified WSDL document into a WSDL definition.
*
* @param 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.
* @param wsdlDocument
* the WSDL document, an XML document obeying the WSDL schema.
* @return the definition described in the document.
*/
Description readWSDL(Document wsdlDocument) throws WSDLException;
/**
* Read the specified WSDL document into a WSDL definition.
*
* @param wsdlDocument
* the WSDL document, an XML document obeying the WSDL schema.
* @param imports
* a {@link Map} of {@link URI} location to WSDL {@link Document}
* imports
* @return the definition described in the document.
*/
Description readWSDL(Document wsdlDocument, Map imports)
throws WSDLException;
/**
* Read a WSDL document into a WSDL definition.
*
* @param wslURI
* uri of the wsdl
* @param inputSource
* an InputSource pointing to the WSDL document, an XML document
* obeying the WSDL schema.
* @return the definition described in the document pointed to by the
* InputSource.
*/
Description readWSDL(URI wsdlURI, DOMSource inputSource)
throws WSDLException;
/**
* Read a WSDL document into a WSDL definition.
*
* @param wsdlURI
* uri of the wsdl
* @param inputSource
* an InputSource pointing to the WSDL document, an XML document
* obeying the WSDL schema.
* @param imports
* a {@link Map} of {@link URI} location to WSDL
* {@link DOMSource} imports
* @return the definition described in the document pointed to by the
* InputSource.
*/
Description readWSDL(URI wsdlURI, DOMSource inputSource,
Map imports) throws WSDLException;
/**
* Read a WSDL document into a WSDL definition. This method must never be
* called externally !!!
*
* @param wsdlURI
* uri of the wsdl
* @param inputSource
* an InputSource pointing to the WSDL document, an XML document
* obeying the WSDL schema.
* @param imports
* a {@link Map} of {@link URI} location to WSDL
* {@link DOMSource} imports
* @param importDepth
* must be set to 0 for an external call.
* @return the definition described in the document pointed to by the
* InputSource.
*/
Description readWSDL(URI wsdlURI, DOMSource inputSource,
Map imports, int importDepth) throws WSDLException;
}