org.ow2.easywsdl.extensions.sawsdl.api.SAWSDLReader 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.extensions.sawsdl.api;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Map;
import org.ow2.easywsdl.wsdl.api.WSDLException;
import org.ow2.easywsdl.wsdl.api.WSDLReader.FeatureConstants;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
/**
* 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 tag.
*
* @author Nicolas Salatge - eBM WebSourcing
*/
public interface SAWSDLReader {
/**
* 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.
* @deprecated Use {@link #read(URL)}
*/
@Deprecated
Description readSAWSDL(URI wsdlURI) throws SAWSDLException;
/**
*
* Read the SA-WSDL document available at the location identified by the
* specified URL, and bind it into a {@link Description} object.
*
*
* Note: all relative URIs are resolved according to the specified
* URL.
*
*
* @param wsdlURL
* an URL pointing to a SA-WSDL document.
* @return the {@link Description} definition.
* @throws SAWSDLException
* An error occurs during the parsing or the binding of the
* SA-WSDL document.
* @throws URISyntaxException
* If the URL is not formatted strictly according to to RFC2396
* and cannot be converted to a URI.
* @throws IOException
* An I/O error occurs openning the URL stream.
*/
Description read(final URL wsdlURL) throws SAWSDLException, IOException, URISyntaxException;
/**
* 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.
* @deprecated Use {@link #read(Document)}
*/
@Deprecated
Description readSAWSDL(Document wsdlDocument) throws SAWSDLException;
/**
*
* Read the SA-WSDL document available at the specified DOM {@link Document}
* , and bind it into a {@link Description} object.
*
*
* Note: To be able to resolve relative URIs, the {@link Document}
* base URI must be set.
*
*
* @param document
* a DOM {@link Document} pointing to a SA-WSDL document.
* @return the {@link Description} definition.
* @throws SAWSDLException
* An error occurs during the parsing or the binding of the
* SA-WSDL document
* @throws URISyntaxException
* the DOM {@link Document} base URI is not formatted strictly
* according to to RFC2396 and cannot be converted to a URI.
*/
Description read(final Document document) throws SAWSDLException, URISyntaxException;
/**
*
* Read the SA-WSDL document available at the specified {@link InputSource},
* and bind it into a {@link Description} object.
*
*
* Note: To be able to resolve relative URIs, the {@link InputSource}
* system identifier must be set.
*
*
* @param inputSource
* an {@link InputSource} pointing to a SA-WSDL document.
* @return the {@link Description} definition.
* @throws SAWSDLException
* An error occurs during the parsing or the binding of the
* SA-WSDL document.
* @throws MalformedURLException
* The {@link InputSource} system identifier is not a
* well-formed URL.
* @throws URISyntaxException
* the {@link InputSource} system identifier is not formatted
* strictly according to to RFC2396 and cannot be converted to a
* URI.
*/
Description read(final InputSource inputSource) throws SAWSDLException, MalformedURLException, URISyntaxException;
}