com.ibm.commerce.webservices

Interface OpenWebServiceComponent

  • All Known Implementing Classes:
    OpenWebServiceComponentImpl


    public interface OpenWebServiceComponent
    This is the web service component interface that will accept the document of the web service request. The open web service component should be able to retrieve the standard SOAPElement object from the web services runtime and process the request. The result of processing the request will be the resulting SOAPElement object that will be used to generate the resulting web service response.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright notice field.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      javax.xml.soap.SOAPElement executeService(javax.xml.soap.SOAPElement soapRequestElement)
      This is a generic method that will accept the SOAPElement that represents the body of a web service request.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values
    • Method Detail

      • executeService

        javax.xml.soap.SOAPElement executeService(javax.xml.soap.SOAPElement soapRequestElement)
                                           throws ServiceException
        This is a generic method that will accept the SOAPElement that represents the body of a web service request. It will then execute some service that corresponds to the information it contains. The information within the entire SOAP message will determine the appropriate service to execute. After executing the service, a SOAPElement response is returned that matches the published WSDL.
        Parameters:
        soapElementRequest - The message of the request that needs to be processed. This is the part of the SOAP request that has been mapped in the JAX-RPC mapping as the content of the message.
        Returns:
        This method returns the resulting web service response that matches the published WSDL.
        Throws:
        ServiceException - Thrown if there is a generic processing and the open web service component cannot recover.