Package com.sun.xml.ws.api.server

Interface ServiceDefinition

All Superinterfaces:
Iterable<SDDocument>
All Known Implementing Classes:
ServiceDefinitionImpl
public interface ServiceDefinition extends Iterable<SDDocument>
Root of the unparsed WSDL and other resources referenced from it. This object represents the description of the service that a WSEndpoint offers.

A description consists of a set of SDDocument, which each represents a single XML document that forms a part of the descriptor (for example, WSDL might refer to separate schema documents, or a WSDL might refer to another WSDL.)

ServiceDefinition and its descendants are immutable read-only objects. Once they are created, they always return the same value.

Expected Usage

This object is intended to be used for serving the descriptors to remote clients (such as by MEX, or other protocol-specific metadata query, such as HTTP GET with "?wsdl" query string.)

This object is NOT intended to be used by other internal components to parse them. For that purpose, use WSDLModel instead.

Author:
Kohsuke Kawaguchi

  • Method Details

    • getPrimary

      @NotNull SDDocument getPrimary()
      Gets the "primary" SDDocument that represents a WSDL.

      This WSDL eventually refers to all the other SDDocuments.

      Returns:
      always non-null.

    • addFilter

      void addFilter(@NotNull SDDocumentFilter filter)
      Adds a filter that is called while writing SDDocument's infoset. This filter is applied to the all the other reachable SDDocuments.
      Parameters:
      filter - that is called while writing the document