WSDL and message exchange patterns
A WSDL 2.0 document contains a message exchange pattern (MEP) that defines the way that SOAP 1.2 messages are exchanged between the web service requester and web service provider.
CICS® supports four out of the eight message exchange patterns that are defined in the WSDL 2.0 Part 2: Adjuncts specification and the WSDL 2.0 Part 2: Additional MEPs specification for both service provider and service requester applications. The following MEPs are supported:
- In-Only
- A request message is sent to the web service provider, but the
provider is not allowed to send any type of response to the web service
requester.
- In provider mode, when CICS receives a request message from a web service that uses the In-Only MEP, it does not return a response message. The DFHNORESPONSE container is put in the SOAP handler channel to indicate that the pipeline must not send a response message.
- In requester mode, CICS sends the request message to the web service provider and does not wait for a response.
- In-Out
- A request message is sent to the web service provider, and a response
message is returned to the web service requester. The response message
could be a normal SOAP message or a SOAP fault.
- In provider mode, when CICS receives a request message from a web service that uses the In-Out MEP, it returns a response message to the requester.
- In requester mode, CICS sends a request message and waits for a response. This response is either a normal response message or a SOAP fault message. The length of time that CICS waits for a response is configured in the pipeline and applies to all web services using that pipeline. If the request times out before CICS receives a response, an error is returned to the service requester application.
- In-Optional-Out
- A request message is sent to the web service provider, and a response
message is optionally returned to the web service requester. If there
is a response, it could be either a normal SOAP message or a SOAP
fault.
- In provider mode, the decision about whether to return a SOAP response message, a SOAP fault, or no response, happens at run time and is dependant on the service provider application logic. If CICS does not send a response to the web service requester, the DFHNORESPONSE container is put in the SOAP handler channel to indicate that the pipeline must not send a response message. If no message is sent, the service provider application must delete the DFHWS-DATA container from the channel.
- In requester mode, CICS sends a request message and waits for a response from the web service requester. If the request times out before a response is received, CICS assumes that the message was received successfully and that the provider did not need to send a response. The length of time that CICS waits for a response is configured in the pipeline and applies to all web services using that pipeline.
- Robust In-Only
- A request message is sent to the web service provider, and a response
message is only returned to the web service requester if an error
occurs. If there is an error, a SOAP fault message is sent to the
requester.
- In provider mode, if the pipeline successfully passes the request message to the application, a DFHNORESPONSE container is put in the SOAP handler channel to indicate that the pipeline must not send a response message. If an error occurs in the pipeline, a SOAP fault message is returned to the requester.
- In requester mode, CICS sends the request message to the web service provider and waits for a specified period before timing out. The length of time that CICS waits for a response is configured in the pipeline and applies to all web services using that pipeline. If there is a timeout, CICS assumes that the request message was received successfully.
For more information on message exchange patterns in WSDL
2.0, see the following W3C specifications:
- WSDL 2.0 Part 2: Adjuncts: http://www.w3.org/TR/2007/REC-wsdl20-adjuncts-20070626/.
- WSDL 2.0 Part 2: Additional MEPs: http://www.w3.org/TR/wsdl20-additional-meps/.