javax.wsdl
Interface Definition

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DefinitionImpl

public interface Definition
extends java.io.Serializable

This interface represents a WSDL definition.

Author:
Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler

Method Summary
 void addBinding(Binding binding)
          Add a binding to this WSDL description.
 void addExtensibilityElement(ExtensibilityElement extElement)
          Add an extensibility element.
 void addImport(Import importDef)
          Add an import to this WSDL description.
 void addMessage(Message message)
          Add a message to this WSDL description.
 void addNamespace(java.lang.String prefix, java.lang.String namespaceURI)
          This is a way to add a namespace association to a definition.
 void addPortType(PortType portType)
          Add a portType to this WSDL description.
 void addService(Service service)
          Add a service to this WSDL description.
 Binding createBinding()
          Create a new binding.
 BindingFault createBindingFault()
          Create a new binding fault.
 BindingInput createBindingInput()
          Create a new binding input.
 BindingOperation createBindingOperation()
          Create a new binding operation.
 BindingOutput createBindingOutput()
          Create a new binding output.
 Fault createFault()
          Create a new fault.
 Import createImport()
          Create a new import.
 Input createInput()
          Create a new input.
 Message createMessage()
          Create a new message.
 Operation createOperation()
          Create a new operation.
 Output createOutput()
          Create a new output.
 Part createPart()
          Create a new part.
 Port createPort()
          Create a new port.
 PortType createPortType()
          Create a new port type.
 Service createService()
          Create a new service.
 Types createTypes()
          Create a new types section.
 Binding getBinding(QName name)
          Get the specified binding.
 java.util.Map getBindings()
          Get all the bindings defined here.
 org.w3c.dom.Element getDocumentationElement()
          Get the documentation element.
 java.lang.String getDocumentBaseURI()
          Get the document base URI of this definition.
 java.util.List getExtensibilityElements()
          Get all the extensibility elements defined here.
 ExtensionRegistry getExtensionRegistry()
          Get a reference to the ExtensionRegistry for this Definition.
 java.util.Map getImports()
          Get a map of lists containing all the imports defined here.
 java.util.List getImports(java.lang.String namespaceURI)
          Get the list of imports for the specified namespaceURI.
 Message getMessage(QName name)
          Get the specified message.
 java.util.Map getMessages()
          Get all the messages defined here.
 java.lang.String getNamespace(java.lang.String prefix)
          Get the namespace URI associated with this prefix.
 java.util.Map getNamespaces()
          Get all namespace associations in this definition.
 PortType getPortType(QName name)
          Get the specified portType.
 java.util.Map getPortTypes()
          Get all the portTypes defined here.
 java.lang.String getPrefix(java.lang.String namespaceURI)
          Get a prefix associated with this namespace URI.
 QName getQName()
          Get the name of this definition.
 Service getService(QName name)
          Get the specified service.
 java.util.Map getServices()
          Get all the services defined here.
 java.lang.String getTargetNamespace()
          Get the target namespace in which the WSDL elements are defined.
 Types getTypes()
          Get the types section.
 Binding removeBinding(QName name)
          Remove the specified binding from this definition.
 Message removeMessage(QName name)
          Remove the specified message from this definition.
 PortType removePortType(QName name)
          Remove the specified portType from this definition.
 Service removeService(QName name)
          Remove the specified service from this definition.
 void setDocumentationElement(org.w3c.dom.Element docEl)
          Set the documentation element for this document.
 void setDocumentBaseURI(java.lang.String documentBaseURI)
          Set the document base URI of this definition.
 void setExtensionRegistry(ExtensionRegistry extReg)
          Set the ExtensionRegistry for this Definition.
 void setQName(QName name)
          Set the name of this definition.
 void setTargetNamespace(java.lang.String targetNamespace)
          Set the target namespace in which WSDL elements are defined.
 void setTypes(Types types)
          Set the types section.
 

Method Detail

setDocumentBaseURI

