Jump to: navigation, search

Difference between revisions of "Using the WSDL Validator Outside of Eclipse"

(WSDL Validation)
Line 25: Line 25:
 
The URI is actually a URL location representing the location of the document. The WSDL validator won't read from this location if an INPUTSTREAM is provided.<br/>
 
The URI is actually a URL location representing the location of the document. The WSDL validator won't read from this location if an INPUTSTREAM is provided.<br/>
 
The INPUTSTREAM is an optional inputstream that represents the URI location.<br/>
 
The INPUTSTREAM is an optional inputstream that represents the URI location.<br/>
The CONFIGURATION is a [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/WSDLValidationConfiguration.java?rev=1.2&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup WSDLValidationConfiguration], which can be used to pass properties to the validator and extension validators.<br/>
+
The CONFIGURATION is a [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/WSDLValidationConfiguration.java?rev=1.2&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup WSDLValidationConfiguration], which can be used to pass properties (see Configuring the WSDL Validator for more information about the properties) to the validator and extension validators.<br/>
 
The validator returns an [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/IValidationReport.java?rev=1.1&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup IValidationReport] that contains validation messages (errors and warnings) produced during validation.
 
The validator returns an [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/IValidationReport.java?rev=1.1&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup IValidationReport] that contains validation messages (errors and warnings) produced during validation.
  
Line 45: Line 45:
  
 
== Validating WSDL Documents from the Command Line ==
 
== Validating WSDL Documents from the Command Line ==
 +
 +
== Configuring the WSDL Validator ==
 +
 +
The WSDL validator can be configured using the [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/WSDLValidationConfiguration.java?rev=HEAD&cvsroot=WebTools_Project&content-type=text/vnd.viewcvs-markup WSDLValidationConfiguration].
 +
 +
The WSDL validator currently accepts the following properties:
 +
 +
'''Note: As of WTP 1.5, the properties listed below have not been declared as API and are therefor subject to change.'''
 +
 +
=== WSDL validator properties ===
 +
The properties listed below are those that can be set on the WSDL validator itself. Extension validator properties are listed under the section [[Using_the_WSDL_Validator_Outside_of_Eclipse#Other_properties|Other properties]].
 +
 +
==== <nowiki>http://www.eclipse.org/webtools/wsdl/xmlcache</nowiki> ====
 +
This property allows you to set a cache to be used for XML processing of WSDL documents. The WSDL validator first processes and validates WSDL documents as XML documents. A cache can significantly reduce the processing time required to read and validate the XML representation of WSDL documents. This property must be set for an object of type [http://xerces.apache.org/xerces2-j/javadocs/xni/org/apache/xerces/xni/grammars/XMLGrammarPool.html org.apache.xerces.xni.grammars.XMLGrammarPool]. A sample XML grammar pool can be seen [http://xerces.apache.org/xerces2-j/javadocs/xerces2/org/apache/xerces/util/XMLGrammarPoolImpl.html here].
 +
 +
==== <nowiki>http://www.eclipse.org/webtools/wsdl/schemacache</nowiki> ====
 +
This property allows you to set a cache to be used for inline and external schemas. A cache can significantly reduce the processing time required to read and validate inline and external schemas. This property must be set for an object of type [http://xerces.apache.org/xerces2-j/javadocs/xni/org/apache/xerces/xni/grammars/XMLGrammarPool.html org.apache.xerces.xni.grammars.XMLGrammarPool]. A sample schema grammar pool can be seen [http://dev.eclipse.org/viewcvs/index.cgi/wst/components/wsdl/plugins/org.eclipse.wst.wsdl.validation/src/org/eclipse/wst/wsdl/validation/internal/eclipse/InlineSchemaModelGrammarPoolImpl.java?cvsroot=WebTools_Project&only_with_tag=MAIN here].
 +
 +
=== Other properties ===
 +
The properties listed below are those that are known for extension WSDL validators. (Please add the properties for your extension validators below.)
 +
 +
==== <nowiki>http://ws-i.org/profiles/Basic/ComplianceLevel</nowiki> ====
 +
This property for the WS-I extension WSDL validator allows you to set the compliance level of the basic profile and the simple soap binding profile. This property can be set to IGNORE to turn off this validation, SUGGEST to produce warnings for WS-I problems, or REQUIRE to produce errors for WS-I problems.
 +
 +
==== <nowiki>http://ws-i.org/profiles/BasicWithAttachments/ComplianceLevel</nowiki> ====
 +
This property for the WS-I extension WSDL validator allows you to set the compliance level of the basic profile and the attachments profile. This property can be set to IGNORE to turn off this validation, SUGGEST to produce warnings for WS-I problems, or REQUIRE to produce errors for WS-I problems. Note, if this property is set the setting for the <nowiki>http://ws-i.org/profiles/Basic/ComplianceLevel</nowiki> property will be ignored.

Revision as of 15:26, 11 October 2006

WSDL Validation

WTP's WSDL validator validates WSDL 1.1 documents against the WSDL 1.1 specification. Through the Web Services Interoperability (WS-I) extension it can also validate against the WS-I Basic Profile 1.1, Simple SOAP Binding Profile 1.0 and Attachments Profile 1.0.

The WSDL validator, available in all WTP downloads, is located in plug-in org.eclipse.wst.wsdl.validation. The current version of the WSDL validator will only compile against Eclipse 3.2, WTP 1.5 and later. If you'd like to compile the validator with an older version of Eclipse or outside of Eclipse you should be able to by removing the package org.eclipse.wst.wsdl.validation.internal.eclipse, which contains all of the Eclipse and WTP dependencies. You may also have to make changes to the manifest if it causes you problems.

Validating WSDL Documents Programmatically

The WSDL validator can be used programmatically both within and outside of Eclipse.

Prerequisite to using the WSDL validator programmatically

The WSDL validator has a prerequisite to validating WSDL 1.1 documents: It must be able to locate the WSDL 1.1 schemas (WSDL, SOAP, HTTP, MIME). The WSDL validator provides the method

public void addURIResolver(IExtensibleURIResolver uriResolver)

Using this method you can add a resolver to locate the schemas. The resolver can be as simple as a pointer to the local or remote location of the schemas or can be more complex such as the URI resolution framework included in WTP. An example URI resolver that wraps the WTP URI resolution framework and registers it with the WSDL validator can be seen here.

Invoking WSDL validation

WSDL validation can be invoked as follows

WSDLValidator validator = new WSDLValidator();
IValidationReport report = validator.validate(URI, INPUTSTREAM, CONFIGURATION);

The URI is actually a URL location representing the location of the document. The WSDL validator won't read from this location if an INPUTSTREAM is provided.
The INPUTSTREAM is an optional inputstream that represents the URI location.
The CONFIGURATION is a WSDLValidationConfiguration, which can be used to pass properties (see Configuring the WSDL Validator for more information about the properties) to the validator and extension validators.
The validator returns an IValidationReport that contains validation messages (errors and warnings) produced during validation.

Registering additional WSDL 1.1 validators

The WSDLValidator also provides the method

public void registerWSDL11Validator(String namespace, WSDL11ValidatorDelegate delegate)

which allows you to register a validator for an extension WSDL 1.1 namespace. Validators for HTTP 1.1 GET and POST and SOAP 1.1 are already provided. When working outside of Eclipse you'll likely want to create a ClassloaderWSDL11ValidatorDelegate as follows:

WSDL11ValidatorDelegate delegate = new ClassloaderWSDL11ValidatorDelegate("org.example.extension.WSDLValidator");

Note: As of WTP 1.5, the classes discussed in this section have not been declared as API and are therefore subject to change.

Validating WSDL Documents with Ant

Validating WSDL Documents from the Command Line

Configuring the WSDL Validator

The WSDL validator can be configured using the WSDLValidationConfiguration.

The WSDL validator currently accepts the following properties:

Note: As of WTP 1.5, the properties listed below have not been declared as API and are therefor subject to change.

WSDL validator properties

The properties listed below are those that can be set on the WSDL validator itself. Extension validator properties are listed under the section Other properties.

http://www.eclipse.org/webtools/wsdl/xmlcache

This property allows you to set a cache to be used for XML processing of WSDL documents. The WSDL validator first processes and validates WSDL documents as XML documents. A cache can significantly reduce the processing time required to read and validate the XML representation of WSDL documents. This property must be set for an object of type org.apache.xerces.xni.grammars.XMLGrammarPool. A sample XML grammar pool can be seen here.

http://www.eclipse.org/webtools/wsdl/schemacache

This property allows you to set a cache to be used for inline and external schemas. A cache can significantly reduce the processing time required to read and validate inline and external schemas. This property must be set for an object of type org.apache.xerces.xni.grammars.XMLGrammarPool. A sample schema grammar pool can be seen here.

Other properties

The properties listed below are those that are known for extension WSDL validators. (Please add the properties for your extension validators below.)

http://ws-i.org/profiles/Basic/ComplianceLevel

This property for the WS-I extension WSDL validator allows you to set the compliance level of the basic profile and the simple soap binding profile. This property can be set to IGNORE to turn off this validation, SUGGEST to produce warnings for WS-I problems, or REQUIRE to produce errors for WS-I problems.

http://ws-i.org/profiles/BasicWithAttachments/ComplianceLevel

This property for the WS-I extension WSDL validator allows you to set the compliance level of the basic profile and the attachments profile. This property can be set to IGNORE to turn off this validation, SUGGEST to produce warnings for WS-I problems, or REQUIRE to produce errors for WS-I problems. Note, if this property is set the setting for the http://ws-i.org/profiles/Basic/ComplianceLevel property will be ignored.