CICS® Transaction Gateway Programming Reference v1.1.0.0

Serialized Form


Package com.ibm.connector2.cics

Class com.ibm.connector2.cics.AIDKey extends AID implements Serializable

Class com.ibm.connector2.cics.CICSConnectionFactory extends java.lang.Object implements Serializable

Serialized Fields

ref

javax.naming.Reference ref

raMeta

javax.resource.cci.ResourceAdapterMetaData raMeta

mcf

CICSManagedConnectionFactory mcf

cm

javax.resource.spi.ConnectionManager cm

Class com.ibm.connector2.cics.CICSInteractionSpec extends java.lang.Object implements Serializable

Serialized Fields

functionName

java.lang.String functionName

interactionVerb

int interactionVerb

Class com.ibm.connector2.cics.CICSLogHelper extends java.lang.Object implements Serializable

Serialized Fields

traceLevel

int traceLevel

Class com.ibm.connector2.cics.CICSManagedConnectionFactory extends java.lang.Object implements Serializable

Serialized Fields

cicsRA

javax.resource.spi.ResourceAdapter cicsRA

connectionURL

java.lang.String connectionURL

serverName

java.lang.String serverName

userName

java.lang.String userName

password

java.lang.String password

requestExits

java.lang.String requestExits

applid

java.lang.String applid

applidQualifier

java.lang.String applidQualifier

portNumber

int portNumber

socketConnectTimeout

int socketConnectTimeout

clientSecurity

java.lang.String clientSecurity

serverSecurity

java.lang.String serverSecurity

keyRingClass

java.lang.String keyRingClass

keyRingPassword

java.lang.String keyRingPassword

cipherSuites

java.lang.String cipherSuites

interceptPlugin

java.lang.String interceptPlugin

traceLevel

int traceLevel

cf

CICSConnectionFactory cf

local

boolean local

Class com.ibm.connector2.cics.CICSResourceAdapter extends java.lang.Object implements Serializable

Serialized Fields

logHelper

com.ibm.connector2.cics.CICSLogHelper logHelper

Class com.ibm.connector2.cics.CICSResourceAdapterMetaData extends java.lang.Object implements Serializable

Serialized Fields

adapterName

java.lang.String adapterName

shortDesc

java.lang.String shortDesc

iSpecs

java.lang.String[] iSpecs

execWithIO

boolean execWithIO

execIonly

boolean execIonly

suppLocalTxn

boolean suppLocalTxn

Class com.ibm.connector2.cics.CICSTxnAbendException extends javax.resource.ResourceException implements Serializable

Class com.ibm.connector2.cics.CICSUserInputException extends javax.resource.spi.InvalidPropertyException implements Serializable

Class com.ibm.connector2.cics.ECIChannelRecord extends java.lang.Object implements Serializable

Serialized Fields

myChannel

Channel myChannel

description

java.lang.String description

logHelper

com.ibm.connector2.cics.CICSLogHelper logHelper

Class com.ibm.connector2.cics.ECIConnectionFactory extends CICSConnectionFactory implements Serializable

Serialized Fields

nonManaged

boolean nonManaged

Class com.ibm.connector2.cics.ECIInteractionSpec extends java.lang.Object implements Serializable

Serialized Fields

InteractionVerb

int InteractionVerb
The Synchronisation setting for this InteractionSpec.

FunctionName

java.lang.String FunctionName
The name of the CICS program to run.


ExecuteTimeout

int ExecuteTimeout
The timeout value associated with the current ECIInteraction.execute() call. This value has differing meanings depending on the Interaction Verb context: This value cannot be negative. If a negative value is passed to the constructor then it will default to 0. If setExecuteTimeout() is called with a negative value an exception will be thrown.


commareaLength

int commareaLength
This value defines the length of COMMAREA that is expected.


replyLength

int replyLength
This value represents the amount of data returned from the interaction with CICS.


tranName

java.lang.String tranName
This value represents the mirror transaction used in CICS for the ECI request.


TPNName

java.lang.String TPNName
This value represents the TPN transaction used in CICS.

Class com.ibm.connector2.cics.ECIManagedConnectionFactory extends CICSManagedConnectionFactory implements Serializable

Serialized Fields

