Integration Server 10.11 | Web Services Developer’s Guide | About Handlers and Handler Services | About Request Handler Services | Request Handler Services and Status Codes
 
Request Handler Services and Status Codes
Each request handler service must return a status code. The status code is an integer from 0–3, indicates the success or failure of the request handler service, and indicates how Integration Server will proceed.
*For a consumer web service descriptor, the request handler service status determines whether or not Integration Server sends the SOAP request to the web service provider. Integration Server sends the SOAP request only after all request handler services in the handler chain return a status code of 0. If a request handler service returns a status code of 1, 2, or 3, handler chain processing stops and Integration Server does not send the SOAP request to the provider.
*For a provider web service descriptor, the request handler service status determines whether or not Integration Server invokes the endpoint service. Integration Server invokes the endpoint service only after all request handler services in the handler chain return a status code of 0. If a request handler service returns a status code of 1, 2, or 3, handler chain processing stops and Integration Server does not invoke the endpoint service.
The following table describes the meaning of each status code for a request handler service and the action Integration Server takes based on the status code.
Status Code
Description
0
Indicates that the request handler service executed successfully. Integration Server executes the next request handler service in the handler chain.
Consumer Side Behavior
If this is the last handler in the handler chain, Integration Server sends the SOAP request to the web service provider.
Provider Side Behavior
If this is the last handler in the handler chain Integration Server invokes the endpoint service, passing in data from the SOAP request.
1
Indicates that the handler service ended in failure. Integration Server suspends execution of the handler chain. Integration Server then invokes the response handler service for each handler that has already executed in the handler chain. Integration Server starts with the current handler and continues in reverse order until it invokes all the response handlers for the executed request handlers in the handler chain.
Consumer Side Behavior
If the request handler failed while processing a SOAP request for a consumer web service descriptor, Integration Server does not send the SOAP request to the provider.
Integration Server places the following exception in the fault document returned by the web service connector:
[ISS.0088.9431] Handler processing failed on the consumer: requestHandlerService
Provider Side Behavior
If the request handler failed while processing a SOAP request for a provider web service descriptor, Integration Server does not invoke the endpoint service.
Integration Server constructs a SOAP fault and places it in the message context which can be accessed by the response handler services. The SOAP fault contains the following information:
[ISS.0088.9431] Handler processing failed on the provider: requestHandlerService
2
Indicates that the request handler service ended in failure. Integration Server suspends execution of the handler chain.
Consumer Side Behavior
If the request handler failed while processing a SOAP request for a consumer web service descriptor, Integration Server places the following exception in the fault document returned by the web service connector:
[ISS.0088.9431] Handler processing failed on the consumer: faultMessage
Where faultMessage is the content of the faultMessage parameter returned by the request handler service.
Integration Server does not send the SOAP request to the provider.
Provider Side Behavior
If the request handler failed while processing a SOAP request for a provider web service descriptor, Integration Server constructs a SOAP fault that contains the following information:
[ISS.0088.9431] Handler processing failed on the provider: faultMessage
Where faultMessage is the content of the faultMessage parameter returned by the request handler service.
Integration Server does not invoke the endpoint service.
3
Indicates that the request handler service ended in failure. Integration Server suspends execution of the handler chain. Integration Server then invokes the fault handler service for each handler that has already executed in the handler chain. Integration Server starts with the current handler and continues in reverse order until it invokes all the fault handlers for the request handlers executed in the handler chain.
Note:
One of the fault handler services in the handler chain should contain logic that constructs a SOAP fault message. If it does not, the SOAP fault message will be empty. This service also needs to replace the SOAP message in the current message context with the SOAP fault message.
Consumer Side Behavior
If the request handler failed while processing a SOAP request for a consumer web service descriptor, Integration Server does not send the SOAP request to the provider.
Provider Side Behavior
If the request handler failed while processing a SOAP request for a provider web service descriptor, Integration Server does not invoke the endpoint service.