Interface Definition

All Superinterfaces:
AttributeExtensible, ElementExtensible, Serializable, WSDLElement
All Known Implementing Classes:
DefinitionImpl
public interface Definition extends WSDLElement
This interface represents a WSDL definition.
Author:
Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler

  • Method Details

    • setDocumentBaseURI

      void setDocumentBaseURI(String documentBaseURI)
      Set the document base URI of this definition. Can be used to represent the origin of the Definition, and can be exploited when resolving relative URIs (e.g. in <import>s).
      Parameters:
      documentBaseURI - the document base URI of this definition

    • getDocumentBaseURI

      String getDocumentBaseURI()
      Get the document base URI of this definition.
      Returns:
      the document base URI

    • setQName

      void setQName(QName name)
      Set the name of this definition.
      Parameters:
      name - the desired name

    • getQName

      QName getQName()
      Get the name of this definition.
      Returns:
      the definition name

    • setTargetNamespace

      void setTargetNamespace(String targetNamespace)
      Set the target namespace in which WSDL elements are defined.
      Parameters:
      targetNamespace - the target namespace

    • getTargetNamespace

      String getTargetNamespace()
      Get the target namespace in which the WSDL elements are defined.
      Returns:
      the target namespace

    • addNamespace

      void addNamespace(String prefix, String namespaceURI)
      This is a way to add a namespace association to a definition. It is similar to adding a namespace prefix declaration to the top of a <wsdl:definition> element. This has nothing to do with the <wsdl:import> element; there are separate methods for dealing with information described by <wsdl:import> elements.
      Parameters:
      prefix - the prefix to use for this namespace (when rendering this information as XML). Use null or an empty string to describe the default namespace (i.e. xmlns="...").
      namespaceURI - the namespace URI to associate the prefix with. If you use null, the namespace association will be removed.

    • getNamespace

      String getNamespace(String prefix)
      Get the namespace URI associated with this prefix. Or null if there is no namespace URI associated with this prefix. This is unrelated to the <wsdl:import> element.
      See Also:

    • removeNamespace

      String removeNamespace(String prefix)
      Remove the namespace URI associated with this prefix.
      Parameters:
      prefix - the prefix of the namespace to be removed.
      Returns:
      the namespace URI which was removed.

    • getPrefix

      String getPrefix(String namespaceURI)
      Get a prefix associated with this namespace URI. Or null if there are no prefixes associated with this namespace URI. This is unrelated to the <wsdl:import> element.
      See Also:

    • getNamespaces

      Map getNamespaces()
      Get all namespace associations in this definition. The keys are the prefixes, and the namespace URIs are the values. This is unrelated to the <wsdl:import> element.
      See Also:

    • setTypes

      void setTypes(Types types)
      Set the types section.

    • getTypes

      Types getTypes()
      Get the types section.
      Returns:
      the types section

    • addImport

      void addImport(Import importDef)
      Add an import to this WSDL description.
      Parameters:
      importDef - the import to be added

    • removeImport

      Import removeImport(Import importDef)
      Remove an import from this WSDL description.
      Parameters:
      importDef - the import to be removed
      Returns:
      the removed Import

    • getImports

      List getImports(String namespaceURI)
      Get the list of imports for the specified namespaceURI.
      Parameters:
      namespaceURI - the namespaceURI associated with the desired imports.
      Returns:
      a list of the corresponding imports, or null if there weren't any matching imports

    • getImports

      Map getImports()
      Get a map of lists containing all the imports defined here. The map's keys are the namespaceURIs, and the map's values are lists. There is one list for each namespaceURI for which imports have been defined.

    • addMessage

      void addMessage(Message message)
      Add a message to this WSDL description.
      Parameters:
      message - the message to be added

    • getMessage

      Message getMessage(QName name)
      Get the specified message. Also checks imported documents.
      Parameters:
      name - the name of the desired message.
      Returns:
      the corresponding message, or null if there wasn't any matching message

    • removeMessage

      Message removeMessage(QName name)
      Remove the specified message from this definition.
      Parameters:
      name - the name of the message to remove
      Returns:
      the message previously associated with this qname, if there was one; may return null

    • getMessages

      Map getMessages()
      Get all the messages defined here.

    • addBinding

      void addBinding(Binding binding)
      Add a binding to this WSDL description.
      Parameters:
      binding - the binding to be added

    • getBinding

      Binding getBinding(QName name)
      Get the specified binding. Also checks imported documents.
      Parameters:
      name - the name of the desired binding.
      Returns:
      the corresponding binding, or null if there wasn't any matching binding

    • removeBinding

      Binding removeBinding(QName name)
      Remove the specified binding from this definition.
      Parameters:
      name - the name of the binding to remove
      Returns:
      the binding previously associated with this qname, if there was one; may return null

    • getBindings

      Map getBindings()
      Get all the bindings defined in this Definition.

    • getAllBindings

      Map getAllBindings()
      Get all the bindings defined in this Definition and those in any imported Definitions down the WSDL tree.

    • addPortType

      void addPortType(PortType portType)
      Add a portType to this WSDL description.
      Parameters:
      portType - the portType to be added

    • getPortType

      PortType getPortType(QName name)
      Get the specified portType. Also checks imported documents.
      Parameters:
      name - the name of the desired portType.
      Returns:
      the corresponding portType, or null if there wasn't any matching portType

    • removePortType

      PortType removePortType(QName name)
      Remove the specified portType from this definition.
      Parameters:
      name - the name of the portType to remove
      Returns:
      the portType previously associated with this qname, if there was one; may return null

    • getPortTypes

      Map getPortTypes()
      Get all the portTypes defined in this Definition.

    • getAllPortTypes

      Map getAllPortTypes()
      Get all the portTypes defined in this Definition and those in any imported Definitions down the WSDL tree.

    • addService

      void addService(Service service)
      Add a service to this WSDL description.
      Parameters:
      service - the service to be added

    • getService

      Service getService(QName name)
      Get the specified service. Also checks imported documents.
      Parameters:
      name - the name of the desired service.
      Returns:
      the corresponding service, or null if there wasn't any matching service

    • removeService

      Service removeService(QName name)
      Remove the specified service from this definition.
      Parameters:
      name - the name of the service to remove
      Returns:
      the service previously associated with this qname, if there was one; may return null

    • getServices

      Map getServices()
      Get all the services defined in this Definition.

    • getAllServices

      Map getAllServices()
      Get all the services defined in this Definition and those in any imported Definitions down the WSDL tree.

    • createBinding

      Binding createBinding()
      Create a new binding.
      Returns:
      the newly created binding

    • createBindingFault

      BindingFault createBindingFault()
      Create a new binding fault.
      Returns:
      the newly created binding fault

    • createBindingInput

      BindingInput createBindingInput()
      Create a new binding input.
      Returns:
      the newly created binding input

    • createBindingOperation

      BindingOperation createBindingOperation()
      Create a new binding operation.
      Returns:
      the newly created binding operation

    • createBindingOutput

      BindingOutput createBindingOutput()
      Create a new binding output.
      Returns:
      the newly created binding output

    • createFault

      Fault createFault()
      Create a new fault.
      Returns:
      the newly created fault

    • createImport

      Import createImport()
      Create a new import.
      Returns:
      the newly created import

    • createInput

      Input createInput()
      Create a new input.
      Returns:
      the newly created input

    • createMessage

      Message createMessage()
      Create a new message.
      Returns:
      the newly created message

    • createOperation

      Operation createOperation()
      Create a new operation.
      Returns:
      the newly created operation

    • createOutput

      Output createOutput()
      Create a new output.
      Returns:
      the newly created output

    • createPart

      Part createPart()
      Create a new part.
      Returns:
      the newly created part

    • createPort

      Port createPort()
      Create a new port.
      Returns:
      the newly created port

    • createPortType

      PortType createPortType()
      Create a new port type.
      Returns:
      the newly created port type

    • createService

      Service createService()
      Create a new service.
      Returns:
      the newly created service

    • createTypes

      Types createTypes()
      Create a new types section.
      Returns:
      the newly created types section

    • getExtensionRegistry

      ExtensionRegistry getExtensionRegistry()
      Get a reference to the ExtensionRegistry for this Definition.

    • setExtensionRegistry

      void setExtensionRegistry(ExtensionRegistry extReg)
      Set the ExtensionRegistry for this Definition.