pub.soap.handler:handlerSpec

Hybrid Integration 10.1 | Integrating On-Premises Applications | Integration Server Built-In Services | SOAP Folder | pub.soap.handler:handlerSpec

WmPublic. Specification to use as the signature for a service that acts as a header handler.

Input Parameters

messageContext

Object Message context to be processed by the header handler.

A message context contains properties for the SOAP message and provides access to the SOAP message. Integration Server creates the message context and passes it to the header handler. All handlers invoked by a given instance of a SOAP request or SOAP response use the same message context, which enables you to use the message context to pass information among handlers.

Output Parameters

statusCode

String Specifies the status of the handler service execution which indicates the action Integration Server will take next. The statusCode parameter must be an integer from 0-3. The action Integration Server takes for a particular status code depends on whether the service is registered as a request handler, response handler, or fault handler. For more information, see Web Services Developer’s Guide or Software AG Designer Online Help.

If statusCode does not contain one of the specified values, Integration Server assumes a value of 0.

faultMessage

String Conditional. Text to be used in the fault message. Integration Server uses the faultMessage value for any handler service that returns a status of 2 and when a response handler service returns a status of 3. For more information, see Web Services Developer’s Guide or Software AG Designer Online Help.

Usage Notes

Services that act as header handlers do not need to use the pub.handler:handlerSpec specification to define the signature of the service. However, services that act as header handlers must take the input parameters and produce the output parameters identified in this specification.

This specification can be used as the signature for the any handler service (request, response, or fault).

Integration Server altered handler chain processing in version 8.0 SP1. If you want created in Integration Server version 7.x of 8.0 to use the handler chain processing behavior available in Integration Server 7.x and 8.0, set the watt.server.ws.71xHandlerChainBehavior server configuration parameter to true. For more information about setting server configuration parameters, see webMethods Integration Server Administrator’s Guide.