com.ibm.cics.model
Interface ITCPIPService

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource
All Known Subinterfaces:
IMutableTCPIPService

public interface ITCPIPService
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable TCPIPS


Nested Class Summary
static class ITCPIPService.AttachsecValue
          Enumeration type for field ATTACHSEC
static class ITCPIPService.AuthenticateValue
          Enumeration type for field AUTHENTICATE
static class ITCPIPService.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class ITCPIPService.DnsstatusValue
          Enumeration type for field DNSSTATUS
static class ITCPIPService.GrpcriticalValue
          Enumeration type for field GRPCRITICAL
static class ITCPIPService.HosttypeValue
          Enumeration type for field HOSTTYPE
static class ITCPIPService.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class ITCPIPService.IpfamilyValue
          Enumeration type for field IPFAMILY
static class ITCPIPService.PrivacyValue
          Enumeration type for field PRIVACY
static class ITCPIPService.ProtocolValue
          Enumeration type for field PROTOCOL
static class ITCPIPService.ServiceStatusValue
          Enumeration type for field OPENSTATUS
static class ITCPIPService.SocketCloseActionValue
          Enumeration type for field SOCKETCLOSE
static class ITCPIPService.SsltypeValue
          Enumeration type for field SSLTYPE
 
Method Summary
 ITCPIPService.AttachsecValue getAttachsec()
          Getter for field ATTACHSEC
 ITCPIPService.AuthenticateValue getAuthenticate()
          Getter for field AUTHENTICATE
 java.lang.Long getBacklog()
          Getter for field BACKLOG
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.Long getBytercvd()
          Getter for field BYTERCVD
 java.lang.Long getBytesent()
          Getter for field BYTESENT
 java.lang.String getCertificate()
          Getter for field CERTIFICATE
 ITCPIPService.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 getCiphers()
          Getter for field CIPHERS
 java.lang.Long getClosetimeout()
          Getter for field CLOSETIMEOUT
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 java.lang.String getDnsgroup()
          Getter for field DNSGROUP
 ITCPIPService.DnsstatusValue getDnsstatus()
          Getter for field DNSSTATUS
 java.util.Date getGmtservopn()
          Getter for field GMTSERVOPN
 ITCPIPService.GrpcriticalValue getGrpcritical()
          Getter for field GRPCRITICAL
 java.lang.String getHost()
          Getter for field HOST
 ITCPIPService.HosttypeValue getHosttype()
          Getter for field HOSTTYPE
 ITCPIPService.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.String getIPAddress()
          Getter for field IPADDRESS
 ITCPIPService.IpfamilyValue getIpfamily()
          Getter for field IPFAMILY
 java.lang.String getIpresolved()
          Getter for field IPRESOLVED
 java.lang.Long getMaxdatalen()
          Getter for field MAXDATALEN
 java.lang.String getName()
          Getter for field NAME
 java.lang.Long getNumciphers()
          Getter for field NUMCIPHERS
 java.lang.Long getNumOfConnections()
          Getter for field CONNECTIONS
 java.lang.Long getPeakconns()
          Getter for field PEAKCONNS
 java.lang.Long getPort()
          Getter for field PORT
 ITCPIPService.PrivacyValue getPrivacy()
          Getter for field PRIVACY
 ITCPIPService.ProtocolValue getProtocol()
          Getter for field PROTOCOL
 java.lang.String getRealm()
          Getter for field REALM
 java.lang.Long getReceives()
          Getter for field RECEIVES
 java.lang.Long getSends()
          Getter for field SENDS
 ITCPIPService.ServiceStatusValue getServiceStatus()
          Getter for field OPENSTATUS
 ITCPIPService.SocketCloseActionValue getSocketCloseAction()
          Getter for field SOCKETCLOSE
 ITCPIPService.SsltypeValue getSsltype()
          Getter for field SSLTYPE
 java.util.Date getTimeopen()
          Getter for field TIMEOPEN
 java.lang.Long getTranattach()
          Getter for field TRANATTACH
 java.lang.String getTransid()
          Getter for field TRANSID
 java.lang.String getTSQueuePrefix()
          Getter for field TSQPREFIX
 java.lang.String getUrm()
          Getter for field URM
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 

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 limit

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

Input Values: 0 - 32767.


getServiceStatus

ITCPIPService.ServiceStatusValue getServiceStatus()
Getter for field OPENSTATUS

TCP/IP service status

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


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.


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.


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:


getDnsgroup

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

Domain name service (DNS) group

The DNS Group Name.


getDnsstatus

ITCPIPService.DnsstatusValue getDnsstatus()
Getter for field DNSSTATUS

Domain name service (DNS) status

The current state of WLM/DNS registration for this TCP/IP service:


getGrpcritical

ITCPIPService.GrpcriticalValue getGrpcritical()
Getter for field GRPCRITICAL

Critical domain name service (DNS) group member

Whether or not this TCP/IP service is a critical member of the DNS group:


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:


getPrivacy

ITCPIPService.PrivacyValue getPrivacy()
Getter for field PRIVACY

Privacy for clients using this service

Indicates the level of SSL encryption required for inbound connections to this service.


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.


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.


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.


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


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.


getIpfamily

ITCPIPService.IpfamilyValue getIpfamily()
Getter for field IPFAMILY

Resolved IP address format

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


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.



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