com.ebmwebsourcing.commons.wsdl.api
Interface Description

All Superinterfaces:

java.io.Serializable, WSDLElement

All Known Implementing Classes:

AbstractDescriptionImpl, DescriptionImpl, DescriptionImpl

public interface Description
extends WSDLElement

This interface represents a WSDL definition.

Author:

Nicolas Salatge - eBM WebSourcing

Method Summary

void	addBinding(Binding binding) Add a binding to this WSDL description.
void	addImport(Import importDef) Add an import to this WSDL description.
void	addInclude(Include includeDef) Add an include to this WSDL description.
void	addInterface(InterfaceType interfaceType) Add a portType 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	addService(Service service) Add a service to this WSDL description.
Binding	createBinding() Create a new binding.
BindingFault	createBindingFault() Create a new binding fault.
BindingOperation	createBindingOperation() Create a new binding operation.
Endpoint	createEndpoint() Create a new endpoint.
Fault	createFault() Create a new fault.
Import	createImport() Create a new import.
Input	createInput() Create a new input.
InterfaceType	createInterface() Create a new interface.
Operation	createOperation() Create a new operation.
Output	createOutput() Create a new output.
Part	createPart() Create a new part.
Service	createService() Create a new service.
Types	createTypes() Create a new types section.
Binding	getBinding(javax.xml.namespace.QName name) Get the specified binding.
java.util.List<Binding>	getBindings() Get all the bindings defined in this Definition.
java.net.URI	getDocumentBaseURI() Get the document base URI of this definition.
java.util.List<Import>	getImports() Get a map of lists containing all the imports defined here.
java.util.List<Import>	getImports(java.lang.String namespaceURI) Get the list of imports for the specified namespaceURI.
java.util.List<Include>	getIncludes() Get a map of lists containing all the includes defined here.
java.util.List<Include>	getIncludes(java.lang.String locationURI) Get the list of includes for the specified locationURI.
InterfaceType	getInterface(javax.xml.namespace.QName name) Get the specified portType.
java.util.List<InterfaceType>	getInterfaces() Get all the portTypes defined in this Definition.
javax.xml.namespace.NamespaceContext	getNamespaces() Get all namespace associations in this definition.
javax.xml.namespace.QName	getQName() Get the name of this definition.
java.util.Map<java.lang.String,java.lang.String>	getSchemaLocation() get the schema location
Service	getService(javax.xml.namespace.QName name) Get the specified service.
java.util.List<Service>	getServices() Get all the services defined in this Definition.
java.lang.String	getTargetNamespace() Get the target namespace in which the WSDL elements are defined.
Types	getTypes() Get the types section.
Constants.WSDLVersionConstants	getVersion() get the version of the wsdl
Binding	removeBinding(javax.xml.namespace.QName name) Remove the specified binding from this definition.
Import	removeImport(Import importDef) Remove an import from this WSDL description.
Include	removeInclude(Include includeDef) Remove an include from this WSDL description.
InterfaceType	removeInterface(javax.xml.namespace.QName name) Remove the specified portType from this definition.
java.lang.String	removeNamespace(java.lang.String prefix) Remove the namespace URI associated with this prefix.
Service	removeService(javax.xml.namespace.QName name) Remove the specified service from this definition.
void	setDocumentBaseURI(java.net.URI documentBaseURI) Set the document base URI of this definition.
void	setQName(javax.xml.namespace.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.

Methods inherited from interface com.ebmwebsourcing.commons.wsdl.api.WSDLElement

createDocumentation, getDocumentation, getOtherAttributes, getOtherElements, setDocumentation

Method Detail

setDocumentBaseURI

void setDocumentBaseURI(java.net.URI 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

java.net.URI getDocumentBaseURI()

Get the document base URI of this definition.

Returns:

the document base URI

setQName

void setQName(javax.xml.namespace.QName name)
              throws WSDLException

Set the name of this definition.

Parameters:

name - the desired name

Throws:

WSDLException

getQName

javax.xml.namespace.QName getQName()
                                   throws WSDLException

Get the name of this definition.

Returns:

the definition name

Throws:

WSDLException

setTargetNamespace

void setTargetNamespace(java.lang.String targetNamespace)

Set the target namespace in which WSDL elements are defined.

Parameters:

targetNamespace - the target namespace

getTargetNamespace

java.lang.String getTargetNamespace()

Get the target namespace in which the WSDL elements are defined.

Returns:

the target namespace

addNamespace

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.

removeNamespace

java.lang.String removeNamespace(java.lang.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.

getNamespaces

javax.xml.namespace.NamespaceContext 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

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 ImportImpl

getImports

java.util.List<Import> 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

java.util.List<Import> 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.

addInclude

void addInclude(Include includeDef)
                throws WSDLException

Add an include to this WSDL description.

Parameters:

includeDef - the include to be added

Throws:

WSDLException

removeInclude

Include removeInclude(Include includeDef)
                      throws WSDLException

Remove an include from this WSDL description.

Parameters:

includeDef - the include to be removed

Returns:

the removed include

Throws:

WSDLException

getIncludes

java.util.List<Include> getIncludes(java.lang.String locationURI)

Get the list of includes for the specified locationURI.

Parameters:

locationURI - the locationURI associated with the desired includes.

Returns:

a list of the corresponding includes, or null if there weren't any matching includes

getIncludes

java.util.List<Include> getIncludes()

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

addBinding

void addBinding(Binding binding)

Add a binding to this WSDL description.

Parameters:

binding - the binding to be added

getBinding

Binding getBinding(javax.xml.namespace.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(javax.xml.namespace.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

java.util.List<Binding> getBindings()

Get all the bindings defined in this Definition.

addInterface

void addInterface(InterfaceType interfaceType)

Add a portType to this WSDL description.

Parameters:

interfaceType - the portType to be added

getInterface

InterfaceType getInterface(javax.xml.namespace.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

removeInterface

InterfaceType removeInterface(javax.xml.namespace.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

getInterfaces

java.util.List<InterfaceType> getInterfaces()

Get all the portTypes defined in this Definition.

addService

void addService(Service service)

Add a service to this WSDL description.

Parameters:

service - the service to be added

getService

Service getService(javax.xml.namespace.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(javax.xml.namespace.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

java.util.List<Service> getServices()

Get all the services defined in this Definition.

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

createBindingOperation

BindingOperation createBindingOperation()

Create a new binding operation.

Returns:

the newly created binding operation

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

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

createEndpoint

Endpoint createEndpoint()

Create a new endpoint.

Returns:

the newly created endpoint

createInterface

InterfaceType createInterface()

Create a new interface.

Returns:

the newly created interface

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

getVersion

Constants.WSDLVersionConstants getVersion()

get the version of the wsdl

getSchemaLocation

java.util.Map<java.lang.String,java.lang.String> getSchemaLocation()

get the schema location

Returns: