com.ibm.cics.model

Interface ITCPIPService

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        TCP/IP service name

        TCP/IP service name

        Specified by:
        getName in interface ICICSObject
      • getPort

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

        Port number

        The port number on which the managed CICS system is listening for incoming client requests.

      • getBacklog

        java.lang.Long getBacklog()
        Getter for field BACKLOG

        Queue backlog setting

        The setting for the maximum number of requests which can be queued in TCP/IP waiting to be processed.

        Input Values: 0 - 32767.

        If the value of BACKLOG is greater than the TCP/IP configuration value for SOMAXCONN, TCP/IP uses the value specified by the SOMAXCONN attribute.
      • getServiceStatus

        ITCPIPService.ServiceStatusValue getServiceStatus()
        Getter for field OPENSTATUS

        TCP/IP service status

        The state of the TCP/IP service definition as follows:

        • OPEN - Input is accepted from this TCP/IP service definition.
        • OPENING - Input is not accepted from this TCP/IP service definition. The service is in the process of OPENING.
        • CLOSED - Input is not accepted from this TCP/IP service definition.
        • CLOSING - Input is not accepted from this TCP/IP service definition. The service is in the process of CLOSING.
        • IMMCLOSE - Input is not accepted from this TCP/IP service definition. If a managed CICS system has transactions that are using the TCP/IP service definition, these transactions may be abnormally terminated.
        • IMMCLOSING - Input is not accepted from this TCP/IP service definition. CICS internal sockets support is in the process of immediate termination.
      • getTransid

        java.lang.String getTransid()
        Getter for field TRANSID

        CICS transaction ID

        The identifier of the transaction which is attached to process requests received for this service.

      • getUrm

        java.lang.String getUrm()
        Getter for field URM

        User-replaceable module name

        The name of the user-replaceable module to be invoked by this service.

      • getSsltype

        ITCPIPService.SsltypeValue getSsltype()
        Getter for field SSLTYPE

        Secure sockets layer (SSL) type

        Whether the service uses secure sockets layer.

        • NOSSL - The service does not use secure sockets layer.
        • SSL - Secure sockets layer is used by this service except for client authentication.
        • CLIENTAUTH - Secure sockets layer is used by this service including client authentication.
        • ATTLSAWARE - CICS expects AT-TLS to secure the client connections for this service. This may support client authentication.
      • getNumOfConnections

        java.lang.Long getNumOfConnections()
        Getter for field CONNECTIONS

        Number of connections

        The current number of socket connections associated with this service.

      • getTSQueuePrefix

        java.lang.String getTSQueuePrefix()
        Getter for field TSQPREFIX

        TS queue prefix

        This parameter is no longer required or used in CICS Transaction Server for z/OS, Version 3 Release 2 and later releases.

      • getIPAddress

        java.lang.String getIPAddress()
        Getter for field IPADDRESS

        IPv4 address of the service

        The IPv4 dotted-decimal address of the server this TCPIPSERVICE is listening on, ANY, INADDR_ANY or DEFAULT.

      • getTranattach

        java.lang.Long getTranattach()
        Getter for field TRANATTACH

        Number of transactions attached

        The total number of transactions attached via this TCP/IP Service.

      • getPeakconns

        java.lang.Long getPeakconns()
        Getter for field PEAKCONNS

        Peak number of connections

        The peak number of socket connections in use across this TCP/IP Service.

      • getGmtservopn

        java.util.Date getGmtservopn()
        Getter for field GMTSERVOPN

        GMT service open time

        The Greenwich mean time at which this TCP/IP service was opened.

      • getTimeopen

        java.util.Date getTimeopen()
        Getter for field TIMEOPEN

        Local service open time

        The local time at which this TCP/IP service was opened.

      • getSends

        java.lang.Long getSends()
        Getter for field SENDS

        Number of sends across all sockets

        The total number of sends made across all sockets in this TCP/IP Service.

      • getBytesent

        java.lang.Long getBytesent()
        Getter for field BYTESENT

        Number of bytes sent across all sockets

        The total number of bytes sent across all sockets in this TCP/IP Service.

      • getReceives

        java.lang.Long getReceives()
        Getter for field RECEIVES

        Number of receives across all sockets

        The total number of receives made across all sockets in this TCP/IP Service.

      • getBytercvd

        java.lang.Long getBytercvd()
        Getter for field BYTERCVD

        Number of bytes received across all sockets

        The total number of bytes received across all sockets in this TCP/IP Service.

      • getSocketCloseAction

        ITCPIPService.SocketCloseActionValue getSocketCloseAction()
        Getter for field SOCKETCLOSE

        Socket close action

        The action taken by the managed CICS system if no data is received from the socket.

        • WAIT - The managed CICS system waits and does not close the socket if no data is received.
        • TIMEOUT - The managed CICS system will close the socket if no data has been received after the period specified in the close timeout parameter.
      • getClosetimeout

        java.lang.Long getClosetimeout()
        Getter for field CLOSETIMEOUT

        Timeout for socket close (seconds)

        The period in seconds after which the managed CICS system will close the socket if no data is received. This value applies when the socket close parameter is TIMEOUT.

      • getAuthenticate

        ITCPIPService.AuthenticateValue getAuthenticate()
        Getter for field AUTHENTICATE

        Authentication level

        The level of authentication used by this TCP/IP resource.

      • getCertificate

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

        Certificate

        The name of a certificate within the key ring file that is to be used in the SSL handshake for this TCP/IP service.

      • getProtocol

        ITCPIPService.ProtocolValue getProtocol()
        Getter for field PROTOCOL

        Protocol

        The name of the protocol being used by this TCP/IP resource:

        • ECI - ECI over TCP/IP protocol.
        • HTTP - Hypertext Transfer protocol.
        • IIOP - This is obsolete from CICS TS Version 5 Release 1. Internet Inter-orb protocol.
        • IPIC - IP Interconnectivity protocol.
        • USER - User-defined protocol.
      • getDnsgroup

        java.lang.String getDnsgroup()
        Getter for field DNSGROUP

        Domain name service (DNS) group

        This is obsolete from CICS TS Version 5 Release 2. The DNS Group Name.

      • getDnsstatus

        ITCPIPService.DnsstatusValue getDnsstatus()
        Getter for field DNSSTATUS

        Domain name service (DNS) status

        This is obsolete from CICS TS Version 5 Release 2. The current state of WLM/DNS registration for this TCP/IP service:

        • NOTAPPLIC - This service is not using DNS connection optimization. No DNSGROUP attribute was specified when the resource was installed.
        • UNAVAILABLE - Registration is not supported by OS/390
        • UNREGISTERED - Registration has not yet occurred (this is the initial state of any service).
        • REGISTERED - Registration has completed successfully.
        • REGERROR - Registration has failed with an error.
        • DEREGISTERED - Deregistration has completed successfully.
        • DEREGERROR - Deregistration has failed with an error.
      • getGrpcritical

        ITCPIPService.GrpcriticalValue getGrpcritical()
        Getter for field GRPCRITICAL

        Critical domain name service (DNS) group member

        This is obsolete from CICS TS Version 5 Release 2. Whether or not this TCP/IP service is a critical member of the DNS group:

        • CRITICAL - If this TCPIPSERVICE is closed, or abnormally stops listening for any reason, the group name specified in the DNSGROUP attribute is deregistered from WLM.
        • NONCRITICAL - If this TCPIPSERVICE is closed, or abnormally stops listening for any reason, the group name specified in the DNSGROUP attribute is not deregistered from WLM, unless this is the last service in a set with the same group name.
      • getAttachsec

        ITCPIPService.AttachsecValue getAttachsec()
        Getter for field ATTACHSEC

        Attach-time security

        Indicates, for ECI over TCP/IP services, the level of attach-time security used by connections to CICS Clients:

        • LOCAL - CICS does not require a user ID or password from clients.
        • VERIFY - Incoming attach requests must specify a user identifier and a user password.
      • getPrivacy

        ITCPIPService.PrivacyValue getPrivacy()
        Getter for field PRIVACY

        Privacy for clients using this service

        This is obsolete from CICS TS Version 3 Release 1. Indicates the level of SSL encryption required for inbound connections to this service.

        • REQUIRED - Encryption must be used.
        • SUPPORTED - Encryption is used if both client and server support it.
        • NOTSUPPORTED - Encryption must not be used.
      • 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. From CICS Transaction Server 5.1 this field can alternatively specify the name of an XML file residing on zFS which contains a list of ciphers. An XML file can be up to 28 characters.

      • 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. A value of 0 could indicate the use of an XML cipher file.

      • getMaxdatalen

        java.lang.Long getMaxdatalen()
        Getter for field MAXDATALEN

        Maximum length of data that may be received

        The maximum length of data that may be received on this TCP/IP service.

      • getRealm

        java.lang.String getRealm()
        Getter for field REALM

        Basic authentication realm name

        The realm that is provided when CICS requests basic authentication.

      • 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

        ITCPIPService.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last 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 - The resource was last changed by a CICSPlex SM BAS API command.
        • DREPBATCH - The resource was last changed by a CICSPlex SM utility.
        • SYSTEM - The resource was last changed by the CICS or CICSPlex SM system.
        • CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
        • NOTAPPLIC - This is not applicable for this resource.
      • 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

        ITCPIPService.InstallAgentValue getInstallAgent()
        Getter for field INSTALLAGENT

        Installation agent

        The install agent identifier that made the installation.

        • CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
        • CREATESPI - The resource was installed by an EXEC CICS CREATE command.
        • GRPLIST - The resource was installed by GRPLIST INSTALL.
        • BUNDLE - The resource was installed by a bundle deployment.
      • 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.

      • getIpresolved

        java.lang.String getIpresolved()
        Getter for field IPRESOLVED

        Resolved IP address

        The resolved IPv4 or IPv6 address this TCPIPSERVICE is listening on, or 0.0.0.0 if it is unavailable or unknown.

        If the address given in HOST is ANY or DEFAULT the resolved IP address is dynamically selected from the list of IP addresses associated with the IP stack that is in use by the application. This IP address changes depending on which socket is used and what server or current IP address is used for the listener.

        IPFAMILY gives the format of this IP address.

      • getHosttype

        ITCPIPService.HosttypeValue getHosttype()
        Getter for field HOSTTYPE

        The listening server's address format

        The format of the address in the HOST field that this service should listen on.

        • ANY - The ANY option has been specified for the server's address
        • DEFAULT - The DEFAULT option has been specified for the server's address
        • HOSTNAME - The server's address is a character host name. The IP address that corresponds to the host name is looked up in a domain name server
        • IPV4 - The server's address is an IPv4 address specified in dotted decimal address format
        • IPV6 - The server's address is an IPv6 address specified in colon hexadecimal address format
        • NOTAPPLIC - The server's host name or address is incorrect
      • getIpfamily

        ITCPIPService.IpfamilyValue getIpfamily()
        Getter for field IPFAMILY

        Resolved IP address format

        The format of this service's resolved IP address shown in IPRESOLVED.

        • IPV4 - IPRESOLVED contains an IPv4 address specified in dotted decimal address format.
        • IPV6 - IPRESOLVED contains an IPv6 address specified in colon hexadecimal address format.
        • UNKNOWN - IPRESOLVED is not yet in use, or the address cannot be resolved. This is the default when IPRESOLVED is 0.0.0.0
      • getHost

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

        Server address to listen on

        The host name or IP address of the server this TCPIPSERVICE should listen on for incoming requests, ANY or DEFAULT. The HOSTTYPE option gives the format of this value, as either a host name, an IPv4 address, an IPv6 address, ANY, DEFAULT or NOTAPPLIC.

        IPRESOLVED has the numerical IP address actually used.

      • getMaxpersist

        java.lang.Long getMaxpersist()
        Getter for field MAXPERSIST

        Maximum persistent connections

        The maximum number of persistent connections the CICS will accept. The value is in the range 0-65535, or will have the standard null value of -1 if MAXPERSIST(NO) is specified on the MAXPERSIST definition.

      • getNonpersist

        java.lang.Long getNonpersist()
        Getter for field NONPERSIST

        Number of non-persisted connections

        The number of non-persisted connections that have been made above the maxpersist limit.

      • getSpecificTCPIPService

        java.lang.String getSpecificTCPIPService()
        Getter for field SPECIFTCPS

        Specific TCPIPService

        The name of the specific TCP/IP Service that this TCP/IP Service uses. When named, this TCP/IP Service is a generic TCP/IP Service.

      • getGenericTCPIPService

        java.lang.String getGenericTCPIPService()
        Getter for field GENERICTCPS

        Generic TCPIPService

        The name of the generic TCP/IP Service that this TCP/IP Service uses. When named, this TCPIPSERVICE is a specific TCP/IP Service.

      • getTotalConnections

        java.lang.Long getTotalConnections()
        Getter for field TOTALCONNS

        Total connections

        The total number of connections made for the TCP/IP service.

      • getTimesConnectionMadeNonPersistentAtMaxPersist

        java.lang.Long getTimesConnectionMadeNonPersistentAtMaxPersist()
        Getter for field NPERSATMAXP

        Times a connection was made non-persistent because MAXPERSIST was reached

        The number of times a new persistent connection was made non-persistent because MAXPERSIST was reached.

      • getTimesConnectionMadeNonPersistentAtTaskLimit

        java.lang.Long getTimesConnectionMadeNonPersistentAtTaskLimit()
        Getter for field NPERSATTLIM

        Times a connection made non-persistent at task limit

        The number of times a new persistent HTTP connection was made non-persistent because the number of tasks in the region has exceeded the limit.

      • getTimesDisconnectedAtTaskLimit

        java.lang.Long getTimesDisconnectedAtTaskLimit()
        Getter for field DISCATTLIM

        Times disconnected a persistent connection at task limit

        The number of times an existing persistent HTTP connection was closed because the number of tasks in the region has exceeded the limit.

      • getTimesDisconnectedAtMaxUses

        java.lang.Long getTimesDisconnectedAtMaxUses()
        Getter for field DISCATUSELIM

        Times disconnected an connection at max uses

        The number of times a persistent HTTP connection was disconnected because its number of uses had exceeded the limit.

      • getCurrentBacklog

        java.lang.Long getCurrentBacklog()
        Getter for field CURRBACKLOG

        Current backlog

        The current number of connection requests in the backlog, summed over all appropriate stacks if the TCP/IP service is listening on multiple stacks.

      • getConnectionsDropped

        java.lang.Long getConnectionsDropped()
        Getter for field CONNSDROPPED

        Connections dropped

        The total number of connections dropped due to the TCP/IP service's backlog queue being full, summed over all appropriate stacks if the TCP/IP service is listening on multiple stacks.

      • getTimeConnectionLastDropped

        java.lang.String getTimeConnectionLastDropped()
        Getter for field CONNLASTDROP

        Time connection last dropped

        The time that a connection was last rejected due to the TCP/IP service's backlog queue being full.

      • getCurrentMaximumBacklog

        java.lang.Long getCurrentMaximumBacklog()
        Getter for field CMAXBACKLOG

        Current maximum backlog

        The maximum value currently being used as the backlog for the TCP/IP service over all stacks. This may be greater than the value specified using the TCP/IP service's BACKLOG attribute as TCP/IP may increase this if e.g. it thinks there is a SYN flood.

      • getRequests

        java.lang.Long getRequests()
        Getter for field REQUESTS

        Requests

        The number of requests processed by the TCP/IP service.

      • getOptionsProgram

        java.lang.String getOptionsProgram()
        Getter for field OPTIONSPGM

        HTTP OPTIONS handler program

        The name of the user-replaceable module to be invoked when an HTTP OPTIONS request is to be processed.

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