tranName

java.lang.String tranName
This is the transid of the transaction that the specified program will run under on CICS.


TPNName

java.lang.String TPNName
This is the TPN id of the transaction that the specified program will run under on CICS.


websphere

boolean websphere
This flag indicates whether the resource adapter is being used under WAS managed mode. It will return false if being used under WAS in non managed mode.

Class com.ibm.connector2.cics.ECIResourceAdapter extends com.ibm.connector2.cics.CICSResourceAdapter implements Serializable

Class com.ibm.connector2.cics.EPIConnectionFactory extends CICSConnectionFactory implements Serializable

Class com.ibm.connector2.cics.EPIFieldAttrInfo extends java.lang.Object implements Serializable

Serialized Fields

modified

boolean modified

prot

boolean prot

numeric

boolean numeric

penDetectable

boolean penDetectable

display

boolean display

highIntensity

boolean highIntensity

underline

boolean underline

overline

boolean overline

leftline

boolean leftline

rightline

boolean rightline

trigger

boolean trigger

mandatoryFill

boolean mandatoryFill

mandatoryEntry

boolean mandatoryEntry

highlight

int highlight

trans

int trans

foreColour

int foreColour

backColour

int backColour

characterSet

int characterSet

Class com.ibm.connector2.cics.EPIFieldData extends java.lang.Object implements Serializable

Serialized Fields

name

java.lang.String name

text

java.lang.String text

pos

int pos

maxLength

int maxLength

Class com.ibm.connector2.cics.EPIFieldRecordImpl extends java.lang.Object implements Serializable

Serialized Fields

text

java.lang.String text

fieldAttrs

IFieldAttrInfo fieldAttrs

maxLength

int maxLength

fieldPos

int fieldPos

scrPos

int scrPos

textRow

int textRow

textCol

int textCol

scrWidth

int scrWidth

modified

boolean modified

recordName

java.lang.String recordName

recordDesc

java.lang.String recordDesc

Class com.ibm.connector2.cics.EPIInteractionSpec extends CICSInteractionSpec implements Serializable

Serialized Fields

ExecutionTimeout

int ExecutionTimeout

aid

AID aid

cursorRow

int cursorRow

cursorColumn

int cursorColumn

cursorMoved

boolean cursorMoved

outputAttributeType

int outputAttributeType

screenDepth

int screenDepth

screenWidth

int screenWidth

termId

java.lang.String termId

mapName

java.lang.String mapName

mapSetName

java.lang.String mapSetName

Class com.ibm.connector2.cics.EPIManagedConnectionFactory extends CICSManagedConnectionFactory implements Serializable

Serialized Fields

signonType

int signonType

deviceType

java.lang.String deviceType

encoding

java.lang.String encoding

logonLogoffClass

java.lang.String logonLogoffClass

readTimeout

int readTimeout

installTimeout

int installTimeout

Class com.ibm.connector2.cics.EPIResourceAdapter extends com.ibm.connector2.cics.CICSResourceAdapter implements Serializable

Class com.ibm.connector2.cics.EPIScreenInfo extends java.lang.Object implements Serializable

Serialized Fields

fldCount

int fldCount

width

int width

depth

int depth

highlight

boolean highlight

Class com.ibm.connector2.cics.EPIScreenRecordImpl extends java.lang.Object implements Serializable

Serialized Fields

screenId

java.lang.String screenId

scrDepth

int scrDepth

scrWidth

int scrWidth

fldCounter

int fldCounter

updateMode

boolean updateMode

fields

java.util.Vector<E> fields

modifiedFields

java.util.Vector<E> modifiedFields

recordName

java.lang.String recordName

recordDesc

java.lang.String recordDesc

Class com.ibm.connector2.cics.EPITranFailedException extends javax.resource.spi.EISSystemException implements Serializable

Serialized Fields

tranFailedReason

int tranFailedReason

Class com.ibm.connector2.cics.LocalTransactionNotStartedException extends javax.resource.spi.LocalTransactionException implements Serializable


Package com.ibm.connector2.screen

Class com.ibm.connector2.screen.BuildFieldException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.FieldNotFoundException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.FieldProtectedException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.FieldTextOverflowException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.IndexOutOfBoundsException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.NameNotFoundException extends ScreenException implements Serializable

