com.ibm.cics.model
Interface IIPICConnectionDefinition

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

public interface IIPICConnectionDefinition
extends ICICSDefinition

generated from CICS resourcetable IPCONDEF


Nested Class Summary
static class IIPICConnectionDefinition.AutoconnectValue
          Enumeration type for field AUTOCONNECT
static class IIPICConnectionDefinition.IdpropValue
          Enumeration type for field IDPROP
static class IIPICConnectionDefinition.InserviceValue
          Enumeration type for field INSERVICE
static class IIPICConnectionDefinition.LinkauthValue
          Enumeration type for field LINKAUTH
static interface IIPICConnectionDefinition.MaxqtimeValue
          Long constants interface for field MAXQTIME
static class IIPICConnectionDefinition.MirrorlifeValue
          Enumeration type for field MIRRORLIFE
static interface IIPICConnectionDefinition.PortValue
          Long constants interface for field PORT
static interface IIPICConnectionDefinition.QueuelimitValue
          Long constants interface for field QUEUELIMIT
static class IIPICConnectionDefinition.SslValue
          Enumeration type for field SSL
static class IIPICConnectionDefinition.UserauthValue
          Enumeration type for field USERAUTH
static class IIPICConnectionDefinition.XlnactionValue
          Enumeration type for field XLNACTION
 
Method Summary
 java.lang.String getApplicationID()
          Getter for field APPLID
 IIPICConnectionDefinition.AutoconnectValue getAutoconnect()
          Getter for field AUTOCONNECT
 java.lang.String getCertificate()
          Getter for field CERTIFICATE
 java.lang.String getCiphers()
          Getter for field CIPHERS
 java.lang.String getHost()
          Getter for field HOST
 IIPICConnectionDefinition.IdpropValue getIdprop()
          Getter for field IDPROP
 IIPICConnectionDefinition.InserviceValue getInservice()
          Getter for field INSERVICE
 IIPICConnectionDefinition.LinkauthValue getLinkauth()
          Getter for field LINKAUTH
 java.lang.Long getMaxqtime()
          Getter for field MAXQTIME
 IIPICConnectionDefinition.MirrorlifeValue getMirrorlife()
          Getter for field MIRRORLIFE
 java.lang.String getNetworkid()
          Getter for field NETWORKID
 java.lang.Long getPort()
          Getter for field PORT
 java.lang.Long getQueuelimit()
          Getter for field QUEUELIMIT
 java.lang.Long getReceivecount()
          Getter for field RECEIVECOUNT
 java.lang.String getSecurityname()
          Getter for field SECURITYNAME
 java.lang.Long getSendcount()
          Getter for field SENDCOUNT
 IIPICConnectionDefinition.SslValue getSsl()
          Getter for field SSL
 java.lang.String getTCPIPService()
          Getter for field TCPIPSERVICE
 IIPICConnectionDefinition.UserauthValue getUserauth()
          Getter for field USERAUTH
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 IIPICConnectionDefinition.XlnactionValue getXlnaction()
          Getter for field XLNACTION
 
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
 

Method Detail

getAutoconnect

IIPICConnectionDefinition.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECT

Autoconnect sessions for IPIC connections

Identifies whether sessions are to be established when the IPCONN definition is installed (which can happen during CICS initialization, when you issue a subsequent INSTALL, or when you issue the SET TCPIP OPEN to start communication with TCP/IP). If the connection cannot be made at these times because the remote system is unavailable, you can subsequently acquire the link by using the SET IPCONN(name) INSERVICE ACQUIRED command, unless the remote system becomes available in the meantime and itself initiates communications.

NO
CICS does not try to establish sessions when the IPIC connection is installed.
YES
CICS tries to establish sessions when the IPIC connection is installed.


getInservice

IIPICConnectionDefinition.InserviceValue getInservice()
Getter for field INSERVICE

Connection status

The status of the IPIC connection when it is installed.

NO
The connection can neither receive messages nor transmit output.
YES
The connection is available for use.


getXlnaction

IIPICConnectionDefinition.XlnactionValue getXlnaction()
Getter for field XLNACTION

Exchange lognames (XLN) action

The action to be taken when a new logname is received from the remote, partner, system. (Receipt of a new logname indicates that the partner has deleted its recovery information.)

FORCE
Before any new work with the new logname is started, the predefined decisions for indoubt units of work (UOWs), as defined by the indoubt attributes of the TRANSACTION definition, are implemented. CICS also deletes any information retained for possible resolution of UOWs that were indoubt on the partner system. Note: Data integrity may be compromised if you use this option.
KEEP
Recovery information is kept, and no predefined actions are taken for indoubt units of work.

The connection is unable to perform new work that requires sync level 2 protocols until all outstanding recoverable work with the partner (that is, indoubt UOWs, or information relevant to UOWs that were indoubt on the partner system under the old logname) is completed. This completion may only be achieved through an explicit user instruction within this interface, or any of the other programming interfaces that are available.


getSsl

IIPICConnectionDefinition.SslValue getSsl()
Getter for field SSL

Secure sockets layer (SSL) type

Specifies whether the TCP/IP service is to use the secure sockets layer (SSL) for encryption and authentication:


getUserauth

IIPICConnectionDefinition.UserauthValue getUserauth()
Getter for field USERAUTH

Attach-time user security level

The level of attach-time user security required for the connection:


