Integration Server 10.15 | Web Services Developer’s Guide | Working with Web Service Connectors | Signature for a Web Service Connector | About Transport and Fault Information Returned by a Web Service Connector
 
About Transport and Fault Information Returned by a Web Service Connector
The transport information, such as headers, status codes, and status messages, returned by a web service connector created on Integration Server 8.2 or later varies depending on the following:
*The transport used to send and receive the SOAP message
*The success or failure of the web service connector
*The point at which failure occurs
*The message exchange pattern (MEP) for the operation
The preceding conditions also determine whether the fault document returned by the web service connector contains a SOAP fault or an exception. The fault document contains a SOAP fault when a SOAP fault occurs. The fault document contains an exception when an exception occurs wile executing the web service connector.
The following table identifies the basic success and failure scenarios for web service connector execution and the transport information that would be returned in each scenario. The table also indicates whether the scenario results in a SOAP fault or an exception being returned in the fault document.
Note:
JMS status codes as well as the status code 900 are specific to Integration Server.
Use Case
Web service connector execution fails before sending the SOAP request.
Possible causes for this include improper message construction that results from validation failure for transport header information, consumer request handler failure, or WS-Security failure.
Parameter
Description
status
900
statusMessage
Error occurred while preparing SOAP request
requestHeaders returned?
Yes, if the web service connector created the SOAP request successfully but execution failed before sending the request.
responseHeaders returned?
No
fault contains fault or exception?
Exception
Use Case
Web service connector execution fails while sending the SOAP request.
Possible causes include an inaccessible HTTP server or JMS provider, an error from the HTTP server, or an exception thrown by the JMS provider.
Parameter
Description
status
For HTTP, the status code will be the value returned by the HTTP server.
For JMS, the status code will be: 400
statusMessage
For HTTP, the status message will be the message returned by the HTTP server.
For JMS, the status message will be: Error occurred while sending request to JMS provider
requestHeaders returned?
Yes
responseHeaders returned?
For HTTP, responseHeaders may be returned. For example, when the provider returns a status code in the 300 range or 400 range, it is possible that the provider populated responseHeaders.
fault contains fault or exception?
Exception
If web service connector execution fails while using the JMS protocol to send the SOAP request, the fault document contains the lastError/$errorType field. This field indicates whether the exception was caused by a transient error or a ServiceException. $errorType will be one of the following:
*com.wm.app.b2b.server.ServiceException
*com.wm.app.b2b.server.ISRuntimeException
Use Case
Web service connector execution fails while sending the SOAP request because a timeout occurs.
Possible causes include failure to receive a response from the HTTP server within the timeout period or failure to receive a JMS response message within the timeout period.
Parameter
Description
status
408
statusMessage
Timeout
requestHeaders returned?
Yes
responseHeaders returned?
No
fault contains fault or exception?
Exception
Use Case
Web service connector executes successfully.
Parameter
Description
status
For HTTP, the status code will be the value returned by the HTTP server. The status code will typically be in the 200 range.
For JMS and an In-Out or Robust In-Only operation, the status code will be: 200
For JMS and an In-Only operation, the status code will be: 202
statusMessage
For HTTP, the status message will be the message returned by the HTTP server.
For JMS, the status message will be: OK
requestHeaders returned?
Yes
responseHeaders returned?
Dependent on the MEP of the operation.
*For In-Only and Robust In-Only operation, responseHeaders is not returned.
*For a synchronous In-Out operation, responseHeaders is returned.
fault contains fault or exception?
Not applicable.
Use Case
Web service connector executes successfully but the JMS provider is not available, causing Integration Server to write the JMS message to the client side queue.
Note:
This use case applies to JMS only. It occurs only when the client side queue is enabled for the JMS binder.
Parameter
Description
status
300
statusMessage
Message written to the client side queue
requestHeaders returned?
Yes
responseHeaders returned?
No
fault contains fault or exception?
Not returned.
Use Case
Web service connector sends a SOAP request successfully but receives a SOAP fault from the web service provider.
OAP faults can result from:
*Absence of required data from the client.
*Failed processing by the web service provider.
*Failed request handlers on the provider.
*WS-Security processing failures on the provider.
Parameter
Description
status
For HTTP, the status code will be the value returned by the HTTP server. The status code will typically be in the 500 range.
For JMS, the status code will be: 500
statusMessage
For HTTP, the status message will be the message returned by the HTTP server.
For JMS, the status message will be: SOAP Fault
requestHeaders returned?
Yes
responseHeaders returned?
Yes
fault contains fault or exception?
SOAP Fault
Use Case
Web service connector execution fails while processing the SOAP response.
Possible causes include output signature validation failure, response handler failure on the consumer, or incorrect conversion of the SOAP response to IData.
Parameter
Description
status
900
statusMessage
Error occurred while processing SOAP response
requestHeaders returned?
Yes
responseHeaders returned?
Yes
fault contains fault or exception?
Exception
Note:
Transport information is returned in the transportInfo output parameter. For more information about this parameter, see Signature for a Web Service Connector.
Note:
If you want to drop the extra response document that the web service connector service adds to the output in the pipeline, you must add a MAP step to do so at the end of the web service connector service.