Interface IURIMap

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        Name

        The name of the URIMAP definition.

        Specified by:
        getName in interface ICICSObject
      • getStatus

        IURIMap.StatusValue getStatus()
        Getter for field ENABLESTATUS

        Status

        The status of the URIMAP definition. The possible values are:

        • Enabled - The URIMAP definition can be accessed.
        • Disabled - The URIMAP definition cannot be accessed. A URIMAP definition with this status can be deleted.
        • Disabledhost - The URIMAP definition cannot be accessed because the virtual host of which it forms a part has been disabled. Use the HOST views to re-enable all the URIMAP definitions in the virtual host. A URIMAP definition with this status cannot be deleted.
      • getUsage

        IURIMap.UsageValue getUsage()
        Getter for field USAGE

        URI map usage

        The intended use of this URIMAP:

        • SERVER - The URIMAP definition is used to locate the resources for CICS to produce an HTTP response to the request identified by HOST and PATH.
        • CLIENT - The URIMAP definition is used to specify information for making an HTTP request from CICS as an HTTP client.
        • PIPELINE - The URIMAP definition is used to locate the resources for CICS to produce an XML response to the request identified by HOST and PATH.
        • ATOM - The URIMAP definition is used to imply the use of Internatinalized Resource Identifiers (IRIs) rather then URIs, IRIs are just URIs that contain Unicode characters.
        • JVMSERVER - The URIMAP definition is used to to locate the resources for CICS to produce an XML response to the request identified by HOST and PATH for a Liberty Server.
      • getScheme

        IURIMap.SchemeValue getScheme()
        Getter for field SCHEME

        Scheme component of URI to which the map applies

        The scheme for the HTTP request, HTTP with SSL (HTTPS) or without (HTTP). JMS and IIOP schemes can be used when USAGE is JVMSERVER.

      • getHost

        java.lang.String getHost()
        Getter for field HOST

        Host component of the URI

        The host name or IP address of the remote system. The HOSTTYPE option gives the format of this value as either a name, an IPv4 address or an IPv6 address. The port number is also displayed if this is a name or an IPv4 address.

      • getPath

        java.lang.String getPath()
        Getter for field PATH

        Path component of URI to which the map applies

        For USAGE(CLIENT), the path of the target URL to which the HTTP request is to be sent. For any other USAGE, the path on the incoming HTTP request that is used to select this URIMAP definition. The PATH may terminate in an asterisk, meaning that it is generic, and matches any path whose characters are the same up to but excluding the asterisk.

      • getMediatype

        java.lang.String getMediatype()
        Getter for field MEDIATYPE

        Media type of CICS response to the HTTP request

        Specifies the media type (data content) of the static response that CICS provides to the HTTP request. This is for USAGE(SERVER), where a static response is to be provided and up to 56 characters can be used. The name for each formally recognized type of data content is defined by IANA.

      • getCharacterset

        java.lang.String getCharacterset()
        Getter for field CHARACTERSET

        Character set of CICS response to the HTTP request

        For USAGE(SERVER), the name of the character set for the static response, which can be up to 40 characters.

      • getHostcodepage

        java.lang.String getHostcodepage()
        Getter for field HOSTCODEPAGE

        Code page in which the static response is encoded

        For USAGE(SERVER), the IBM code page (EBCDIC) in which the text document that will form the static response is encoded; this can be up to 10 characters.

      • getTemplatename

        java.lang.String getTemplatename()
        Getter for field TEMPLATENAME

        Document template to form the static response

        For USAGE(SERVER), the name of a CICS document template whose contents are returned as the HTTP response.

      • getHfsfile

        java.lang.String getHfsfile()
        Getter for field HFSFILE

        Qualified zFS file to form the static response

        For USAGE(SERVER), the fully qualified or relative name of a file in the z/OS UNIX System Services zSeries File System (zFS), whose contents are returned as the HTTP response.

      • getTCPIPService

        java.lang.String getTCPIPService()
        Getter for field TCPIPSERVICE

        Inbound TCP/IP service relating to this URI map

        For USAGE(SERVER) or USAGE(PIPELINE), the TCPIPSERVICE to which this URIMAP definition applies. Only requests received on this TCPIPSERVICE are matched to this URIMAP definition. If no TCPIPSERVICE is specified, the URIMAP definition applies to all incoming HTTP requests.

      • getAnalyzerstat

        IURIMap.AnalyzerstatValue getAnalyzerstat()
        Getter for field ANALYZERSTAT

        Use an analyzer program to process HTTP request

        For USAGE(SERVER), whether or not the analyzer associated with the TCPIPSERVICE definition is called to process the request. For all other usage types, the value is forced to NOANALYZER.

        • ANALYZER - The analyzer program is to be run.
        • NOANALYZER - The analyzer program is not to be run.
      • getConverter

        java.lang.String getConverter()
        Getter for field CONVERTER

        Converter program to process request content

        For USAGE(SERVER), the name of a converter program that is used to transform the HTTP request into a form suitable for the application program specified in PROGRAM.

      • getTransaction

        java.lang.String getTransaction()
        Getter for field TRANSACTION

        Alias transaction to run application for response

        For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPELINE), the name of the alias transaction that processes the incoming HTTP request.

      • getProgram

        java.lang.String getProgram()
        Getter for field PROGRAM

        Application program that will process the request

        For USAGE(SERVER), the name of the application program that processes the incoming HTTP request.

      • getPipeline

        java.lang.String getPipeline()
        Getter for field PIPELINE

        Pipeline that will process the request

        For USAGE(PIPELINE) or USAGE(JVMSERVER), the name of the PIPELINE resource definition for the Web service that handles the incoming request.

      • getWebService

        java.lang.String getWebService()
        Getter for field WEBSERVICE

        Web service that will process the request

        For USAGE(PIPELINE) or USAGE(JVMSERVER), the name of the WEBSERVICE resource definition for the Web service that handles the incoming request.

      • getUserid

        java.lang.String getUserid()
        Getter for field USERID

        User ID to attach the alias transaction

        For USAGE(SERVER), USAGE(JVMSERVER), or USAGE(PIPLEINE), the 8 character user ID under which the alias transaction will be attached.

      • getCertificate

        java.lang.String getCertificate()
        Getter for field CERTIFICATE

        SSL client certificate for outbound HTTPS request

        For USAGE(CLIENT), the label of a certificate within the key ring that is to be used as a client certificate in the SSL handshake for outbound IIOP connections.

      • getCiphers

        java.lang.String getCiphers()
        Getter for field CIPHERS

        SSL cipher suite codes

        A value specifying up to 28 cipher suites, in the form of hexadecimal pairs. From CICS Transaction Server Version 5 this field can alternatively specify the name of an XML file residing on zFS which contains a list of ciphers. An XML file can be up to 28 characters.

      • getLocation

        java.lang.String getLocation()
        Getter for field LOCATION

        URI to which to redirect the inbound HTTP request

        For USAGE(SERVER), or USAGE(PIPELINE), an alternate URL to which the Web client will be redirected, if redirection is specified. REDIRECTYPE is used to define the type of redirection.

      • getReferenceCount

        java.lang.Long getReferenceCount()
        Getter for field MAPREFCOUNT

        URI map reference count

        Number of times this URIMAP definition was referenced.

      • getMatchdisabld

        java.lang.Long getMatchdisabld()
        Getter for field MATCHDISABLD

        URI map host or path disabled

        Number of times this host and path were matched, but the URIMAP definition was disabled.

      • getMatchredirec

        java.lang.Long getMatchredirec()
        Getter for field MATCHREDIREC

        URI map host or path redirect

        Number of times this host and path were matched, and the request was redirected.

      • getNumciphers

        java.lang.Long getNumciphers()
        Getter for field NUMCIPHERS

        Number of SSL cipher suite codes

        The count of cipher suite codes, which are specified as hexadecimal pairs

      • getRedirecttype

        IURIMap.RedirecttypeValue getRedirecttype()
        Getter for field REDIRECTTYPE

        Type of redirection

        Whether or not matching requests should be redirected, on a temporary or permanent basis.

        • NONE - Requests are not redirected. Any URL specified by the LOCATION field is ignored.
        • TEMPORARY - Requests are redirected on a temporary basis. The HTTP status code used for the response is 302 (Found).
        • PERMANENT - Requests are redirected permanently. The HTTP status code used for the response is 301 (Moved Permanently).
      • getChangeUserID

        java.lang.String getChangeUserID()
        Getter for field CHANGEUSRID

        Last modification user ID

        The user ID that made the last modification to the resource definition.

      • getChangeAgent

        IURIMap.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last modification agent

        The change agent identifier that made the last modification.

        • CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CSDBATCH - The resource was last changed by a DFHCSDUP job.
        • DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
        • DYNAMIC - The resource was last changed dynamically.
        • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This is not applicable for this resource.
        • OVERRIDE - Resource was last changed by resource overrides.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getChangeAgentRelease

        java.lang.String getChangeAgentRelease()
        Getter for field CHANGEAGREL

        Last modification agent release

        The CICS release level of the agent that made the last modification to the resource definition.

      • getInstallAgent

        IURIMap.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation agent

        The install agent identifier that made the installation.

        • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • DYNAMIC - The resource was installed dynamically.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
        • BUNDLE - The resource was installed by a BUNDLE.
        • SYSTEM - The resource was installed by the SYSTEM.
      • getChangeTime

        java.util.Date getChangeTime()
        Getter for field CHANGETIME

        Last modification time

        The local date and time when the definition was last changed.

      • getDefineSource

        java.lang.String getDefineSource()
        Getter for field DEFINESOURCE

        Source of the resource definition

        The source of the definition, depending on which agent made the last change.

      • getDefineTime

        java.util.Date getDefineTime()
        Getter for field DEFINETIME

        Creation time

        The local date and time when the resource definition record was created on DFHCSD or EYUDREP.

      • getInstallUserID

        java.lang.String getInstallUserID()
        Getter for field INSTALLUSRID

        Installation user ID

        The user ID that installed the resource definition.

      • getInstallTime

        java.util.Date getInstallTime()
        Getter for field INSTALLTIME

        Installation time

        The local date and time when the definition was installed.

      • getBasdefinever

        java.lang.Long getBasdefinever()
        Getter for field BASDEFINEVER

        BAS resource definition version

        The BAS version number of this definition.

      • getAtomservice

        java.lang.String getAtomservice()
        Getter for field ATOMSERVICE

        Atomservice that will process the request.

        This attribute is for USAGE(ATOM). When a client makes a request to CICS for an Atom feed using the URI specified by this URIMAP definition, ATOMSERVICE specifies the 1 - 8 character name of the ATOMSERVICE resource definition for the 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 Atom binding file that are used to supply the data for the feed.

      • getIpresolved

        java.lang.String getIpresolved()
        Getter for field IPRESOLVED

        The resolved IP address of this URIMAP

        The resolved IPv4 or IPv6 address of the HOST to which this URIMAP applies, or 0.0.0.0 if it is unavailable or unknown. The format of this IP address is given by the IPFAMILY option.

      • getIpfamily

        IURIMap.IpfamilyValue getIpfamily()
        Getter for field IPFAMILY

        The format of the resolved IP address

        The format of the IP address in the IPRESOLVED option. These are the possible values:

        • IPV4 - IPRESOLVED contains an IPv4 address specified in dotted decimal address format.
        • IPV6 - IPRESOLVED contains an IPv6 address specified in colon hexadecimal address format.
        • UNKNOWN - IPRESOLVED is not yet in use, or the address cannot be resolved. This is the default when IPRESOLVED is 0.0.0.0
      • getHosttype

        IURIMap.HosttypeValue getHosttype()
        Getter for field HOSTTYPE

        The format of the host name or address

        The address format of the host component of the URI (HOST). These are the possible values:

        • HOSTNAME - HOST contains a character host name. The IP address that corresponds to the host name is looked up using DNS.
        • IPV4 - HOST contains an IPv4 address specified in dotted decimal address format.
        • IPV6 - HOST contains an IPv6 address specified in colon hexadecimal address format.
        • NOTAPPLIC - The HOST name or address is incorrect (HOST=0.0.0.0 or HOST=*).
      • getPort

        java.lang.Long getPort()
        Getter for field PORT

        Port number for USAGE(CLIENT)

        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. For USAGE(JVMSERVER), the PORT option displays the port number used to receive requests to access an application that is running in a Liberty profile server. For USAGE(ATOM), USAGE(SERVER), or USAGE(PIPELINE), the PORT option is set to -1.

      • getAuthenticate

        IURIMap.AuthenticateValue getAuthenticate()
        Getter for field AUTHENTICATE

        Authentication level

        The level of authentication used by this TCP/IP resource.

      • getSocketclose

        java.lang.Long getSocketclose()
        Getter for field SOCKETCLOSE

        Time out for pooled sockets (secs)

        The timeout value after which sockets will be closed. A value in seconds between 0 and 240000 (HHMMSS). Where 0 indicates that no connection pooling occurs.

      • getSockpoolsize

        java.lang.Long getSockpoolsize()
        Getter for field SOCKPOOLSIZE

        Number of pooled sockets

        The current number of sockets in the connection pool.

      • getSockplszpeak

        java.lang.Long getSockplszpeak()
        Getter for field SOCKPLSZPEAK

        Peak number of pooled sockets

        The peak size of the outbound connection socket pool.

      • getSockreclaimd

        java.lang.Long getSockreclaimd()
        Getter for field SOCKRECLAIMD

        Number of reclaimed sockets

        The number of sockets reclaimed from the pool.

      • getSocktimedout

        java.lang.Long getSocktimedout()
        Getter for field SOCKTIMEDOUT

        Number of timed out sockets

        The number of sockets that have been timed out in the pool.

      • getApplicationName

        java.lang.String getApplicationName()
        Getter for field APPLICATION

        Application Name

        The application name of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getPlatformName

        java.lang.String getPlatformName()
        Getter for field PLATFORM

        Platform Name

        The platform name of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getOperationName

        java.lang.String getOperationName()
        Getter for field OPERATION

        Operation Name

        The name of the application operation for which this URIMAP resource is defined as an entry point. If this field is not set, this resource is not defined as an entry point but may still be part of an application.

      • getMajorVersion

        java.lang.Long getMajorVersion()
        Getter for field APPLMAJORVER

        Major Version

        The major version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getMinorVersion

        java.lang.Long getMinorVersion()
        Getter for field APPLMINORVER

        Minor Version

        The minor version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getMicroVersion

        java.lang.Long getMicroVersion()
        Getter for field APPLMICROVER

        Micro Version

        The micro version number of the application for which this URIMAP resource is defined. If the OPERATION field is set, this resource is defined as an entry point.

      • getAvailability

        IURIMap.AvailabilityValue getAvailability()
        Getter for field AVAILSTATUS

        Availability status

        The availability of this URIMAP resource when an application entry point is in control of the availability.

        • AVAILABLE - The application entry point controlling the availability of this URIMAP resource is available.
        • UNAVAILABLE - The application entry point controlling the availability of this URIMAP resource is enabled but has not yet been made available.
        • NONE - There are several reasons for NONE availability.
          • This URIMAP resource is not part of a CICS Application.
          • No application entry point is controlling the availability of this URIMAP resource.
          • The application entry point controlling the availability of this URIMAP resource is disabled.
          • The application entry point controlling the availability of this URIMAP resource is not resident in the same CICS bundle.