Class com.ibm.connector2.screen.ScreenException extends java.lang.Exception implements Serializable


Package com.ibm.ctg.client

Class com.ibm.ctg.client.IDID extends java.lang.Object implements Serializable

Serialization Methods

readObject

public void readObject(java.io.DataInputStream arg0)
                throws java.io.IOException
Throws:
java.io.IOException

writeObject

public void writeObject(java.io.DataOutputStream arg0)
                 throws java.io.IOException
Throws:
java.io.IOException
Serialized Fields

distinguishedName

java.lang.String distinguishedName

realmName

java.lang.String realmName

isAuthenticated

boolean isAuthenticated

version_vrmf

int version_vrmf

Class com.ibm.ctg.client.TFileException extends java.io.IOException implements Serializable

Serialized Fields

rc

int rc

Class com.ibm.ctg.client.XARequest extends GatewayRequest implements Serializable

Serialization Methods

readObject

public void readObject(java.io.DataInputStream arg0)
                throws java.io.IOException
Throws:
java.io.IOException

writeObject

public void writeObject(java.io.DataOutputStream arg0)
                 throws java.io.IOException
Throws:
java.io.IOException
Serialized Fields

recoveredXids

javax.transaction.xa.Xid[] recoveredXids

currentXid

com.ibm.ctg.util.CTGXid currentXid

callType

int callType

xa_rc

int xa_rc

serverName

java.lang.String serverName

username

java.lang.String username

password

java.lang.String password

Package com.ibm.ctg.client.exceptions

Class com.ibm.ctg.client.exceptions.ChannelException extends java.lang.Exception implements Serializable

Class com.ibm.ctg.client.exceptions.ChannelNameException extends ChannelException implements Serializable

Class com.ibm.ctg.client.exceptions.ContainerException extends java.lang.Exception implements Serializable

Class com.ibm.ctg.client.exceptions.ContainerExistsException extends ContainerException implements Serializable

Class com.ibm.ctg.client.exceptions.ContainerNameException extends ContainerException implements Serializable

Class com.ibm.ctg.client.exceptions.ContainerNotFoundException extends ContainerException implements Serializable

Class com.ibm.ctg.client.exceptions.ContainerTypeException extends ContainerException implements Serializable


Package com.ibm.ctg.epi

Class com.ibm.ctg.epi.AID extends java.lang.Object implements Serializable

Serialized Fields

value

int value
The AID value, represented internally by an integer 0-28.

Class com.ibm.ctg.epi.DefaultScreenHandler extends ScreenHandler implements Serializable

Serialized Fields

exitKey

AID exitKey

Class com.ibm.ctg.epi.EPI3270Exception extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPIException extends java.lang.Exception implements Serializable

Serialized Fields

errorCode

int errorCode
Error Code, if available, of this exception. if not available then it will be 0

Class com.ibm.ctg.epi.EPIFieldException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPIGatewayException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPIMapException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPIRequestException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPIScreenException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPISecurityException extends EPIException implements Serializable

Class com.ibm.ctg.epi.EPITerminal extends java.lang.Object implements Serializable

Serialized Fields

terminal

TerminalInterface terminal
Terminal object we are using


jgateURL

java.lang.String jgateURL
Gateway URL property. The URL of the CICS Transaction Gateway to connect to for example setting the URL to tcp://buster:2006 would result in the terminal trying to connect to a CICS Transaction Gateway at the TCP/IP address buster and port number 2006.


jgateClientSec

java.lang.String jgateClientSec
Gateway Client Security class property. The client security class that is used to connect to the CICS Transaction Gateway. This is an Expert Property.


jgateServerSec

java.lang.String jgateServerSec
Gateway Server Security class property. The server security class that is used by the CICS Transaction Gateway. This is an Expert Property.


jgateInitialFlow

boolean jgateInitialFlow
Gateway initial flow flag - not a property, we set it ourselves


jgateSettingsChanged

boolean jgateSettingsChanged
Gateway settings changed flag - indicates that we need to copy the settings over to the JavaGateway object before it is opened.


transid

java.lang.String transid
Transaction ID property. This is the transaction that will be started when startTran is called.


