WBUR gate, INQUIRE_URIMAP function
The INQUIRE_URIMAP function is used to inquire on the attributes of a URIMAP resource.
Input Parameters
- APPLICATION_NAME
- Optional Parameter
- The 64-character buffer to receive the name of the application if the URIMAP is declared as an application entry point.
- HFSFILE
- Optional Parameter
- The fully qualified or relative name of a zFS file that forms the body of the static response that is sent to the HTTP request from the web client.
- HOST
- The host name of the URI to which the URIMAP resource applies, or its IPv4 or IPv6 address.
- OPERATION_NAME
- Optional Parameter
- The 64-character buffer to receive the name of the application operation if the URIMAP is declared as an application entry point.
- PATH
- The path component of the URI to which the URIMAP resource applies.
- PLATFORM_NAME
- Optional Parameter
- The 64-character buffer to receive the name of the platform if the URIMAP is declared as an application entry point.
- REDIRECTION_LOCATION
- Optional Parameter
- A URL to which the client's request should be redirected.
- RESOURCE_SIGNATURE
- Optional Parameter
- The resource signature for the URIMAP resource definition.
- URIMAP
- The name of the URIMAP resource.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- LOOP
- The following values are returned when RESPONSE is EXCEPTION:
- BROWSE_END
- CCNV_ERROR
- CONFLICTING_ATTRIBUTES
- DIRECTORY_ERROR
- DUPLICATE_MAPPING
- GETMAIN_FAILED
- INVALID_BROWSE_TOKEN
- INVALID_CHARACTERSET
- INVALID_HOSTCODEPAGE
- INVALID_HOSTNAME
- INVALID_PATHNAME
- LOCATION_INVALID
- NO_REDIRECTION_LOCATION
- NOT_FOUND
- NOT_POSSIBLE
- SECURITY_FAILED
- SSL_INACTIVE
- URIMAP_ENABLED
- The following values are returned when RESPONSE is INVALID:
- INVALID_FORMAT
- INVALID_FUNCTION
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- ANALYZER
- Optional Parameter
- A binary value that specifies whether an analyzer program is to be used in processing HTTP requests.
- Values for the parameter are:
- NO
- YES
- AVAILSTATUS
- Optional parameter
- A 1-byte enumeration expressing the availability status of the CICS bundle.
- Values for the parameter are:
- AVAILABLE
- UNAVAILABLE
- NONE
- BUNDLE_TOKEN
- Optional Parameter
- An 8-byte token that represents the CICS bundle in which the URIMAP is declared as an application entry point.
- CERTIFICATE_LABEL
- Optional Parameter
- The label of the X.509 certificate that is to be used as the SSL client certificate during the SSL handshake.
- CHARACTERSET
- Optional Parameter
- The character set into which CICS converts the entity body of the response that is sent to the web client.
- CIPHER_COUNT
- Optional Parameter
- The number of cipher suites encoded in the CIPHER_SUITES parameter.
- CIPHER_SUITES
- Optional Parameter
- A string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes.
- CONVERTER
- Optional Parameter
- The name of a converter program that is to be run to perform conversion or other processing on the request and response.
- ENTRYPOINT_RES_TOKEN
- Optional Parameter
- An 8-byte token that represents the application entry point.
- HOSTCODEPAGE
- Optional Parameter
- The EBCDIC code page in which the text document that forms the static response is encoded.
- MAJOR_VERSION
- Optional Parameter
- The fullword binary value that is the major version of the application for which the URIMAP is declared as an application entry point.
- MICRO_VERSION
- Optional Parameter
- The fullword binary value that is the micro version of the application for which the URIMAP is declared as an application entry point.
- MINOR_VERSION
- Optional Parameter
- The fullword binary value that is the minor version of the application for which the URIMAP is declared as an application entry point.
- MEDIATYPE
- Optional Parameter
- The media type of the static response that CICS provides to the HTTP request, for example image/jpg, text/html, or text/xml.
- PIPELINE_NAME
- Optional Parameter
- The PIPELINE resource used by web service requests for the URIMAP resource.
- PORT
- Optional Parameter
- The decimal number of the port used by a CICS application when it communicates with a server using the URIMAP resource.
- PROGRAM
- Optional Parameter
- The name of the user application program that composes the HTTP response for the URIMAP resource.
- REDIRECTION_TYPE
- Optional Parameter
- The type of redirection for requests that match the URIMAP resource. When redirection is required, the REDIRECTION_LOCATION parameter specifies the URL to which the request should be redirected.
- Values for the parameter are:
- NONE
- PERMANENT
- TEMPORARY
- SCHEME
- Optional Parameter
- The scheme component of the URI to which the URIMAP resource applies.
- Values for the parameter are:
- HTTP
- HTTPS
- WMQ
- SOCKETCLOSE
- Optional Parameter
- The length of time for which CICS keeps a client HTTP connection open after the CICS application has finished using it.
- SOCKPOOLSIZE
- Optional Parameter
- The number of client HTTP connections made using this URIMAP resource that CICS is currently holding in a pool in a dormant state.
- SOCKETPOOL_TKN
- Optional Parameter
- The unique identifier for the pool of opened client HTTP connections made using this URIMAP resource.
- STATUS
- Optional Parameter
- The enabled or disabled state of the URIMAP resource.
- Values for the parameter are:
- DISABLED
- DISABLEDHOST
- ENABLED
- TCPIPSERVICE
- Optional Parameter
- The name of the TCPIPSERVICE resource that defines the inbound port to which the URIMAP resource relates.
- TEMPLATENAME
- Optional Parameter
- The name of a CICS document template that forms the body of the static response that is sent to the HTTP request from the web client.
- TRANSACTION
- Optional Parameter
- The name of an alias transaction that is to be used to run the user application that composes the HTTP response, or to start the pipeline.
- USAGE
- Optional Parameter
- Specifies how the URIMAP resource is used.
- Values for the parameter are:
- ATOM
- CLIENT
- PIPELINE
- SERVER
- USERID
- Optional Parameter
- The user ID under which requests for the URIMAP resource are initially processed.
- WEBSERVICE_NAME
- Optional Parameter
- The name of a WEBSERVICE resource associated with the URIMAP resource.