org.ow2.dragon.api.service.wsdl
Interface WSDLManager

All Known Implementing Classes:

WSDLManagerImpl

public interface WSDLManager

This class allows to import WSDL file descriptions into the registry and to retrieve them. It also allows to retrieve created ServiceSpecification entities linked to Endpoint or TechnicalService. All method parameters must not be null unless the contrary is specified.

Author:

ofabre - eBM WebSourcing

Method Summary

java.util.List<ServiceSpecificationTO>	getServSpecsForEndpoint(java.lang.String epId) Retrieve the list of service specifications (like WSDL files...) where the given endpoint is described
java.util.List<ServiceSpecificationTO>	getServSpecsForTechServ(java.lang.String techServiceId) Retrieve the list of service specifications (like WSDL files...) where the given tech service is described
java.io.InputStream	getWsdlDesc(java.lang.String servSpecId) Retrieve the WSDL description linked to the given service specification as an input stream
java.lang.String	getWsdlDescAsString(java.lang.String servSpecId) Retrieve the WSDL description linked to the given service specification as a String
java.lang.String[]	importServiceDefFile(org.w3c.dom.Document domDocument) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(org.w3c.dom.Document domDocument, java.util.Map<java.lang.String,org.w3c.dom.Document> imports, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(org.w3c.dom.Document domDocument, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(org.w3c.dom.Element domElement) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry
java.lang.String[]	importServiceDefFile(org.xml.sax.InputSource wsdlContent) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(org.xml.sax.InputSource wsdlContent, java.util.Map<java.lang.String,org.xml.sax.InputSource> imports, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(org.xml.sax.InputSource wsdlContent, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.lang.String wsdlContent) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.lang.String wsdlContent, java.util.Map<java.lang.String,java.lang.String> imports, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.lang.String wsdlContent, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.net.URI wsdlURI) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.net.URI wsdlURI, java.util.Map<java.lang.String,java.net.URI> imports, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.
java.lang.String[]	importServiceDefFile(java.net.URI wsdlURI, java.lang.String wsdlFileName) Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry.

Method Detail

getServSpecsForEndpoint

@Transactional(readOnly=true)
java.util.List<ServiceSpecificationTO> getServSpecsForEndpoint(java.lang.String epId)
                                                               throws WSDLServiceException

Retrieve the list of service specifications (like WSDL files...) where the given endpoint is described

Parameters:

epId - an endpoint ID

Returns:

the List of ServiceSpecificationTOs (like WSDL files...) where the given EndpointTO is described

Throws:

WSDLServiceException - if no endpoint found for the given id

getServSpecsForTechServ

@Transactional(readOnly=true)
java.util.List<ServiceSpecificationTO> getServSpecsForTechServ(java.lang.String techServiceId)
                                                               throws WSDLServiceException

Retrieve the list of service specifications (like WSDL files...) where the given tech service is described

Parameters:

techServiceId - a tech service ID

Returns:

the List of ServiceSpecificationTOs (like WSDL files...) where the given TechnicalServiceTO is described

Throws:

WSDLServiceException - if no tech service found for the given id

getWsdlDesc

@Transactional(readOnly=true)
java.io.InputStream getWsdlDesc(java.lang.String servSpecId)
                                throws WSDLServiceException

Retrieve the WSDL description linked to the given service specification as an input stream

Parameters:

servSpecId - a service spec ID

Returns:

the WSDL description linked to the given ServiceSpecificationTO, as an InputStream

Throws:

WSDLServiceException - if no service spec found for the given id or if the wsdl file content can't be retrieved

getWsdlDescAsString

@Transactional(readOnly=true)
java.lang.String getWsdlDescAsString(java.lang.String servSpecId)
                                     throws WSDLServiceException

Retrieve the WSDL description linked to the given service specification as a String

Parameters:

servSpecId - a service spec ID

Returns:

the WSDL description linked to the given ServiceSpecificationTO, as an String

Throws:

WSDLServiceException - if no service spec found for the given id, if the wsdl file content can't be retrieved or if the wsdl file content can't be converted as string

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.w3c.dom.Document domDocument)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods mustn't be used to import WSDL that uses relative imports of other WSDL (see importServiceDefFile(Document, Map, String))

Parameters:

domDocument - the WSDL description as a DOM Document

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.w3c.dom.Document domDocument,
                                                      java.util.Map<java.lang.String,org.w3c.dom.Document> imports,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

domDocument - the WSDL description as a DOM Document

imports - a Map (key = import location --> value = import content as Document) of all imported WSDL. Could be null

wsdlFileName - the wsdl file name. Could be null

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.w3c.dom.Document domDocument,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods mustn't be used to import WSDL that uses relative imports of other WSDL (see importServiceDefFile(Document, Map, String))

Parameters:

domDocument - the WSDL description as a DOM Document

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.w3c.dom.Element domElement)
                                        throws WSDLServiceException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry

