org.ow2.easywsdl.wsdl.api.abstractItf
Interface AbsItfDescription<S extends AbsItfService,E extends AbsItfEndpoint,B extends AbsItfBinding,I extends AbsItfInterfaceType,Incl extends AbsItfInclude,Impt extends AbsItfImport,T extends AbsItfTypes>

All Superinterfaces:

org.ow2.easywsdl.schema.api.SchemaElement, java.io.Serializable, WSDLElement, org.ow2.easywsdl.schema.api.XMLElement

All Known Subinterfaces:

Description

All Known Implementing Classes:

AbstractDescriptionImpl, DescriptionImpl, DescriptionImpl

public interface AbsItfDescription<S extends AbsItfService,E extends AbsItfEndpoint,B extends AbsItfBinding,I extends AbsItfInterfaceType,Incl extends AbsItfInclude,Impt extends AbsItfImport,T extends AbsItfTypes>
extends WSDLElement

This interface represents a WSDL definition.

Author:

Nicolas Salatge - eBM WebSourcing

Nested Class Summary

static class

AbsItfDescription.WSDLVersionConstants Constants for WSDL version.

Method Summary

void	addBinding(B binding) Add a binding to this WSDL description.
void	addImport(Impt importDef) Add an import to this WSDL description.
void	addInclude(Incl includeDef) Add an include to this WSDL description.
void	addInterface(I 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(S service) Add a service to this WSDL description.
B	createBinding() Create a new binding.
B	createDefaultSoapBinding(java.lang.String bindingName, E endpoint, I itf) Create default soap binding
Impt	createImport() Create a new import.
I	createInterface() Create a new interface.
S	createService() Create a new service.
T	createTypes() Create a new types section.
java.util.List<E>	findEndpointsImplementingInterface(I itf)
B	getBinding(javax.xml.namespace.QName name) Get the specified binding.
java.util.List<B>	getBindings() Get all the bindings defined in this Definition.
java.net.URI	getDocumentBaseURI() Get the document base URI of this definition.
java.util.List<Impt>	getImports() Get a map of lists containing all the imports defined here.
java.util.List<Impt>	getImports(java.lang.String namespaceURI) Get the list of imports for the specified namespaceURI.
Incl	getInclude(java.net.URI locationURI) Get the include of the specified locationURI.
java.util.List<Incl>	getIncludes() Get a map of lists containing all the includes defined here.
I	getInterface(javax.xml.namespace.QName name) Get the specified portType.
java.util.List<I>	getInterfaces() Get all the portTypes defined in this Definition.
org.ow2.easywsdl.schema.api.extensions.NamespaceMapperImpl	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
S	getService(javax.xml.namespace.QName name) Get the specified service.
java.util.List<S>	getServices() Get all the services defined in this Definition.
java.lang.String	getTargetNamespace() Get the target namespace in which the WSDL elements are defined.
T	getTypes() Get the types section.
AbsItfDescription.WSDLVersionConstants	getVersion() get the version of the wsdl
B	removeBinding(javax.xml.namespace.QName name) Remove the specified binding from this definition.
Impt	removeImport(Impt importDef) Remove an import from this WSDL description.
Incl	removeInclude(Incl includeDef) Remove an include from this WSDL description.
I	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.
S	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(T types) Set the types section.

Methods inherited from interface org.ow2.easywsdl.schema.api.XMLElement

addOtherElements, getOtherElements

Methods inherited from interface org.ow2.easywsdl.schema.api.SchemaElement

createDocumentation, equals, getDocumentation, getOtherAttributes, hashCode, setDocumentation

Method Detail

getDocumentBaseURI

java.net.URI getDocumentBaseURI()

Get the document base URI of this definition.

Returns:

the document base URI.

setDocumentBaseURI

void setDocumentBaseURI(java.net.URI documentBaseURI)

Set the document base URI of this definition.

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

org.ow2.easywsdl.schema.api.extensions.NamespaceMapperImpl 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(T types)

Set the types section.

getTypes

T getTypes()

Get the types section.

Returns:

the types section

addImport

void addImport(Impt importDef)

Add an import to this WSDL description.

Parameters:

importDef - the import to be added

removeImport

Impt removeImport(Impt importDef)

Remove an import from this WSDL description.

Parameters:

importDef - the import to be removed

Returns:

the removed ImportImpl

getImports

java.util.List<Impt> 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<Impt> 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(Incl includeDef)
                throws WSDLException

Add an include to this WSDL description.

Parameters:

includeDef - the include to be added

Throws:

WSDLException

removeInclude

Incl removeInclude(Incl includeDef)
                                         throws WSDLException

Remove an include from this WSDL description.

Parameters:

includeDef - the include to be removed

Returns:

the removed include

Throws:

WSDLException

getInclude

Incl getInclude(java.net.URI locationURI)

Get the include of the specified locationURI.

Parameters:

locationURI - the locationURI associated with the desired includes.

Returns:

the corresponding include, or null if there weren't any matching includes

getIncludes

java.util.List<Incl> 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(B binding)

Add a binding to this WSDL description.

Parameters:

binding - the binding to be added

getBinding

B 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

B 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<B> getBindings()

Get all the bindings defined in this Definition.

addService

void addService(S service)

Add a service to this WSDL description.

Parameters:

service - the service to be added

getService

S 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

S 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<S> getServices()

Get all the services defined in this Definition.

createBinding

B createBinding()

Create a new binding.

Returns:

the newly created binding

createImport

Impt createImport()
                                       throws WSDLException,
                                              WSDLImportException

Create a new import.

Returns:

the newly created import

Throws:

WSDLException

WSDLImportException - if the import can't be correctly parsed

createInterface

I createInterface()

Create a new interface.

Returns:

the newly created interface

createService

S createService()

Create a new service.

Returns:

the newly created service

createTypes

T createTypes()

Create a new types section.

Returns:

the newly created types section

getVersion

AbsItfDescription.WSDLVersionConstants getVersion()

get the version of the wsdl

getSchemaLocation

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

get the schema location

Returns:

addInterface

void addInterface(I interfaceType)

Add a portType to this WSDL description.

Parameters:

abstractInterfaceType - the portType to be added

getInterface

I 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

I 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<I> getInterfaces()

Get all the portTypes defined in this Definition.

createDefaultSoapBinding

B createDefaultSoapBinding(java.lang.String bindingName,
                           E endpoint,
                           I itf)

Create default soap binding

findEndpointsImplementingInterface

java.util.List<E> findEndpointsImplementingInterface(I itf)