Using the WSDL Validator Outside of Eclipse

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.

Reporting Problems

WSDL validation bugs and feature requests can be reported here.

WS-I validation bugs and feature requests can be reported here.

Corrections and additions to this page can be made by anyone with an Eclipse bugzilla account or can be reported here.

Requirements For WSDL Validation

The following are the list of libraries that must be on the classpath in order to call WSDL validation outside of Eclipse. (These libraries are already included when using WTP.)

• Apache Xerces (resolver.jar, xercesImpl.jar, xml-apis.jar) - The Xerces XML parser is required for schema validation and error location information. Xerces is bundled in the org.apache.xerces plug-in distributed with WTP, which can be obtained from the WTP downloads page, or can be downloaded from the Xerces website. The WSDL validator has been tested and is known to work with Xerces 2.8.0.

• WSDL4J (qname.jar, wsdl4j.jar) - This lightweight WSDL model and parser are used for validation as a representation of a WSDL document tree. WSDL4J is bundled in the org.wsdl4j plug-in distributed with WTP, which can be obtained from the WTP downloads page, or can be downloaded from the WSDL4J project page. The WSDL validator requires WSDL4J 1.4 and is known NOT to work with later versions of WSDL4J.

• org.eclipse.wst.wsdl.validation_VERSION.jar - This is the WSDL validator plug-in, which can also be used standalone outside of Eclipse. The WSDL validator can be obtained from any WTP build on the WTP downloads page.

• org.eclipse.wst.wsi_VERSION.jar (optional) - This is the WS-I extension for the WSDL validator, which contains validation logic for the WS-I BP 1.1, SSBP 1.0 and AP 1.0. The WS-I extension validator can be obtained from any WTP build on the WTP downloads page.

Validating WSDL Documents Programmatically

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

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");

Registering custom WSDL validators

The WSDLValidator also provides the method

public void registerWSDLValidator(String namespace, WSDLValidatorDelegate delegate)

which allows you to register a custom validator, such as the WS-I validator. The WS-I validator is already provided in WTP in the plug-in org.eclipse.wst.wsi. When working outside of Eclipse you'll likely want to create a ClassloaderWSDLValidatorDelegate as follows:

WSDLValidatorDelegate delegate = new ClassloaderWSDLValidatorDelegate("org.example.extension.WSDLValidator");

As a concrete example, you can register the WS-I validator as follows:

WSDLValidator wsdlValidator = new WSDLValidator();
WSDLValidatorDelegate wsiDelegate = new ClassloaderWSDLValidatorDelegate("org.eclipse.wst.wsi.internal.validate.wsdl.WSDLValidator");
wsdlValidator.registerWSDLValidator("http://schemas.xmlsoap.org/wsdl/", wsiDelegate);

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.

Additional Help

The WTP newsgroup is a great source of information and is open to the community.