com.ebmwebsourcing.agreement.definition.api
Interface WSAgreementReader

All Known Implementing Classes:

WSAgreementReaderImpl

public interface WSAgreementReader

This interface describes a collection of methods that enable conversion of a SchemaImpl document (in XML, following the SchemaImpl parent described in the SchemaImpl specification) into a SchemaImpl model.

Author:

Nicolas Salatge - eBM WebSourcing

Nested Class Summary

static class

WSAgreementReader.FeatureConstants Constants for the Message Exchange Patterns.

Method Summary

java.lang.Object	getFeature(WSAgreementReader.FeatureConstants name) Gets the value of the specified feature.
java.util.Map<WSAgreementReader.FeatureConstants,java.lang.Object>	getFeatures() Gets all features.
Agreement	readAgreement(org.w3c.dom.Document doc) Read the specified SchemaImpl document into a SchemaImpl definition.
Agreement	readAgreement(java.net.URI uri) Read the SchemaImpl document accessible via the specified URI into a SchemaImpl definition.
Agreement	readAgreement(java.net.URI uri, org.xml.sax.InputSource inputSource) Read a SchemaImpl document into a SchemaImpl definition.
void	setFeature(WSAgreementReader.FeatureConstants name, java.lang.Object value) Sets the specified feature to the specified value.

Method Detail

setFeature

void setFeature(WSAgreementReader.FeatureConstants name,
                java.lang.Object value)
                throws java.lang.IllegalArgumentException

Sets the specified feature to the specified value.

The minimum features that must be supported are:

Name	Description	Default Value
org.ow2.easywsdl.schema.verbose	If set to true, status messages will be displayed.	type: boolean - default value: false
org.ow2.easywsdl.schema.importDocuments	If set to true, imported WSDL documents will be retrieved and processed.	type: boolean - default value: true
org.ow2.easywsdl.schema.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 com.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

Parameters:

name - the name of the feature to be set.

value - the value to set the feature to.

Throws:

java.lang.IllegalArgumentException - if the feature name is not recognized.

See Also:

#getFeature(String)

getFeature

java.lang.Object getFeature(WSAgreementReader.FeatureConstants name)

Gets the value of the specified feature.

Parameters:

name - the name of the feature to get the value of.

Returns:

the value of feature

Throws:

java.lang.IllegalArgumentException - if the feature name is not recognized.

See Also:

#setFeature(String, boolean)

getFeatures

java.util.Map<WSAgreementReader.FeatureConstants,java.lang.Object> getFeatures()

Gets all features.

Returns:

the features

See Also:

#setFeature(String, boolean)

readAgreement

Agreement readAgreement(java.net.URI uri)
                        throws WSAgreementException

Read the SchemaImpl document accessible via the specified URI into a SchemaImpl definition.

Parameters:

schemaURI - a URI (can be a filename or URL) pointing to a SchemaImpl XML definition.

Returns:

the definition.

Throws:

WSAgreementException

readAgreement

Agreement readAgreement(org.w3c.dom.Document doc)
                        throws WSAgreementException

Read the specified SchemaImpl document into a SchemaImpl definition.

Parameters:

documentBaseURI - the document base URI of the SchemaImpl 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 SchemaImpl document, an XML document obeying the SchemaImpl parent.

Returns:

the definition described in the document.

Throws:

WSAgreementException

readAgreement

Agreement readAgreement(java.net.URI uri,
                        org.xml.sax.InputSource inputSource)
                        throws WSAgreementException

Read a SchemaImpl document into a SchemaImpl definition.

Parameters:

schemaURI - the uri of the parent

inputSource - an InputSource pointing to the SchemaImpl document, an XML document obeying the SchemaImpl parent.

Returns:

the definition described in the document pointed to by the InputSource.

Throws:

WSAgreementException