INQUIRE URIMAP

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. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Auditing resources. The resource signature fields are BUNDLE, CHANGEAGENT, CHANGEAGREL, CHANGETIME, CHANGEUSRID, DEFINESOURCE, DEFINETIME, INSTALLAGENT, INSTALLTIME, and INSTALLUSRID. See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

ANALYZERSTAT(cvda)

Returns a CVDA value indicating whether the analyzer program associated with the TCPIPSERVICE definition is to be run. CVDA values are as follows:

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.

APPLICATION(data-value)

Returns a 64-character area containing the application name of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, APPLICATION returns blanks.

APPLMAJORVER(data-value)

Returns the fullword binary form of the major version number of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, APPLMAJORVER returns -1.

APPLMINORVER(data-value)

Returns the fullword binary form of the minor version number of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, APPLMINORVER returns -1.

APPLMICROVER(data-value)

Returns the fullword binary form of the micro version number of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, APPLMICROVER returns -1.

ATOMSERVICE(data-area)

Returns the 1- to 8-character name of an ATOMSERVICE resource definition for an Atom feed. The ATOMSERVICE resource definition defines an Atom service, feed, collection, or category document, and identifies the Atom configuration file, CICS resource or application program, and XML binding that are used to supply the data for the feed. This attribute is for USAGE(ATOM).

AUTHENTICATE(cvda)

Returns a CVDA value indicating whether to provide authentication information to a web services provider. This attribute is for USAGE(CLIENT). CVDA values are as follows:

BASICAUTH

The web services provider requires HTTP basic authentication. You can supply credentials to the web services requester (a user ID and password) to the global user exit, XWBAUTH, which, if enabled, sends the credentials to the web services provider.

NOAUTHENTIC

The web services provider does not require authentication.

AVAILSTATUS(cvda)

Returns the availability status of the URIMAP resource as an application entry point for an application deployed on a platform.

AVAILABLE

The URIMAP resource is declared as an application entry point, and the application entry point controls its availability and is available, so the URIMAP resource is available to callers.

UNAVAILABLE

The URIMAP resource is declared as an application entry point, but the application entry point that controls its availability is unavailable, so the URIMAP resource is not available to callers.

NONE

The URIMAP resource is available to callers. Either the URIMAP resource is not declared as an application entry point, or it is declared as an application entry point but the application entry point is disabled or does not control the availability of the URIMAP resource.

CERTIFICATE(data-area)

Returns a 32-character data area, which contains 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).

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. The possible values are as follows:

CREATESPI

The resource definition was last changed by an EXEC CICS CREATE command.

CSDAPI

The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.

CSDBATCH

The resource definition was last changed by a DFHCSDUP job.

DREPAPI

The resource definition was last changed by a CICSPlex SM BAS API command.

DYNAMIC

The resource definition was last changed by a PIPELINE scan.

SYSTEM

The resource definition was last changed by the CICS or CICSPlex system.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS release that was running when the resource definition was last changed.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

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 either a 56–character area that contains the list of cipher suites that is used to negotiate with clients during the SSL handshake or the name of the SSL cipher suite specification file, which is a z/OS® UNIX file in the security/ciphers subdirectory of the directory that is specified by the USSCONFIG system initialization parameter. For more information, see SSL cipher suite specification file.

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).

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

ENABLESTATUS(cvda)

Returns a CVDA value indicating the status of this URIMAP definition. CVDA values are as follows:

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. Use the SET HOST command to reenable 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 file that forms a static response. This attribute is for USAGE(SERVER).

HOST(data-area)

Returns the 116-character host name or its IPv4 or IPv6 address. The HOST option can be a character host name, an IPv4 address, or an IPv6 address. HOST is specified in the resource definition. HOST displays all IPv4 addresses as native IPv4 dotted decimal addresses, for example, 1.2.3.4, regardless of the type of address format used. You can specify IPv4 and IPv6 addresses in a number of acceptable formats. See IP addresses for more information about address formats.

For USAGE(CLIENT), the port number is also displayed in the HOST option if HOST contains a native IPv4 address or a host name; however, if you specify a hostname that is greater than 110 characters in length, port information is not displayed in the HOST option. This rule also applies if you specify an IPv4 address in IPv6 format. Use the PORT option to view the port number.

HOSTCODEPAGE(data-area)

Returns a 10-character data area containing the 1- to 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).

HOSTTYPE(cvda)

Returns the address format of the HOST option. HOSTTYPE is set by CICS when the URIMAP is installed. CVDA values are as follows:

HOSTNAME

The HOST option contains a character host name. The IP address that corresponds to the host name is looked up in the domain name server.

IPV4

The address is specified in IPv4 dotted decimal address format.

IPV6

The address is specified in IPv6 colon hexadecimal address format.

NOTAPPLIC

An incorrect host address was returned (HOST=0.0.0.0 or HOST=*), or the HOSTTYPE option is used with URIMAP(ATOM), URIMAP(JVMSERVER), URIMAP(PIPELINE), or URIMAP(SERVER).

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

BUNDLE

The resource was installed by a bundle deployment.

CREATESPI

The resource was installed by an EXEC CICS CREATE command.

CSDAPI

The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.

DYNAMIC

The resource was installed by using a PIPELINE scan.

