pub.soap.handler:registerWmConsumer

Integration Server 10.3 | Built-In Services Reference Guide | SOAP Folder | Summary of Elements in this Folder | pub.soap.handler:registerWmConsumer

WmPublic. Registers a handler for use with consumer.

Input Parameters

descriptiveName	String Name to assign to the consumer header handler. Each consumer header handler must have a unique name.
QNameList	Document List Optional. Qualified names of the headers on which the handler operates. In the document list, each document references the pub.soap.utils:QName document type.
handleRequestService	String Optional. Fully qualified name of the service to use as the request header handler.
handleResponseService	String Optional. Fully qualified name of the service to use as the response header handler.
handleFaultService	String Optional. Fully qualified name of the service to use as the fault header handler.

Output Parameters

None.

Usage Notes

This service replaces pub.soap.handler:registerConsumer, which is deprecated.

Before you register a consumer header handler, create the services that will act as the request, response, and fault header handlers.

Integration Server stores information about registered header handlers in memory. Integration Server does not persist registered header handler information across restarts. Consequently, you must register header handlers each time Integration Server starts. To accomplish this, create a service that registers a header handler and make that service a start up service for the package that contains the services that act as header handlers.

You can use a consumer header handler with consumer (WSD) only.

Specify a value for QNameList if you want to associate with handler with one or more QNames. Registering QNames with a handler provides the following benefits:

Integration Server can perform mustUnderstand checking for the header with the QName at run time. If a service receives a SOAP message in which a header requires mustUnderstand processing by the recipient, Integration Server uses the header QName to locate the handler that processes the header. Note that the handler must be part of the handler chain for the WSD that contains the service.

When adding headers to a WSD, Designer populate the list of IS document types that can be used as headers in the WSD with the IS document types whose QNames were registered with the handlers already added to the WSD. If you add a IS document type as a header to a WSD and the QName of that IS document type is not associated with a handler, Designer add the header but display a warning stating that there is not an associated handler.

When consuming WSDL to create a provider or consumer WSD, Integration Server automatically adds a handler to the resulting WSD if the WSDL contains a QName supported by the handler.

Use the pub.soap.handler:registerWmProvider service to register a header handler for use with provider.

To unregister a consumer header handler, use the pub.soap.handler:unregisterConsumer service.

If you specify a service that does not exist for handleRequest, handleResponse, or handleFaultService, Integration Server throws this error:

[ISS.0088.9421] The service <serviceName> does not exist.

If a registered handler with the same descriptiveName already exists, Integration Server throws this error.

[ISS.0088.9423] Service handler <handlerName> is already registered.