Skip navigation links
org.netbeans.modules.xml.wsdl.model/1 1.52.0 1

XML WSDL API
Friend, Private or Third Party

See: Description

XML WSDL API 
Package Description
org.netbeans.modules.xml.wsdl.model  
org.netbeans.modules.xml.wsdl.model.extensions.http  
org.netbeans.modules.xml.wsdl.model.extensions.soap  
org.netbeans.modules.xml.wsdl.model.extensions.soap12  
org.netbeans.modules.xml.wsdl.model.extensions.xsd  
org.netbeans.modules.xml.wsdl.model.spi  
org.netbeans.modules.xml.wsdl.model.visitor  
org.netbeans.modules.xml.wsdl.validator.spi  

The wsdl model provides a read and write model based on XDM and XAM.

wsdl.model This package provides API's for obtaining a wsdl model using the factory pattern as well as reading and writing the wsdl structure. This package is made up mostly of interfaces, which are not expected to be implemented by the client. The entry point is the wsdl model factory. The components are based on the structure of wsdl and the names should reflect element and attribute names from the specification. wsdl.model.visitor Generic visitor pattern support (such as empty and deep visitors) as well as visitors for finding usages. wsdl.model.spi The SPI package provides the ability to plug-in strongly typed extensibility elements, which are used in every concrete wsdl for bindings. wsdl.model.extensions.soap Strongly typed extensibility elements for the SOAP binding. wsdl.model.extensions.xsd Strongly typed extensibility element for Schema. This supports embedding the schema model within the WSDL model to introspect the types section of WSDL.

What is New (see all changes)?

Use Cases

The typical client of the WSDL model would be a tool author requiring read or write access to WSDL.

customization editor
Both Tango and JAXWS define WSDL extensions which support customization of their capabilities. The WSDL model supports the ability to add strongly typed extensions. The Web Service customization relies on this support to read and write extensibility elements from an existing WSDL document.
WSDL editor
The WSDL editor uses the WSDL model to support both textual and graphical editing.
Validation
Only some of the WSDL semantics can be described in terms of XML schema. The visitor is used to provide additional validation semantics to ensure successful deployment to the BPEL engine. Here is a code sample for working with the WSDL model:

FileObject wsdlFileObj = ...; // get file object for WSDL
ModelSource source =
org.netbeans.modules.xml.xam.locator.api.Utilities.getModelSource(wsdlFileObj, true);
WSDLModel model = WSDLModelFactory.getDefault().getModel(source);
// access port types
Collection<PortType> portTypes = model.getDefinitions().getPortTypes();

// add port type
PortType pt = model.getFactory().createPortType();
pt.setName("newPortType");
// pt manipulation before adding to model, name, etc.
try {
// model must be manipulated in transaction
model.startTransaction();
// add port type to model
model.getDefinitions().addPortType(pt);
} finally {
model.endTransaction();
}

Exported Interfaces

This table lists all of the module exported APIs with defined stability classifications. It is generated based on answers to questions about the architecture of the module. Read them all...
Group of java interfaces
Interface NameIn/OutStabilitySpecified in What Document?
wsdl.modelExportedFriend

This package provides API's for obtaining a wsdl model using the factory pattern as well as reading and writing the wsdl structure. This package is made up mostly of interfaces, which are not expected to be implemented by the client. The entry point is the wsdl model factory. The components are based on the structure of wsdl and the names should reflect element and attribute names from the specification.

wsdl.model.visitorExportedFriend

Generic visitor pattern support (such as empty and deep visitors) as well as visitors for finding usages.

wsdl.model.spiExportedFriend

The SPI package provides the ability to plug-in strongly typed extensibility elements, which are used in every concrete wsdl for bindings.

wsdl.model.extensions.soapExportedFriend

Strongly typed extensibility elements for the SOAP binding.

wsdl.model.extensions.xsdExportedFriend

Strongly typed extensibility element for Schema. This supports embedding the schema model within the WSDL model to introspect the types section of WSDL.

Group of lookup interfaces
Interface NameIn/OutStabilitySpecified in What Document?

Implementation Details

Where are the sources for the module?

The sources for the module are in the Apache Git repositories or in the GitHub repositories.

What do other modules need to do to declare a dependency on this one, in addition to or instead of a plain module dependency?

The API's are currently exposed through the friend mechanism, thus another module would need to be added to the friends list.

Read more about the implementation in the answers to architecture questions.

Skip navigation links
org.netbeans.modules.xml.wsdl.model/1 1.52.0 1