com.ibm.cics.model

Interface IConnectionDefinition

    • Method Detail

      • getAccessmethod

        IConnectionDefinition.AccessmethodValue getAccessmethod()
        Getter for field ACCESSMETHOD

        Access method

        The access method to be used for this connection:

        • APPC - advanced program-to-program communication.
        • EXCI - connection is for use by a program using the external CICS interface.
        • INDIRECT - communication between the local CICS system and the system defined by this connection definition is through the system named in the Intermediate system name field.
        • IRC - connection uses the interregion communication program DFHIRP. This is the access method for MRO.
        • NETBIOS - connection uses the NETBIOS LAN protocol
        • VTAM - VTAM intersystem communication.
        • XM - MVS cross-memory services.
      • getAttachsec

        IConnectionDefinition.AttachsecValue getAttachsec()
        Getter for field ATTACHSEC

        Level of attach-time security

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

        • IDENTIFY - Incoming attach requests must specify a user identifier. Enter IDENTIFY when the connecting system has a security manager; for example, if it is another CICS system.
        • LOCAL - The authority of the user is taken to be that of the link itself, and you rely on link security alone to protect your resource. If the PROTOCOL attribute on the CONNECTION definition is LU6.1, you must specify LOCAL.
        • MIXIDPE - Incoming attach requests may be using either or both IDENTIFY or PERSISTENT security types. The security type actually used depends on the incoming attach request.
        • PERSISTENT - Incoming attach requests must specify a user identifier and a user password on the first attach request.
        • VERIFY - Incoming attach requests must specify a user identifier and a user password.
      • getAutoconnect

        IConnectionDefinition.AutoconnectValue getAutoconnect()
        Getter for field AUTOCONNECT

        Autoconnect sessions for VTAM

        Indicates whether sessions with this connection are to be bound when CICS is initialized or whenever communication with VTAM is started:

        • ALLCONN - Associated sessions are bound. The associated modename is generally also specifed as ALLCONN.
        • AUTOCONN - Associated sessions are bound.
        • NONAUTOCONN - Associated sessions are not bound.

      • getBindsecurity

        IConnectionDefinition.BindsecurityValue getBindsecurity()
        Getter for field BINDSECURITY

        Bind time security

        Indicates whether an external security manager (ESM) is being used for bind-time security:

        • NO - No external bind-time security is required.
        • YES - If security is active and the XAPPC system initialization parameter is set to YES, an ESM is called.
      • getConntype

        IConnectionDefinition.ConntypeValue getConntype()
        Getter for field CONNTYPE

        Nature of connection

        The nature of the connection for external CICS interface (EXCI) connections:

        • GENERIC - the connection is for communication from a non-CICS client program to the CICS system, and is generic. A generic connection is an MRO link with a number of sessions to be shared by multiple EXCI users. For a generic connection you cannot specify the NETNAME attribute.
        • SPECIFIC - The connection is for communication from a non-CICS client program to the CICS region, and is specific. A specific connection is an MRO link with one or more sessions dedicated to a single user in a client program. For a specific connection, NETNAME is mandatory.
        • APPC - connection to another CICS system using APPC.
        • NOTAPPLIC - The connection does not use EXCI.
      • getDatastream

        IConnectionDefinition.DatastreamValue getDatastream()
        Getter for field DATASTREAM

        Data stream type

        The type of data stream:

        • LMS - Specify the type of data stream.
        • SCS - The data stream is an SCS data stream as defined in the LUTYPE6.1 architecture.
        • STRFIELD - The data stream is a structured field data stream as defined in the LUTYPE6.1 architecture.
        • USER - User-defined data stream.
        • 3270 - The data stream is a 3270 data stream as defined in the type 6.1 logical unit (LUTYPE6.1) architecture.
      • getIndsys

        java.lang.String getIndsys()
        Getter for field INDSYS

        Intermediate system name

        The name of an intermediate system that is used to relay communications between this system and the remote system. The name can be up to four characters in length. You can name an intermediate system only if you specify INDIRECT in the Access method field.

      • getInservice

        ICICSEnums.YesNoValue getInservice()
        Getter for field INSERVICE

        Connection status

        For connections using either the APPC or MRO protocol, the status of the connection as one of the following:

        • ACQUIRED - The connection is acquired, which means the partner LU has been contacted and the initial CNOS exchange has been done.
        • AVAILABLE - The connection is acquired, but there are currently no bound sessions.
        • FREEING - The connection is being released.
        • NOTAPPLIC - The connection is not a CICS-to-CICS MRO or an APPC connection.
        • OBTAINING - The connection is being acquired.
        • RELEASED - The connection is released.

      • getMaxqtime

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

        Maximum queue time

        The maximum wait time for queued allocate requests waiting for free sessions on a connection that appears to be unresponsive. The maximum queue time is used only if a queue limit is specified in the Queue limit field, and then the time limit is applied only when the queue length has reached the queue limit value. Options are:

        • NO - There is no limit on the time that allocate requests can remain queued.
        • nnnn - The approximate upper limit on the time that allocate requests can be queued for a connection that appears to be unresponsive. The number represents seconds in the range 0 through 9999.

        If you do not specify a queue limit, leave this field blank.

      • getNetname

        java.lang.String getNetname()
        Getter for field NETNAME

        Network name

        The intercommunication link to the system that owns the connection. The name can be up to eight characters in length.

      • getProtocol

        IConnectionDefinition.ProtocolValue getProtocol()
        Getter for field PROTOCOL

        Protocol

        For connections with an access method of VTAM, indicates which SNA protocol is in use, either LUTYPE6.1 (LU61) or Advanced Program-to-Program Communication (APPC). A value of EXCI means this connection uses the External CICS Interface. A value of NOTAPPLIC means this connection is not a VTAM connection.

      • getPsrecovery

        IConnectionDefinition.PsrecoveryValue getPsrecovery()
        Getter for field PSRECOVERY

        Persistent session recovery

        In a CICS region running with persistent sessions support, this specifies whether, and how, LU6.2 sessions are recovered on system restart within the persistent session delay interval:

        • NONE - All sessions are unbound as out-of-service with no CNOS recovery.
        • SYSDEFAULT - If a failed CICS system is restarted within the persistent session delay interval, the following actions occur:
          • User modegroups are recovered to the SESSIONS RECOVOPTION value.
          • The SNASVCMG modegroup is recovered.
          • The connection is returned in ACQUIRED state and the last negotiated CNOS state is returned
        • N_A - The value does not apply to this definition and should not be validated.
      • 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 set to the number of allocate requests that CICS can queue while waiting for a free session.
        • nnnn - 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.
      • getRecordformat

        IConnectionDefinition.RecordformatValue getRecordformat()
        Getter for field RECORDFORMAT

        Record format

        The type of SNA chain.

        • U - a single, unblocked stream of data.
        • VB - the SNA chain is formatted according to the VLVB standard as defined in the LUTYPE6.1 architecture.
      • getRemotename

        java.lang.String getRemotename()
        Getter for field REMOTENAME

        Connection name in remote system

        The name by which the APPC connection for transaction routing is known in the system or region that owns the connection. The name can be up to four characters in length.

      • getRemotesysnet

        java.lang.String getRemotesysnet()
        Getter for field REMOTESYSNET

        Net name of the owning TOR

        The network name (APPLID) of the system that owns the connection. The name can be up to four characters in length.

      • getRemotesystem

        java.lang.String getRemotesystem()
        Getter for field REMOTESYSTEM

        Remote connection name

        The intercommunication link to the system that owns the connection. The name can be up to four characters in length.

      • getSecurityname

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

        Security name for remote system

        For APPC and LU6.1 links only, this is the security name of the remote system. The security name (or USERID on the sessions definition) must be a valid RACF user ID on your system.

      • getSinglesess

        IConnectionDefinition.SinglesessValue getSinglesess()
        Getter for field SINGLESESS

        APPC terminal on single session APPC link

        Identifies whether the definition is for an APPC terminal on a single session APPC link to CICS.

        • NO - The definition is not for a single session APPC link to CICS.
        • YES - The definition is for an APPC terminal on a single session APPC link to CICS.
        • N_A - The value does not apply to this definition and should not be validated by CICSPlex SM.
      • 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.

      • getUsedfltuser

        IConnectionDefinition.UsedfltuserValue getUsedfltuser()
        Getter for field USEDFLTUSER

        Use default user ID

        The action that is taken when an inbound FMH5 does not contain the security information implied by the ATTACHSEC attribute:

        • NO - the attach request is rejected, and a protocol violation message is issued.
        • YES - use the default user ID specified in the DFLUSER SIT parameter for the CICS system.
        • N_A - the value does not apply to this definition and should not be validated by CICSPlex SM

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.