GRPLIST

The resource was installed by GRPLIST INSTALL.

INSTALLTIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

IPFAMILY(cvda)

Returns the address format of the IPRESOLVED option. CVDA values are as follows:

IPV4

The address is specified in IPv4 dotted decimal address format.

IPV6

The address is specified in IPv6 colon hexadecimal address format.

UNKNOWN

IPRESOLVED is not yet in use or the address cannot be resolved. UNKNOWN is the default when IPRESOLVED is 0.0.0.0, or if the IPFAMILY option is used with USAGE(ATOM), USAGE(JVMSERVER), USAGE(PIPELINE), or USAGE(SERVER).

IPRESOLVED(data-area)

Returns a 39-character field that specifies the IPv4 or IPv6 address of the HOST option. This attribute is for all types except USAGE(SERVER) and USAGE(JVMSERVER). If the URIMAP is installed but has not yet been used to establish a connection, or the address cannot be resolved, a default value of 0.0.0.0 is returned. When the URIMAP establishes a connection, IPRESOLVED displays the resolved IP address that was used by the resource to connect. IPRESOLVED is reset to 0.0.0.0 when the resource is disabled. The content of IPRESOLVED is not recoverable after a warm or emergency restart.

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), USAGE(PIPELINE), or USAGE(ATOM).

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. If CIPHERS contains a file name, this field contains zero. The ciphers are used to negotiate encryption levels as part of the SSL handshake. This attribute is for USAGE(CLIENT).

OPERATION(data-value)

Returns a 64-character area containing the operation name of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, OPERATION returns blanks.

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 that act on the service request from the client. This attribute is for USAGE(PIPELINE).

PLATFORM(data-value)

Returns a 64-character area containing the platform name of the application for which this URIMAP resource is declared as an application entry point. If the URIMAP resource is not defined as an application entry point, PLATFORM returns blanks.

PORT(data-area)

Returns a fullword binary value, in the range 1 - 65535, containing the port number value of the connection to the server.

For USAGE(CLIENT), the PORT option displays the port number used for the client connection. The port number is also displayed in the HOST option if HOST contains a native IPv4 address or a host name. For USAGE(CLIENT), the PORT attribute always contains the port number that is being used for the communication, even if PORT(NO) is specified on the URIMAP at define time. PORT is specified in the resource definition.

For USAGE(JVMSERVER), the PORT option displays the port number that is used to receive requests to access an application running in a Liberty profile server.

For USAGE(ATOM), USAGE(SERVER), or USAGE(PIPELINE), the PORT option is set to PORT(NO).

PROGRAM(data-area)

Returns the 8-character name of the application program that composes an application-generated response to the HTTP request. This option is for USAGE(SERVER).

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), USAGE(PIPELINE), or USAGE(ATOM). CVDA values are as follows:

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).

SCHEME(cvda)

Returns a CVDA value indicating the scheme component of the URI. CVDA values are as follows:

HTTP

HTTP without SSL.

HTTPS

HTTP with SSL.

This attribute is for any usage type.

SOCKETCLOSE(data-area)

Returns, in fullword binary form, the maximum length of time in seconds that CICS keeps a client HTTP connection open for reuse after the CICS application has finished using it. If the value is 0, CICS does not keep connections open for reuse. This attribute is for USAGE(CLIENT). For other usage types, CICS returns a null value (-1).

SOCKPOOLSIZE(data-area)

Returns, in fullword binary form, the number of client HTTP connections that CICS is currently holding in a pool in a dormant state. The connections can be reused by any CICS application that connects as a Web client to the same host and port. This attribute is for USAGE(CLIENT). For other usage types, CICS returns a null value (-1).

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 port is not specified, the URIMAP definition applies to a request on any inbound ports. This attribute is for USAGE(SERVER), USAGE(PIPELINE), or USAGE(ATOM).

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), USAGE(PIPELINE), USAGE(ATOM), or USAGE(JVMSERVER).

URIMAP(data-value)

Returns the 8-character name of a URIMAP definition.

USAGE(cvda)

Returns a CVDA value indicating the purpose of this URIMAP definition. CVDA values are as follows:

SERVER

A URIMAP resource for CICS as an HTTP server. This type of URIMAP resource maps 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 resource for CICS as an HTTP client. This type of URIMAP resource is used when CICS makes a client request for an HTTP resource on a server.

PIPELINE

A URIMAP resource for a web service. This type of URIMAP resource specifies the processing that is to be performed on a request by which a client calls a web service in CICS.

ATOM

A URIMAP resource for an Atom feed. This type of URIMAP resource is used for an incoming request for data that CICS makes available as an Atom feed. The URIMAP resource maps the request URI to an ATOMSERVICE resource definition, which defines an Atom document.

JVMSERVER

A URIMAP for a JVM server. This type of URIMAP resource maps an incoming request for a Java web application to run under a CICS transaction that has appropriate security.

USERID(data-area)

Returns the 8-character user ID under which the alias transaction is attached. This attribute is for USAGE(SERVER), USAGE(PIPELINE), USAGE(JVMSERVER), or USAGE(ATOM).

WEBSERVICE(data-area)

Returns the name of a Web service. This name can be the 1- to 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 attribute defines aspects of the runtime 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.