INQUIRE URIMAP

Retrieve information about URIMAP resources in the local system.

Read syntax diagramSkip visual syntax diagramINQUIRE URIMAP
 
                              .-----------------------------.
                              V                             |
>>-INQUIRE URIMAP(data-area)----+-------------------------+-+--><
                                +-ENABLESTATUS(cvda)------+
                                +-USAGE(cvda)-------------+
                                +-HOST(data-area)---------+
                                +-PATH(data-area)---------+
                                +-MEDIATYPE(data-area)----+
                                +-CHARACTERSET(data-area)-+
                                +-HOSTCODEPAGE(data-area)-+
                                +-TEMPLATENAME(data-area)-+
                                +-HFSFILE(data-area)------+
                                +-TCPIPSERVICE(data-area)-+
                                +-ANALYZERSTAT(cvda)------+
                                +-CONVERTER(data-area)----+
                                +-TRANSACTION(data-area)--+
                                +-PROGRAM(data-area)------+
                                +-PIPELINE(data-area)-----+
                                +-WEBSERVICE(data-area)---+
                                +-USERID(data-area)-------+
                                +-CERTIFICATE(data-area)--+
                                +-CIPHERS(data-area)------+
                                +-NUMCIPHERS(data-area)---+
                                +-REDIRECTTYPE(cvda)------+
                                '-LOCATION(data-area)-----'
 

Conditions: END, ILLOGIC, NOTAUTH, NOTFND

This command is threadsafe.

Description

The INQUIRE URIMAP command allows you to retrieve information about a particular URIMAP definition. The USAGE attribute of a URIMAP definition determines which other attributes are specified in that URIMAP definition, and sometimes determines the meaning of a particular attribute.

Browsing

You can also browse through all the URIMAP definitions installed in the region, using the browse options (START, NEXT, and END) on INQUIRE URIMAP commands.

Options