public void setDocumentBaseURI(java.lang.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

public java.lang.String getDocumentBaseURI()
Get the document base URI of this definition.

Returns:
the document base URI

setQName

public void setQName(QName name)
Set the name of this definition.

Parameters:
name - the desired name

getQName

public QName getQName()
Get the name of this definition.

Returns:
the definition name

setTargetNamespace

public void setTargetNamespace(java.lang.String targetNamespace)
Set the target namespace in which WSDL elements are defined.


getTargetNamespace

public java.lang.String getTargetNamespace()
Get the target namespace in which the WSDL elements are defined.

Returns:
the target namespace

addNamespace

public void addNamespace(java.lang.String prefix,
                         java.lang.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

public java.lang.String getNamespace(java.lang.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:
addNamespace(String, String), getPrefix(String)

getPrefix

public java.lang.String getPrefix(java.lang.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:
addNamespace(String, String), getNamespace(String)

getNamespaces

public java.util.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:
addNamespace(String, String)

setTypes

public void setTypes(Types types)
Set the types section.


getTypes

public Types getTypes()
Get the types section.

Returns:
the types section

addImport

public void addImport(Import importDef)
Add an import to this WSDL description.

Parameters:
importDef - the import to be added

getImports

public java.util.List getImports(java.lang.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

public java.util.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

public void addMessage(Message message)
Add a message to this WSDL description.

Parameters:
message - the message to be added

getMessage

public 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

public 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

public java.util.Map getMessages()
Get all the messages defined here.


addBinding

public void addBinding(Binding binding)
Add a binding to this WSDL description.

Parameters:
binding - the binding to be added

getBinding

public 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

public 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

public java.util.Map getBindings()
Get all the bindings defined here.


addPortType

public void addPortType(PortType portType)
Add a portType to this WSDL description.

Parameters:
portType - the portType to be added

getPortType

public 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

public 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

public java.util.Map getPortTypes()
Get all the portTypes defined here.


addService

public void addService(Service service)
Add a service to this WSDL description.

Parameters:
service - the service to be added

getService

public 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

public 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

public java.util.Map getServices()
Get all the services defined here.


setDocumentationElement

public void setDocumentationElement(org.w3c.dom.Element docEl)
Set the documentation element for this document. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.

Parameters:
docEl - the documentation element

getDocumentationElement

public org.w3c.dom.Element getDocumentationElement()
Get the documentation element. This dependency on org.w3c.dom.Element should eventually be removed when a more appropriate way of representing this information is employed.

Returns:
the documentation element

addExtensibilityElement

public void addExtensibilityElement(ExtensibilityElement extElement)
Add an extensibility element.

Parameters:
extElement - the extensibility element to be added

getExtensibilityElements

public java.util.List getExtensibilityElements()
Get all the extensibility elements defined here.


createBinding

public Binding createBinding()
Create a new binding.

Returns:
the newly created binding

createBindingFault

public BindingFault createBindingFault()
Create a new binding fault.

Returns:
the newly created binding fault

createBindingInput

public BindingInput createBindingInput()
Create a new binding input.

Returns:
the newly created binding input

createBindingOperation

public BindingOperation createBindingOperation()
Create a new binding operation.

Returns:
the newly created binding operation

createBindingOutput

public BindingOutput createBindingOutput()
Create a new binding output.

Returns:
the newly created binding output

createFault

public Fault createFault()
Create a new fault.

Returns:
the newly created fault

createImport

public Import createImport()
Create a new import.

Returns:
the newly created import

createInput

public Input createInput()
Create a new input.

Returns:
the newly created input

createMessage

public Message createMessage()
Create a new message.

Returns:
the newly created message

createOperation

public Operation createOperation()
Create a new operation.

Returns:
the newly created operation

createOutput

public Output createOutput()
Create a new output.

Returns:
the newly created output

createPart

public Part createPart()
Create a new part.

Returns:
the newly created part

createPort

public Port createPort()
Create a new port.

Returns:
the newly created port

createPortType

public PortType createPortType()
Create a new port type.

Returns:
the newly created port type

createService

public Service createService()
Create a new service.

Returns:
the newly created service

createTypes

public Types createTypes()
Create a new types section.

Returns:
the newly created types section

getExtensionRegistry

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


setExtensionRegistry

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



Copyright ? 2003 IBM. All Rights Reserved.