com.ibm.cics.model
Interface ITCPIPServiceDefinition

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

public interface ITCPIPServiceDefinition
extends ICICSDefinition

generated from CICS resourcetable TCPDEF


Nested Class Summary
static class ITCPIPServiceDefinition.AttachsecValue
          Enumeration type for field ATTACHSEC
static class ITCPIPServiceDefinition.AuthenticateValue
          Enumeration type for field AUTHENTICATE
static class ITCPIPServiceDefinition.GrpcriticalValue
          Enumeration type for field GRPCRITICAL
static interface ITCPIPServiceDefinition.MaxpersistValue
          Long constants interface for field MAXPERSIST
static class ITCPIPServiceDefinition.PrivacyValue
          Enumeration type for field PRIVACY
static class ITCPIPServiceDefinition.ProtocolValue
          Enumeration type for field PROTOCOL
static class ITCPIPServiceDefinition.SslValue
          Enumeration type for field SSL
static class ITCPIPServiceDefinition.StatusValue
          Enumeration type for field STATUS
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 ITCPIPServiceDefinition.AttachsecValue getAttachsec()
          Getter for field ATTACHSEC
 ITCPIPServiceDefinition.AuthenticateValue getAuthenticate()
          Getter for field AUTHENTICATE
 java.lang.Long getBacklog()
          Getter for field BACKLOG
 java.lang.String getCertificate()
          Getter for field CERTIFICATE
 java.lang.String getCiphers()
          Getter for field CIPHERS
 java.lang.String getDnsgroup()
          Getter for field DNSGROUP
 ITCPIPServiceDefinition.GrpcriticalValue getGrpcritical()
          Getter for field GRPCRITICAL
 java.lang.String getHost()
          Getter for field HOST
 java.lang.String getIpaddress()
          Getter for field IPADDRESS
 java.lang.Long getMaxdatalen()
          Getter for field MAXDATALEN
 java.lang.Long getMaxpersist()
          Getter for field MAXPERSIST
 java.lang.Long getPortnumber()
          Getter for field PORTNUMBER
 ITCPIPServiceDefinition.PrivacyValue getPrivacy()
          Getter for field PRIVACY
 ITCPIPServiceDefinition.ProtocolValue getProtocol()
          Getter for field PROTOCOL
 java.lang.String getRealm()
          Getter for field REALM
 java.lang.String getSocketclose()
          Getter for field SOCKETCLOSE
 ITCPIPServiceDefinition.SslValue getSsl()
          Getter for field SSL
 ITCPIPServiceDefinition.StatusValue getStatus()
          Getter for field STATUS
 java.lang.String getTransaction()
          Getter for field TRANSACTION
 java.lang.String getTsqprefix()
          Getter for field TSQPREFIX
 java.lang.String getUrm()
          Getter for field URM
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
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
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getPortnumber

java.lang.Long getPortnumber()
Getter for field PORTNUMBER

Port number

The decimal number of the port on which CICS is to listen for incoming client requests in the range 1 through 65535. The well-known ports are those from 0 through 1023. It is advisable to use well known port numbers only for those services to which they are normally assigned.


getStatus

ITCPIPServiceDefinition.StatusValue getStatus()
Getter for field STATUS

TCP/IP service status

The initial status of the service after installation. Set it to OPEN if CICS is to begin listening for this service after installation. Set to CLOSE if CICS is not to listen on behalf of this service after installation.


getTransaction

java.lang.String getTransaction()
Getter for field TRANSACTION

CICS transaction ID

The 4-character ID of the CICS transaction attached to process new requests received for this service.


getUrm

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

User-replaceable module name

The name of a user-replaceable program to be invoked by this service. The name you specify depends upon the value of the PROTOCOL attribute:


getBacklog

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

Queue backlog limit

The number of TCP/IP connections for this service which are queued in TCP/IP before TCP/IP starts to reject incoming client requests.


getSsl

ITCPIPServiceDefinition.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:


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.


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.


getTsqprefix

java.lang.String getTsqprefix()
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

The IPv4 dotted decimal address for the TCP/IP Service, ANY, INADDR_ANY or DEFAULT. This parameter is maintained for compatibility with CICS Transaction Server for z/OS, Version 3 Release 2 and earlier releases. For later releases the HOST parameter should be used.


getSocketclose