URIMAP(data-value)
specifies the 8-character name of a URIMAP definition.
ANALYZERSTAT(cvda)
returns a CVDA value indicating whether the analyzer program associated with the TCPIPSERVICE definition is to be run. CVDA values are:
ANALYZER
The analyzer program is to be run.
NOANALYZER
The analyzer program is not to be run.
This attribute is for USAGE(SERVER). For all other usage types it is forced to NO.
CERTIFICATE(data-area)
returns a 32-character data area containing the label of the certificate that is to be used as the SSL client certificate for the HTTP request by CICS® as an HTTP client. This attribute is for USAGE(CLIENT).
CHARACTERSET(data-area)
returns a 40-character data area containing the name of the character set to be used for the static response. This attribute is for USAGE(SERVER).
CIPHERS(data-area)
returns a 56-character data area containing the list of cipher suites specified for the URIMAP definition. The list of cipher suites is used to negotiate SSL connections. This attribute is for USAGE(CLIENT).
CONVERTER(data-area)
returns the 8-character name of a converter program that performs conversion or other processing for CICS as an HTTP server. This attribute is for USAGE(SERVER).
ENABLESTATUS(cvda)
returns a CVDA value indicating the status of this URIMAP definition. CVDA values are:
ENABLED
The URIMAP definition is enabled.
DISABLED
The URIMAP definition is disabled. A URIMAP definition with this status can be discarded.
DISABLEDHOST
The URIMAP definition is unavailable because the virtual host of which it is a part has been disabled. The SET HOST command can be used to re-enable all the URIMAP definitions that make up the virtual host. A URIMAP definition with this status cannot be discarded.
HFSFILE(data-area)
returns a 255-character data area containing fully qualified (absolute) or relative name of a z/OS® UNIX System Services HFS file that forms a static response. This attribute is for USAGE(SERVER).
HOST(data-area)
returns a 116-character data area containing the host component of the URI to which the URIMAP definition applies (for example, www.example.com). This attribute is for any usage type.
HOSTCODEPAGE(data-area)
returns a 10-character data area containing the 1-10 character name of the IBM® code page (EBCDIC) in which the text document that forms the static response is encoded. This attribute is for USAGE(SERVER).
LOCATION(data-area)
returns a 255-character area containing a URL to which matching HTTP requests from Web clients are redirected. Redirection is activated by the setting specified by the REDIRECTTYPE option. This attribute is for USAGE(SERVER) or USAGE(PIPELINE).
MEDIATYPE(data-area)
returns a 56-character data area containing a description of the data content of the static response. This attribute is for USAGE(SERVER).
NUMCIPHERS(data-area)
returns a halfword binary value containing the number of cipher codes in the CIPHERS list. The ciphers are used to negotiate encryption levels as part of the SSL handshake. This attribute is for USAGE(CLIENT).
PATH(data-area)
returns a 255-character data area containing the path component of the URL to which the URIMAP definition applies (for example, software/htp/cics/index.html). This attribute is for any usage type.
PIPELINE(data-area)
returns the 8-character name of the PIPELINE resource definition for the Web service. The PIPELINE resource definition provides information about the message handlers which act on the service request from the client. This attribute is for USAGE(PIPELINE).
PROGRAM(data-area)
returns the 8-character name of the application program that composes an application-generated response to the HTTP request. This attribute is for USAGE(SERVER).
SCHEME(cvda)
returns a CVDA value indicating the scheme component of the URI. CVDA values are:
HTTP
HTTP without SSL.
HTTPS
HTTP with SSL.
This attribute is for any usage type.
TCPIPSERVICE(data-area)
returns the 1- to 8-character name of the TCPIPSERVICE definition that specifies an inbound port to which this URIMAP definition relates. If this is not specified, the URIMAP definition applies to a request on any inbound ports. This attribute is for USAGE(SERVER) or USAGE(PIPELINE).
TEMPLATENAME(data-area)
returns a 48-character data area containing the name of a CICS document template that is used to form a static response. This attribute is for USAGE(SERVER).
TRANSACTION(data-area)
returns the 4-character name of an alias transaction to run the user application that composes a response to the HTTP request. This attribute is for USAGE(SERVER) or USAGE(PIPELINE).
REDIRECTTYPE(cvda)
returns a CVDA value indicating the type of redirection for requests that match this URIMAP definition. The URL for redirection is specified by the LOCATION option. This attribute is for USAGE(SERVER) or USAGE(PIPELINE). CVDA values are:
NONE
Requests are not redirected. Any URL specified by the LOCATION option is ignored.
TEMPORARY
Requests are redirected on a temporary basis. The status code used for the response is 302 (Found).
PERMANENT
Requests are redirected permanently. The status code used for the response is 301 (Moved Permanently).
USAGE(cvda)
returns a CVDA value indicating the purpose of this URIMAP definition. CVDA values are:
SERVER
A URIMAP definition for CICS as an HTTP server. This type of URIMAP definition is used to map the URL of an incoming HTTP request from a Web client, to CICS resources. An application-generated response or a static response can be provided.
CLIENT
A URIMAP definition for CICS as an HTTP client. This type of URIMAP definition is used when CICS makes a client request for an HTTP resource on a server.
PIPELINE
A URIMAP definition for a Web service. This type of URIMAP definition is used to specify the processing that is to be performed on a request by which a client invokes a Web service in CICS.
USERID(data-area)
returns the 8-character user ID under which the alias transaction is attached. This attribute is for USAGE(SERVER) or USAGE(PIPELINE).
WEBSERVICE(data-area)
returns the name of a Web service. This can be the 1-8 character name of a WEBSERVICE resource definition, or a name up to 32 characters representing a Web service generated by the CICS Web services assistant. This defines aspects of the run time environment for a CICS application program deployed in a Web services setting. This attribute is for USAGE(PIPELINE).

Conditions

END
RESP2 values are:
2
There are no more resource definitions of this type.
ILLOGIC
RESP2 values are:
1
You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.
NOTAUTH
RESP2 values are:
100
The user associated with the issuing task is not authorized to use this command.
NOTFND
RESP2 values are:
3
The URIMAP cannot be found.
[[ Contents Previous Page | Next Page Index ]]