Parameters:

domElement - the WSDL description as a DOM Element

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if an error occurs during description import

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.net.URI wsdlURI)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlURI - URI pointing on a WSDL description

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if an error occurs during description import

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.net.URI wsdlURI,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlURI - URI pointing on a WSDL description

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if an error occurs during description import

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.net.URI wsdlURI,
                                                      java.util.Map<java.lang.String,java.net.URI> imports,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlURI - URI pointing on a WSDL description

imports - a Map (key = import location --> value = import content as URI) of all imported WSDL. Could be null

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import

Throws:

WSDLServiceException - if an error occurs during description import

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.lang.String wsdlContent)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. This methods mustn't be used to import WSDL that uses relative imports of other WSDL (see importServiceDefFile(String, Map, String)). It supports absolute imports. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned.

Parameters:

wsdlContent - the WSDL description content as String

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.lang.String wsdlContent,
                                                      java.util.Map<java.lang.String,java.lang.String> imports,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlContent - the WSDL description content as String

imports - a Map (key = import location --> value = import content as String) of all imported WSDL. Could be null

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(java.lang.String wsdlContent,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlContent - the WSDL description content as String

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.xml.sax.InputSource wsdlContent)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. This methods mustn't be used to import WSDL that uses relative imports of other WSDL (see importServiceDefFile(InputSource, Map, String)). It supports absolute imports. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned.

Parameters:

wsdlContent - the WSDL description content as InputSource

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.xml.sax.InputSource wsdlContent,
                                                      java.util.Map<java.lang.String,org.xml.sax.InputSource> imports,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. This methods mustn't be used to import WSDL that uses relative imports of other WSDL (see importServiceDefFile(InputSource, Map, String)). If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlContent - the WSDL description content as InputSource

imports - a Map (key = import location --> value = import content as InputSource) of all imported WSDL. Could be null

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing

importServiceDefFile

@Transactional(readOnly=false)
java.lang.String[] importServiceDefFile(org.xml.sax.InputSource wsdlContent,
                                                      java.lang.String wsdlFileName)
                                        throws WSDLServiceException,
                                               java.util.concurrent.TimeoutException

Read a WSDL description and add all described entities (Services, Interfaces, Endpoints etc.) in the registry. If you try to register the same wsdl (canonically equals without comments) twice, it will be skipped and a null array is returned. This methods must be used to import WSDL that uses relative imports of other WSDL.

Parameters:

wsdlContent - the WSDL description content as InputSource

wsdlFileName - the wsdl file name. Can be null

Returns:

IDs of all registered tech service as result of the WSDL import, could be null (if no services registered)

Throws:

WSDLServiceException - if the wsdl file can't be read or registered, if the wsdl file signature can't be extracted or if the wsdl file contains inconsistent entities (ex: same interface names but with different operations...)

java.util.concurrent.TimeoutException - if a timeout occured during wsdl parsing