Interface IIPICConnectionDefinition
-
- All Superinterfaces:
ICICSDefinition
,ICICSObject
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface IIPICConnectionDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IIPICConnectionDefinition.AutoconnectValue
Enumeration type for field AUTOCONNECTstatic class
IIPICConnectionDefinition.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IIPICConnectionDefinition.HighAvailabilityValue
Enumeration type for field HAstatic class
IIPICConnectionDefinition.IdpropValue
Enumeration type for field IDPROPstatic class
IIPICConnectionDefinition.InserviceValue
Enumeration type for field INSERVICEstatic class
IIPICConnectionDefinition.LinkauthValue
Enumeration type for field LINKAUTHstatic interface
IIPICConnectionDefinition.MaxqtimeValue
Long constants interface for field MAXQTIMEstatic class
IIPICConnectionDefinition.MirrorlifeValue
Enumeration type for field MIRRORLIFEstatic interface
IIPICConnectionDefinition.PortValue
Long constants interface for field PORTstatic interface
IIPICConnectionDefinition.QueuelimitValue
Long constants interface for field QUEUELIMITstatic class
IIPICConnectionDefinition.SslValue
Enumeration type for field SSLstatic class
IIPICConnectionDefinition.UserauthValue
Enumeration type for field USERAUTHstatic class
IIPICConnectionDefinition.XlnactionValue
Enumeration type for field XLNACTION
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getApplicationID()
Getter for field APPLIDIIPICConnectionDefinition.AutoconnectValue
getAutoconnect()
Getter for field AUTOCONNECTjava.lang.String
getCertificate()
Getter for field CERTIFICATEIIPICConnectionDefinition.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTICICSDefinitionReference<IIPICConnectionDefinition>
getCICSObjectReference()
java.lang.String
getCiphers()
Getter for field CIPHERSIIPICConnectionDefinition.HighAvailabilityValue
getHighAvailability()
Getter for field HAjava.lang.String
getHost()
Getter for field HOSTIIPICConnectionDefinition.IdpropValue
getIdprop()
Getter for field IDPROPIIPICConnectionDefinition.InserviceValue
getInservice()
Getter for field INSERVICEIIPICConnectionDefinition.LinkauthValue
getLinkauth()
Getter for field LINKAUTHjava.lang.Long
getMaxqtime()
Getter for field MAXQTIMEIIPICConnectionDefinition.MirrorlifeValue
getMirrorlife()
Getter for field MIRRORLIFEjava.lang.String
getNetworkid()
Getter for field NETWORKIDICICSType<IIPICConnectionDefinition>
getObjectType()
java.lang.Long
getPort()
Getter for field PORTjava.lang.Long
getQueuelimit()
Getter for field QUEUELIMITjava.lang.Long
getReceivecount()
Getter for field RECEIVECOUNTjava.lang.String
getSecurityname()
Getter for field SECURITYNAMEjava.lang.Long
getSendcount()
Getter for field SENDCOUNTIIPICConnectionDefinition.SslValue
getSsl()
Getter for field SSLjava.lang.String
getTCPIPService()
Getter for field TCPIPSERVICEIIPICConnectionDefinition.UserauthValue
getUserauth()
Getter for field USERAUTHjava.lang.String
getUserdata1()
Getter for field USERDATA1java.lang.String
getUserdata2()
Getter for field USERDATA2java.lang.String
getUserdata3()
Getter for field USERDATA3IIPICConnectionDefinition.XlnactionValue
getXlnaction()
Getter for field XLNACTION-
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime, getCSDGroup, getDescription, getVersion
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IIPICConnectionDefinition> getObjectType()
- Specified by:
getObjectType
in interfaceICICSDefinition
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IIPICConnectionDefinition.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast 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 - Resource was last changed by a CICSPlex SM API command.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getAutoconnect
IIPICConnectionDefinition.AutoconnectValue getAutoconnect()
Getter for field AUTOCONNECTAutoconnect 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 INSERVICEConnection 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 XLNACTIONExchange log names (XLN) action
The action to be taken when a new log name is received from the remote, partner, system. (Receipt of a new log name indicates that the partner has deleted its recovery information.)
- FORCE
- Before any new work with the new log name 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 log name) 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 SSLSecure sockets layer (SSL) type
Specifies whether the TCP/IP service is to use the secure sockets layer (SSL) for encryption and authentication:
- NO - SSL is not to be used.
- YES - An SSL session is to be used; CICS will send a server certificate to the client.
-
getUserauth
IIPICConnectionDefinition.UserauthValue getUserauth()
Getter for field USERAUTHAttach-time user security level
The level of attach-time user security required for the connection:
- DEFAULTUSER - CICS will not accept a user ID and password from the partner system. All requests will run under the default user ID.
- LOCAL - CICS will not accept a user ID or password from the partner system. All requests will run under the user ID determined for link security.
- VERIFY - Incoming attach requests must specify a user identifier and a user password.
- IDENTIFY - Incoming attach requests must specify a user identifier. For CICS TS Version 4 Release 1 system, this allows the distributed ID to be transmitted to the connected system by the sender, should it be required.
-
getPort
java.lang.Long getPort()
Getter for field PORTPort 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 TCPIPSERVICETCP/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 NETWORKIDRemote 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 APPLIDRemote 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 QUEUELIMITQueue 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 MAXQTIMEMaximum 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 USERDATA1User 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 USERDATA2User 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 USERDATA3User 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 HOSTRemote 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 uppercase.
-
getReceivecount
java.lang.Long getReceivecount()
Getter for field RECEIVECOUNTReceive 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 SENDCOUNTSend 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 CERTIFICATECertificate
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 CIPHERSSSL 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. 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. 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 name can be up to 28 characters.
-
getSecurityname
java.lang.String getSecurityname()
Getter for field SECURITYNAMESecurity 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 LINKAUTHLink security
Specifies how the user ID for link security is established in a CICS system with security initialized (SEC=YES).
- CERTUSER - TCP/IP communication with the partner system must be configured for SSL and a certificate must be received from the partner system during SSL handshake. For example, the TCPIPSERVICE in the partner CICS system should be defined with SSL(YES) or SSL(CLIENTAUTH) In addition, this received certificate must be defined to the external security manager so that it is associated with a user ID. This user ID is used to establish link security.
- SECUSER - The user ID specified in SECURITYNAME is used to establish link security. This is the default value.
-
getIdprop
IIPICConnectionDefinition.IdpropValue getIdprop()
Getter for field IDPROPIdentity 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.
- NOTALLOWED: A user ID associated with the sending transaction is sent for requests using this connection. NOTALLOWED is the default value.
- OPTIONAL: A distributed identity is sent, if available. The user ID associated with the sending transaction is also sent.
- REQUIRED: A distributed identity is required for requests using this connection. If REQUIRED is specified, the receiving system must support distributed identities. The user ID associated with the sending transaction is not sent. If you specify IDPROP(REQUIRED), a task using the IPIC connection must have an associated distributed identity, otherwise the request fails with a security error.
-
getMirrorlife
IIPICConnectionDefinition.MirrorlifeValue getMirrorlife()
Getter for field MIRRORLIFEMinimum 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.
- REQUEST: The mirror task will terminate as soon as possible.
- TASK: The mirror task remains available to the application issuing the remote request the until the end of this application's task.
- UOW: The mirror transaction remains available to the application issuing the remote request until the next syncpoint is issued.
-
getHighAvailability
IIPICConnectionDefinition.HighAvailabilityValue getHighAvailability()
Getter for field HAHigh availability
The status of the high availability of the IPIC connection.
- NO
- The connection is not highly available. The connection will not be acquired with another region in the CICS server cluster in the event of the connection failure with the current server region.
- YES
- The connection is highly available. The connection will be acquired automatically with another region in the CICS server cluster in the event of the connection failure with the current server region.
-
getCICSObjectReference
ICICSDefinitionReference<IIPICConnectionDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSDefinition
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-