com.ibm.cics.model
Interface IURIMap

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface IURIMap
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable URIMAP


Nested Class Summary
static class IURIMap.AnalyzerstatValue
          Enumeration type for field ANALYZERSTAT
static class IURIMap.AuthenticateValue
          Enumeration type for field AUTHENTICATE
static class IURIMap.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IURIMap.HosttypeValue
          Enumeration type for field HOSTTYPE
static class IURIMap.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IURIMap.IpfamilyValue
          Enumeration type for field IPFAMILY
static class IURIMap.RedirecttypeValue
          Enumeration type for field REDIRECTTYPE
static class IURIMap.SchemeValue
          Enumeration type for field SCHEME
static class IURIMap.StatusValue
          Enumeration type for field ENABLESTATUS
static class IURIMap.UsageValue
          Enumeration type for field USAGE
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 IURIMap.AnalyzerstatValue getAnalyzerstat()
          Getter for field ANALYZERSTAT
 java.lang.String getAtomservice()
          Getter for field ATOMSERVICE
 IURIMap.AuthenticateValue getAuthenticate()
          Getter for field AUTHENTICATE
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.String getCertificate()
          Getter for field CERTIFICATE
 IURIMap.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 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 getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 java.lang.String getHfsfile()
          Getter for field HFSFILE
 java.lang.String getHost()
          Getter for field HOST
 java.lang.String getHostcodepage()
          Getter for field HOSTCODEPAGE
 IURIMap.HosttypeValue getHosttype()
          Getter for field HOSTTYPE
 IURIMap.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 IURIMap.IpfamilyValue getIpfamily()
          Getter for field IPFAMILY
 java.lang.String getIpresolved()
          Getter for field IPRESOLVED
 java.lang.String getLocation()
          Getter for field LOCATION
 java.lang.Long getMatchdisabld()
          Getter for field MATCHDISABLD
 java.lang.Long getMatchredirec()
          Getter for field MATCHREDIREC
 java.lang.String getMediatype()
          Getter for field MEDIATYPE
 java.lang.String getName()
          Getter for field NAME
 java.lang.Long getNumciphers()
          Getter for field NUMCIPHERS
 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
 IURIMap.RedirecttypeValue getRedirecttype()
          Getter for field REDIRECTTYPE
 java.lang.Long getReferenceCount()
          Getter for field MAPREFCOUNT
 IURIMap.SchemeValue getScheme()
          Getter for field SCHEME
 java.lang.Long getSocketclose()
          Getter for field SOCKETCLOSE
 java.lang.Long getSockplszpeak()
          Getter for field SOCKPLSZPEAK
 java.lang.Long getSockpoolsize()
          Getter for field SOCKPOOLSIZE
 java.lang.Long getSockreclaimd()
          Getter for field SOCKRECLAIMD
 java.lang.Long getSocktimedout()
          Getter for field SOCKTIMEDOUT
 IURIMap.StatusValue getStatus()
          Getter for field ENABLESTATUS
 java.lang.String getTCPIPService()
          Getter for field TCPIPSERVICE
 java.lang.String getTemplatename()
          Getter for field TEMPLATENAME
 java.lang.String getTransaction()
          Getter for field TRANSACTION
 IURIMap.UsageValue getUsage()
          Getter for field USAGE
 java.lang.String getUserid()
          Getter for field USERID
 java.lang.String getWebService()
          Getter for field WEBSERVICE
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
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:


getUsage

IURIMap.UsageValue getUsage()
Getter for field USAGE

URI map usage

The intended use of this URIMAP:


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


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


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.


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

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

SSL cipher suite codes

A value specifying up to 28 cipher suites, in the form of hexadecimal pairs


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.


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.


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.


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:


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:


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



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