getPort

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

Port number

A decimal number, in the range 1 through 65535, specifying the port number to be used for outbound requests on this IPIC connection, or NO. That is, the number of the port on which the remote system will be listening, or NO for IPIC connections that are inbound only.


getTCPIPService

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

TCP/IP service

The 8-character name of a PROTOCOL(IPIC) TCPIPSERVICE definition that defines the attributes of the inbound processing for this IPCONN.


getNetworkid

java.lang.String getNetworkid()
Getter for field NETWORKID

Remote network ID

The network ID of the remote system. If NETWORKID is not specified, CICS uses the VTAM NETID or, for VTAM=NO systems, the value of the UOWNETQL system initialization parameter, of this CICS (that is, the CICS on which the IPCONN definition is installed).

NETWORKID is used in combination with the APPLID option to ensure unique naming for connecting systems.


getApplicationID

java.lang.String getApplicationID()
Getter for field APPLID

Remote application ID

The 8-character name by which the remote system is known to the network. This is the application identifier ( applid ) of the remote system, as specified on the APPLID option of its system initialization table. For XRF systems it is the generic applid.


getQueuelimit

java.lang.Long getQueuelimit()
Getter for field QUEUELIMIT

Queue limit

The maximum number of allocate requests that CICS is to queue while waiting for free sessions:

NO
There is no limit to the number of allocate requests that CICS can queue while waiting for a free session.
number
The maximum number of allocate requests, in the range 0 through 9999, that CICS can queue on the connection while waiting for a free session. When the number of queued allocate requests reaches this limit, subsequent allocate requests fail, returning SYSIDERR, until the queue drops below the limit.


getMaxqtime

java.lang.Long getMaxqtime()
Getter for field MAXQTIME

Maximum queue time

The maximum time, in seconds, for which allocate requests may be queued. The value is in the range 0-9999, or will have the standard null value of -1 if MAXQTIME(NO) is specified on the IPCONN definition.


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.


getHost

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

Remote host name

The 116-character host name of the remote system (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. IPv6 addresses should not be used for CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases.

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.


getReceivecount

java.lang.Long getReceivecount()
Getter for field RECEIVECOUNT

Receive count

The number, in the range 1-999, of RECEIVE sessions; that is, sessions that receive incoming requests. The actual number of receive sessions that are used depends also on the number of send sessions defined in the remote system. When the connection is established, these values are exchanged and the lower value is used. The number of RECEIVE sessions defined for this IPIC connection.


getSendcount

java.lang.Long getSendcount()
Getter for field SENDCOUNT

Send count

The number, in the range 0-999, of SEND sessions; that is, sessions that send outgoing requests. The actual number of send sessions that are used depends also on the number of receive sessions defined in the remote system. When the connection is established, these values are exchanged and the lower value is used. If 0 is specified, then this IPCONN can only process incoming work. It cannot send requests to the connected system. An attempt to acquire a connection between two IPCONNs that both have SENDCOUNT(0) will fail.


getCertificate

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

Certificate

The label of an X.509 certificate that is used as a server certificate during the SSL handshake for the TCP/IP service. If this attribute is omitted, the default certificate defined in the key ring for the CICS region user ID is used. Certificate labels can be up to 32 bytes long.


getCiphers

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

SSL cipher suite codes

Specifies a string of up to 56 hexadecimal digits that is interpreted as a list of up to 28 2-digit cipher suite codes. When you define the resource, CICS automatically initializes the attribute with a default list of acceptable codes, depending on the level of encryption that is specified by the ENCRYPTION system initialization parameter.

You can reorder the cipher codes or remove them from the initial list. However, you cannot add cipher codes that are not in the default list for the specified encryption level. To reset the value to the default list of codes, delete all the cipher suite codes; the field is automatically repopulated with the default list.


getSecurityname

java.lang.String getSecurityname()
Getter for field SECURITYNAME

Security name of the remote system

Specifies the security name of the remote system, to be used for link security. In a CICS system with security initialized (SEC=YES), and with LINKAUTH(SECUSER) in use, the security name is used to establish the authority of the remote system. The security name must be a valid RACF user ID on this region. Access to protected resources on this region is based on the RACF user profile and its group membership. The default value is the default user ID.


getLinkauth

IIPICConnectionDefinition.LinkauthValue getLinkauth()
Getter for field LINKAUTH

Link security

Specifies how the user ID for link security is established in a CICS system with security initialized (SEC=YES).


getIdprop

IIPICConnectionDefinition.IdpropValue getIdprop()
Getter for field IDPROP

Identity propagation

Specifies whether the Distributed ID will be transmitted to the connected system by the sender. The IDPROP attribute is meaningful only if a connection extends outside a sysplex and is used primarily to prevent distributed identities being distributed between enterprises. If the connection is between systems in the same sysplex, the connection operates as if IDPROP(OPTIONAL) is specified and ignores any other setting.


getMirrorlife

IIPICConnectionDefinition.MirrorlifeValue getMirrorlife()
Getter for field MIRRORLIFE

Minimum mirror lifetime

Indicates the minimum lifetime of the mirror task for function shipped requests received by this region. This parameter only takes affect when specified on the IPCONN on the resource-owning region and is not to be honoured for function shipping interval control or linkrequests.



Copyright 2008-2009 IBM Corp. All Rights Reserved.