data

java.lang.String data
Transaction Data property.


atiEnabled

boolean atiEnabled
ATI enabled property.


clock

com.ibm.ctg.epi.EPITerminal.Timer clock
Timer object - used to implement idle timeout.

Class com.ibm.ctg.epi.EPITerminalCustomizer extends com.ibm.ctg.epi.PagedDialog implements Serializable

Serialized Fields

terminal

EPITerminal terminal

jgateURL

java.awt.TextField jgateURL

jgateClientSec

java.awt.TextField jgateClientSec

jgateServerSec

java.awt.TextField jgateServerSec

termsettings

com.ibm.ctg.epi.TerminalInterfaceEditor termsettings

transid

java.awt.TextField transid

trandata

java.awt.TextField trandata

timeout

java.awt.TextField timeout

ati

java.awt.Checkbox ati

changes

java.beans.PropertyChangeSupport changes

Class com.ibm.ctg.epi.EPITxnFailedException extends EPIException implements Serializable

Serialized Fields

txnFailedReason

int txnFailedReason

Class com.ibm.ctg.epi.Field extends java.lang.Object implements Serializable

Serialized Fields

position

int position
The buffer address of the field.


row

int row
The row at which the field starts.


column

int column
The column at which the field starts.


highlight

int highlight
Extended highlighting state.


foreground

int foreground
Extended foreground colour.


background

int background
Extended background colour.


transparency

int transparency
Extended transparency state.


maxLength

int maxLength
Maximum length of the field - which is the number of characters to the start of the next field.


baseAttribute

char baseAttribute
Base field attribute. This is a character, although it would make more sense for it to be a byte.


hasAttribute

boolean hasAttribute
Attribute present flag.


bytesRep

byte[] bytesRep
Byte array representation of the field text. This is how the field is read from and written to the datastream. Converting the bytes to characters is relatively slow, so we don't do it until it is really needed.


strRep

java.lang.String strRep
String representation of the field text.


strChanged

boolean strChanged
Flag for lazy update of byte array. The byte representation will be updated from the String representation when the datastream is written out.


bytesChanged

boolean bytesChanged
Flag for lazy update of String. The String representation will be updated from the byte representation when the field text is requested.


encoding

java.lang.String encoding
The encoding to use for converting between the byte and String representation.

Class com.ibm.ctg.epi.FieldData extends java.lang.Object implements Serializable

Serialized Fields

row

int row
The row at which the field starts within the map.


col

int col
The column at which the field starts within the map.


len

int len
The field length.


label

java.lang.String label
The field label, or null if it is not labelled.

Class com.ibm.ctg.epi.Map extends java.lang.Object implements Serializable

Serialized Fields

mapData

MapData mapData
MapData class contains information about the map


fieldIndex

int[] fieldIndex
field index lists the indices of the fields that are labelled


fieldData

FieldData[] fieldData
FieldData class contains information about one field


fieldLabels

java.lang.String[] fieldLabels
array of field labels

Class com.ibm.ctg.epi.MapData extends java.lang.Object implements Serializable

Serialized Fields

row

int row
The row at which the map starts.


col

int col
The column at which the map starts.


width

int width
The map width in columns.


depth

int depth
The map depth in rows.


fields

int fields
The number of fields in the map.


labels

int labels
The number of labelled fields in the map.


name

java.lang.String name
The name of the map.

Class com.ibm.ctg.epi.Screen extends java.lang.Object implements Serializable

Serialized Fields

depth

int depth
The number of rows.


width

int width
The number of columns.


aid

AID aid
The AID to send to the server.


cursorRow

int cursorRow
The row position of the cursor.


cursorColumn

int cursorColumn
The column position of the cursor.


fields

java.util.Vector<E> fields
The current set of fields.


encoding

java.lang.String encoding
The character encoding to use for converting the datastream to text.


readMode

boolean readMode
Read mode flag. This is set to true when a read buffer command is received so that the Terminal knows to reply to the server.


lastIndex

int lastIndex
The index of the last field accessed. Speeds up finding fields when they are being accessed in order.


dataStream

