WSACONTEXT GET

Use the WSACONTEXT GET command in a service provider to get the message addressing properties (MAPs) sent by the service requester. Use the WSACONTEXT GET command in a service requester to get the MAPs of the reply message. This command cannot be used by Axis2 applications hosted in an Axis2 pipeline in CICS.
Read syntax diagramSkip visual syntax diagram
WSACONTEXT GET

>>-WSACONTEXT GET--CONTEXTTYPE(cvda)--+---------------------+--->
                                      '-CHANNEL(data-value)-'   

   .-------------------------------------------------------------------------------------.   
   V                                                                                     |   
>----+-ACTION(data-area)---------------------------------------------------------------+-+-->
     +-MESSAGEID(data-area)------------------------------------------------------------+     
     +-RELATESURI(data-area)--+------------------------+--+--------------------------+-+     
     |                        '-RELATESTYPE(data-area)-'  '-RELATESINDEX(data-value)-' |     
     '-EPRTYPE(cvda)-EPRFIELD(cvda)--+-EPRINTO(data-area)-+--EPRLENGTH(data-area)------'     
                                     '-EPRSET(ptr-ref)----'                                  

>--+--------------------------+--------------------------------><
   +-INTOCCSID(data-value)----+   
   '-INTOCODEPAGE(data-value)-'   

Conditions: CCSIDERR, CHANNELERR, CODEPAGEERR, INVREQ, LENGERR, NOTFND

This command is threadsafe.

Description

The WSACONTEXT GET command is used in a service provider to get the MAPs of the requester from the addressing context, or in a service requester to get the MAPs of the provider from the response message. The WSACONTEXT GET command can be called repeatedly to return different MAPs.

Options

ACTION(data-area)
Specifies an output area to contain the Action MAP of the request or response SOAP message. The data area must be 255 characters in length. If the Action MAP is fewer than 255 characters, CICS® pads the data area with trailing blanks.
CHANNEL(data-value)
Specifies the name of the channel that holds the addressing context. The name of the channel can be up to 16 characters in length. If the channel name is fewer than 16 characters, you must pad the data value with trailing blanks. If you do not specify this option, the current channel is implied.

Acceptable characters for the channel name are A-Z a-z 0-9 $ @ # / % & ? ! : | " = , ; < > . - and _. Leading and embedded blank characters are not permitted. The accepted set of characters for channel names includes some characters that do not have the same representation in all EBCDIC code pages. It is therefore recommended that, if channels are to be shipped between regions, the characters used in naming them should be restricted to A-Z a-z 0-9 & : = , ; < > . - and _.

This option is required when the WSACONTEXT GET command is used by a web service requester application and is the channel name used by subsequent INVOKE SERVICE commands.
CONTEXTTYPE(cvda)
Specifies which type of addressing context to fetch the MAPs from. CVDA values are as follows:
REQCONTEXT
Addressing context containing the request. Either a web service requester, or a web service provider application can access the MAPs in this addressing context.
RESPCONTEXT
Addressing context containing the response. Only a web service requester application can access the MAPs in this addressing context.
EPRFIELD(cvda)
Specifies the part of the endpoint reference that is to be returned in the EPRINTO data area. CVDA values are as follows:
ADDRESS
Return the Address field of the endpoint reference.
ALL
Return the complete endpoint reference in XML.
METADATA
Return the Metadata section of the endpoint reference in XML.
REFPARMS
Return the ReferenceParameters section of the endpoint reference in XML.
EPRINTO(data-area)
An output data area used to contain the complete or partial endpoint reference. The EPRINTO and EPRSET options are mutually exclusive.
If the EPRINTO option contains an address, any special characters in the address are automatically escaped or unescaped.
The following characters in an address are replaced with an escape sequence:

", >, <, ', &