java.lang.String getSocketclose()
Getter for field SOCKETCLOSE

Timeout for socket close (HHMMSS)

Specifies if, and for how long, CICS should wait before closing the socket, after issuing a receive for incoming data on that socket.


getAuthenticate

ITCPIPServiceDefinition.AuthenticateValue getAuthenticate()
Getter for field AUTHENTICATE

Authentication level

The authentication and identification scheme to be used for inbound TCP/IP connections for the HTTP and IIOP protocols. Each protocol supports a different set of authentication schemes. For the ECI protocol, this attribute is invalid. Options are:


getProtocol

ITCPIPServiceDefinition.ProtocolValue getProtocol()
Getter for field PROTOCOL

Protocol

The application level protocol used on the TCP/IP port:

ECI
ECI over TCP/IP protocol.
HTTP
Hypertext Transfer protocol. The HTTP protocol is handled by CICS Web support.
IIOP
Internet Inter-orb protocol. Used by TCPIPSERVICEs that are to accept inbound requests for enterprise beans and CORBA stateless objects.
IPIC
IP Interconnectivity protocol. If you specify IPIC you must also specify AUTHENTICATION as NOTAPPLIC.
NOTAPPLIC
CICS uses the default, HTTP, which requires a user-replaceable program to be specified.


getDnsgroup

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

Domain name service (DNS) group

The DNS Group Name.


getGrpcritical

ITCPIPServiceDefinition.GrpcriticalValue getGrpcritical()
Getter for field GRPCRITICAL

Critical domain name service (DNS) group member

(Optional) Marks the service as a critical member of the DNS group, meaning that this service closing or failing causes a deregister call to be made to WLM for this group name. The default is NO, allowing two or more services in the same group to fail independently and CICS still remains registered to the group. Only when the last service in a group is closed is the deregister call made to WLM, if it has not already been done so explicitly. Multiple services with the same group name can have different GRP Critical settings. The services specifying GRP Critical as NO can be closed or fail without causing a deregister. If a service with GRP Critical as YES is closed or fails, the group is deregistered from WLM.


getAttachsec

ITCPIPServiceDefinition.AttachsecValue getAttachsec()
Getter for field ATTACHSEC

Attach-time security

The level of attach-time security required for TCP/IP connections to CICS Clients:

Values other than NOTAPPLIC apply only when PROTOCOL(ECI) is specified.


getPrivacy

ITCPIPServiceDefinition.PrivacyValue getPrivacy()
Getter for field PRIVACY

Privacy

The level of SSL encryption required for inbound IIOP connections to this service. This attribute applies only when PROTOCOL is IIOP. During the SSL handshake, the client and server advertise cipher suites that they support and, from those that they both support, select the suite that offers the most secure level of encryption. Options are:


getCiphers

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

SSL cipher suite codes

(Optional) Specifies a value up to 28 cipher suites, in the form of hexadecimal pairs. Any hexadecimal can be specified, but currently the only recognized values are 01, 02, 03, 04, 05, 06, 09, 0A, 2F, and 35. Additional values can be added at a later time. No separating characters are necessary between each pair. The default is blank. Ciphers is valid only on CICS Transaction Server 3.1 and later systems.


getMaxdatalen

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

Maximum length of data to be received or sent

The maximum length of data that may be received by CICS as an HTTP server, on the HTTP protocol or the USER protocol. The default value is 32K. The minimum is 3K, and the maximum is 524288K. To increase security for CICS Web support, specify this option on every TCPIPSERVICE definition for the HTTP protocol. It helps to guard against denial of service attacks involving the transmission of large amounts of data.


getRealm

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

Basic authentication realm name

The realm that is provided when CICS requests basic authentication. This attribute is valid only on CICS Transaction Server for z/OS, Version 3 Release 2 and later systems. If you do not specify a realm, the default used by CICS is CICS application aaaaaaaa, where aaaaaaaa is the applid of the CICS region. The realm can be up to 56 characters long, and can include embedded blanks. Do not specify opening and closing double quotes, as CICS provides these when assembling the WWW-Authenticate header.


getHost

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

Incoming connections listening address

The up to 116-character address on which this TCPIPSERVICE will listen for incoming connections. This field may contain the following values:

Also note the following:


getMaxpersist

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

Maximum number of persistent connections

The maximum number of persistent connections that CICS will accept:



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