com.ibm.ctg.epi.DataStream dataStream
Plug-in DataStream analyzer. If it was required to support a different sort of datastream, eg: tn3270, a new DataStream implementation can be plugged in, but programs that use Screen won't have to change.


mapName

java.lang.String mapName
The map and mapset names returned for a 3270 datastream.


mapSetName

java.lang.String mapSetName

Class com.ibm.ctg.epi.ScreenEvent extends java.util.EventObject implements Serializable

Serialized Fields

handler

ScreenHandler handler
ScreenHandler object associated with this event. This is not necessarily the source of the event.

Class com.ibm.ctg.epi.ScreenHandler extends java.lang.Object implements Serializable

Serialized Fields

aid

AID aid
the screen AID


cursorRow

int cursorRow
the screen cursor row


cursorCol

int cursorCol
the screen cursor column

Class com.ibm.ctg.epi.Terminal extends java.lang.Object implements Serializable

Serialization Methods

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException
Deserialises a terminal object. It will not be in a connected state after deserialisation.

Throws:
java.io.IOException
java.lang.ClassNotFoundException

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException
Serialises a terminal object.

Throws:
java.io.IOException
Serialized Fields

session

Session session

netname

java.lang.String netname

devtype

java.lang.String devtype

servername

java.lang.String servername

signoncapability

Terminal.EPISignOnType signoncapability

user

com.ibm.ctg.epi.Terminal.User user

readtimeout

int readtimeout

installtimeout

int installtimeout

encoding

java.lang.String encoding

CCSid

int CCSid

extendedTerminal

boolean extendedTerminal

purgeOnDisconnect

boolean purgeOnDisconnect

Class com.ibm.ctg.epi.Terminal.EPISignOnType extends java.lang.Object implements Serializable

Serialized Fields

INVALID_SIGNON

java.lang.String INVALID_SIGNON

SignonValue

int SignonValue

astrSignonCap

java.lang.String[] astrSignonCap

Class com.ibm.ctg.epi.TerminalEvent extends java.util.EventObject implements Serializable

Serialized Fields

term

TerminalSession term
terminal associated with this event. For the beans, this is EPITerminal


handled

boolean handled
event handled flag


error

java.lang.Exception error
error information


terminalRequest

int terminalRequest
the terminal request id

Class com.ibm.ctg.epi.TerminalException extends EPIException implements Serializable

Class com.ibm.ctg.epi.TerminalPool extends java.lang.Object implements Serializable

Serialized Fields

handlers

java.util.Vector<E> handlers

gotDefaultHandler

boolean gotDefaultHandler

name

java.lang.String name

maxTerminals

int maxTerminals

minTerminals

int minTerminals

jgateUrl

java.lang.String jgateUrl

handlerPath

java.lang.String handlerPath

defaultHandler

java.lang.String defaultHandler

poolProps

com.ibm.ctg.epi.PropertyManager poolProps

terminalProps

com.ibm.ctg.epi.PropertyManager terminalProps

random

java.util.Random random

Package com.ibm.ctg.ha

Class com.ibm.ctg.ha.InvalidRequestException extends java.lang.Exception implements Serializable


Package com.ibm.ctg.security

Class com.ibm.ctg.security.CICSPrincipal extends java.lang.Object implements Serializable

serialVersionUID: -3253579252982822464L

Serialized Fields

uniqueSecurityName

java.lang.String uniqueSecurityName

realmName

java.lang.String realmName

isAuthenticated

boolean isAuthenticated

Package com.ibm.ctg.util

Class com.ibm.ctg.util.CTGXid extends java.lang.Object implements Serializable

Serialization Methods

readObject

public void readObject(java.io.DataInputStream arg0)
                throws java.io.IOException
Throws:
java.io.IOException

writeObject

public void writeObject(java.io.DataOutputStream arg0)
                 throws java.io.IOException
Throws:
java.io.IOException
Serialized Fields

branchQualifier

byte[] branchQualifier

globalTransactionId

byte[] globalTransactionId

formatId

int formatId

Class com.ibm.ctg.util.DLLVersionMismatchException extends java.lang.Exception implements Serializable

Serialized Fields

gwVer

java.lang.String gwVer

dllVer

java.lang.String dllVer


©Copyright IBM Corp. 1994, 2014
Legal