com.ibm.cics.model
Interface IURIMapDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface IURIMapDefinition
extends ICICSDefinition

generated from CICS resourcetable URIMPDEF


Nested Class Summary
static class IURIMapDefinition.AuthenticateValue
          Enumeration type for field AUTHENTICATE
static interface IURIMapDefinition.PortValue
          Long constants interface for field PORT
static class IURIMapDefinition.RedirecttypeValue
          Enumeration type for field REDIRECTTYPE
static class IURIMapDefinition.SchemeValue
          Enumeration type for field SCHEME
static class IURIMapDefinition.UsageValue
          Enumeration type for field USAGE
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ICICSEnums.YesNoValue getAnalyzer()
          Getter for field ANALYZER
 java.lang.String getAtomservice()
          Getter for field ATOMSERVICE
 IURIMapDefinition.AuthenticateValue getAuthenticate()
          Getter for field AUTHENTICATE
 java.lang.String getCertificate()
          Getter for field CERTIFICATE
 java.lang.String getCharacterset()
          Getter for field CHARACTERSET
 java.lang.String getCiphers()
          Getter for field CIPHERS
 java.lang.String getConverter()
          Getter for field CONVERTER
 java.lang.String getHFSFile()
          Getter for field HFSFILE
 java.lang.String getHost()
          Getter for field HOST
 java.lang.String getHostcodepage()
          Getter for field HOSTCODEPAGE
 java.lang.String getLocation()
          Getter for field LOCATION
 java.lang.String getMediatype()
          Getter for field MEDIATYPE
 java.lang.String getPath()
          Getter for field PATH
 java.lang.String getPipeline()
          Getter for field PIPELINE
 java.lang.Long getPort()
          Getter for field PORT
 java.lang.String getProgram()
          Getter for field PROGRAM
 IURIMapDefinition.RedirecttypeValue getRedirecttype()
          Getter for field REDIRECTTYPE
 IURIMapDefinition.SchemeValue getScheme()
          Getter for field SCHEME
 java.lang.String getSocketclose()
          Getter for field SOCKETCLOSE
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 java.lang.String getTcpipservice()
          Getter for field TCPIPSERVICE
 java.lang.String getTemplateName()
          Getter for field TEMPLATENAME
 java.lang.String getTransaction()
          Getter for field TRANSACTION
 IURIMapDefinition.UsageValue getUsage()
          Getter for field USAGE
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 java.lang.String getUserid()
          Getter for field USERID
 java.lang.String getWebservice()
          Getter for field WEBSERVICE
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User data area 1

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata2

java.lang.String getUserdata2()
Getter for field USERDATA2

User data area 2

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata3

java.lang.String getUserdata3()
Getter for field USERDATA3

User data area 3

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getStatus

ICICSEnums.EnablementValue getStatus()
Getter for field STATUS

Enabled status

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


getUsage

IURIMapDefinition.UsageValue getUsage()
Getter for field USAGE

URI map usage type

The usage for the URIMAP definition. The possible values are:


getScheme

IURIMapDefinition.SchemeValue getScheme()
Getter for field SCHEME

Scheme component of URI to which the map applies

The scheme component of the URL. The possible values are:


getHost

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

Host component of URI to which the map applies

The up to 116-character host name of the URI to which the map applies (for example, www.example.com), or its dotted decimal IPv4 address (for example, 9.20.181.3), or its colon hexadecimal IPv6 address (for example ABCD:EF01::2345:6789). If an IPv4 address is entered as an IPv4 compatible IPv6 address (deprecated) or an IPv4 mapped IPv6 address (for example ::FFFF:1.2.3.4) it is converted to a standard IPv4 dotted decimal address.

The host name can be entered in any case, but if a character host name is specified instead of an IP address, the host name is converted to lower case. If an IPV6 address is specified it will be converted to upper case.

If the definition is going to be used on CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases, IPv6 address formats should not be specified, and for USAGE(CLIENT) a non-standard port number for the SCHEME may be specified by following the name or address with a colon (:) and the port number, for example 'www.example.com:1234'. Otherwise, the PORT field is now the prefered method of specifying a non-standard port number.

For a USAGE other than USAGE(CLIENT), a port number should not be specified, and an asterisk (*) may be used to make the URIMAP definition match any host name.


getPath

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

Path component of URI to which the map applies

The path component of the URL, which can be up to 256 characters.


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 HFS 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 Hierarchical File System (HFS), 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.


getAnalyzer

ICICSEnums.YesNoValue getAnalyzer()
Getter for field ANALYZER

Use an analyzer program to process HTTP request

The analyzer program setting for the URIMAP definition. The possible values are:


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), 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), the name of the PIPELINE resource definition for the Web service that handles the incoming HTTP request.


getWebservice

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

Web service that will process the request

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


getUserid

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

The user ID to attach the alias transaction

For USAGE(SERVER), 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

Cipher suite codes to be used for outbound SSL

The cipher code that is to be used for the HTTP request by CICS as an HTTP client, which can be up to 48 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.


getRedirecttype

IURIMapDefinition.RedirecttypeValue getRedirecttype()
Getter for field REDIRECTTYPE

Type of redirection

The type of redirection for requests that match this URIMAP definition. The URL for redirection is specified by the Location option. The possible values are:


getPort

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

Port number

For USAGE(CLIENT) the decimal number of the port on which the remote CICS system is listening for incoming client requests in the range 1 through 65535. The well-known ports are those from 1 through 1023. It is advisable to use well known port numbers only for those services to which they are normally assigned. PORT need not be specified if the default port number for the SCHEME is to be used in which case it is set to NO.

If a port number is optionally specified in the HOST field, the PORT field must either contain the same port number, or be set or allowed to default to NO. In this case the port number from the HOST field will be used when the URIMAP is installed.

For a USAGE other than USAGE(CLIENT), PORT should not be specified and will be set to NO in any case.


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.


getAuthenticate

IURIMapDefinition.AuthenticateValue getAuthenticate()
Getter for field AUTHENTICATE

Authentication level

The authentication and identification scheme to be used for URIMAPS.


getSocketclose

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

Time out for pooled sockets (HHMMSS)

This attribute is for USAGE (CLIENT). SOCKETCLOSE specifies if, and for how long, CICS keeps a client HTTP connection open after the CICS application has finished using it. After use, CICS checks the state of the connection and then places it in a pool in a dormant state. A dormant connection can be reused by the same application or by another application that connects to the same host and port.



Copyright © 2008-2012 IBM Corp. All Rights Reserved.