Package com.aquima.interactions.portal

Interface IWebServices

All Superinterfaces:
Serializable
All Known Implementing Classes:
WebServices
public interface IWebServices extends Serializable
This interface describes methods retrieve the exposed soap services that are available.
Since:
9.0
Author:
Jon van Leuven

  • Method Details

    • getServiceNames

      String[] getServiceNames()
      This method returns all the available service names.
      Returns:
      The service names, never null, but may be an empty array.

    • getService

      IWebServiceDefinition getService(String name)
      This method returns the service for the specified name.
      Parameters:
      name - The name of the service.
      Returns:
      The service, never null.
      Throws:
      UnknownWebServiceException - This exception is thrown when no service is available for the specified name.

    • writeWsdl

      void writeWsdl(String serviceName, String wsdlName, IResourceResolver resourceResolver, OutputStream result) throws IOException
      This method may be used to write the WSDL for a specified service.
      Parameters:
      serviceName - The name of the service, may not be null.
      wsdlName - The name of the wsdl, when null the main wsdl of the service is used.
      resourceResolver - The resolver to write the resources used, may not be null.
      result - The outputstream to write the resulting data to, may not be null.
      Throws:
      UnknownWebServiceException - This exception is thrown when no service is available for the specified name.
      IOException - This exception is thrown when a problem occurs writing to the result writer.

    • writeXsd

      void writeXsd(String serviceName, String schemaName, IResourceResolver resourceResolver, OutputStream result) throws IOException
      This method may be used to write the XSD for a specified service.
      Parameters:
      serviceName - The name of the service, may not be null.
      schemaName - The name of the schema, may not be null.
      resourceResolver - The resolver to write the resources used, may not be null.
      result - The outputstream to write the resulting data to, may not be null.
      Throws:
      UnknownWebServiceException - This exception is thrown when no service is available for the specified name.
      IOException - This exception is thrown when a problem occurs writing to the result writer.