EPRLENGTH(data-area)
Specifies the length, as a halfword binary value, of the endpoint reference.
If you specify the EPRINTO option, you must specify a value for EPRLENGTH unless the length can be generated by the compiler from the EPRINTO option.
The EPRLENGTH option defines the maximum length of data that the program accepts. If the value specified is less than zero, zero is assumed. If the length of the data exceeds the value specified, the data is truncated to that value and the LENGERR condition occurs.
EPRSET(ptr-ref)
Specifies the pointer reference that is set to the address of the output data area used to contain the complete or partial endpoint reference. The pointer reference, unless changed by other commands or statements, is valid until the next WSACONTEXT GET command or the end of the task. The EPRINTO and EPRSET options are mutually exclusive.
EPRTYPE(cvda)
Specifies the type of endpoint reference that is being requested. CVDA values are as follows:
TOEPR
The destination endpoint reference to which a SOAP message is sent.
REPLYTOEPR
An endpoint reference to which a SOAP response message is returned.
FAULTTOEPR
An endpoint reference to which a SOAP fault message is returned.
FROMEPR
An endpoint reference that represents the sender of the SOAP message.
INTOCCSID(data-value)
Specifies the Coded Character Set Identifier (CCSID) into which the character data in the addressing context is to be converted, as a fullword binary number. If you prefer to specify an IANA name for the code page, or if you prefer to specify the CCSID as alphanumeric characters, use the INTOCODEPAGE option instead.

For CICS Transaction Server for z/OS applications, the CCSID is typically an EBCDIC CCSID.

For an explanation of CCSIDs, and a list of the CCSIDs supported by CICS, see CICS-supported conversions.

INTOCODEPAGE(data-value)
Specifies an IANA-registered alphanumeric charset name or a Coded Character Set Identifier (CCSID) for the code page into which the character data in the addressing context is to be converted, using up to 40 alphanumeric characters, including appropriate punctuation. Use this option instead of the CCSID option if you prefer to use an IANA-registered charset name, as specified in the Content-Type header for an HTTP request. CICS converts the IANA name into a CCSID, and the subsequent data conversion process is identical. Also use this option if you prefer to specify the CCSID in alphanumeric characters, rather than as a fullword binary number.

Where an IANA name exists for a code page and CICS supports its use, the name is listed with the CCSID in CICS-supported conversions.

MESSAGEID(data-area)
Specifies an output area to contain the MessageID MAP of the request or response SOAP message. The data area must be 255 characters in length. If the MessageID MAP is less than 255 characters, CICS pads the data area with trailing blanks.
RELATESINDEX(data-value)
Specifies a numeric value that indicates which RelatesTo MAP to return. If this value is not specified, the first RelatesTo MAP is returned. The index starts at 1. If the value of the index is greater than the number of RelatesTo MAPs, spaces are returned in the RELATESTYPE and RELATESURI data areas.
RELATESTYPE(data-area)
Specifies an output area that contains a URI denoting the relationship type between this message and another message. The data area must be 255 characters in length. If the URI is less than 255 characters, CICS pads the data area with trailing blanks.
RELATESURI(data-area)
Specifies an output area that contains the RelatesTo MAP relationship URI between this message and another. The data area must be 255 characters in length. If the MessageID MAP is less than 255 characters, CICS pads the data area with trailing blanks.

Conditions

123 CCSIDERR
RESP2 values:
1
The CCSID specified on the INTOCCSID option is outside the range of valid CCSID values.
2
The CCSID specified on the INTOCCSID option and the CCSID of the addressing context are an unsupported combination.
4
One or more characters could not be converted. Each unconverted character has been replaced by a blank in the converted data.
5
There was an internal error in the code page conversion of the addressing context data.
122 CHANNELERR
RESP2 values:
1
The name specified for the CHANNEL option contains an incorrect character or combination of characters.
2
The channel specified was not located.
125 CODEPAGEERR
RESP2 values:
1
The code page specified on the INTOCODEPAGE option is not supported.
2
The code page specified on the INTOCODEPAGE option and the CCSID of the addressing context are an unsupported combination.
4
One or more characters could not be converted. Each unconverted character has been replaced by a blank in the converted data.
5
There was an internal error in the code page conversion of a container.
16 INVREQ
RESP2 values:
4
The CHANNEL option was not specified. There is no current channel because the program that issued the command was not passed the name of a channel.
11
The RELATESINDEX option is not valid.
12
The RELATESINDEX option is greater than the number of RelatesTo MAPs.
22 LENGERR
RESP2 values:
20
This condition occurs when the length of the stored data is greater than the value specified by the EPRLENGTH option. This condition only applies to the EPRINTO option and cannot occur with the EPRSET option.
Default action: ends the task abnormally.
13 NOTFND
RESP2 values:
3
The addressing context was not located.


dfhp4_wsacontextget.html | Timestamp icon Last updated: Thursday, 27 June 2019