CICS® Transaction Gateway Programming Reference v1.1.0.0
A B C D E F G H I J K L M N O P Q R S T U V W X Y

A

Abend_Code - Variable in class com.ibm.ctg.client.ECIRequest
CICS transaction abend code.
actionPerformed(ActionEvent) - Method in class com.ibm.ctg.epi.EPITerminal
Reacts to an action event by starting a transaction - the action command associated with the event is assumed to be the transaction name.
actionPerformed(ActionEvent) - Method in class com.ibm.ctg.epi.ScreenHandler
Handles an action event by converting the action command to an AID value and sending the screen to CICS.
addContainer(Container) - Method in class com.ibm.ctg.client.Channel
Adds the provided container to the channel.
addPropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Adds a PropertyChangeListener.
addPropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Adds a PropertyChangeListener.
addPropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Adds a PropertyChangeListener.
addPropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Add a listener to those that are informed when a bound property is changed.
addScreenEventListener(ScreenEventListener) - Method in class com.ibm.ctg.epi.ScreenHandler
The specified ScreenEventListener will be called when this ScreenHandler gains control of the screen and again when it loses control.
addTerminal(String, String, String) - Static method in class com.ibm.ctg.client.EPIRequest
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddTerminal on the CICS Transaction Gateway.
addTerminal(String, String, String, String, String, int, int, int, int) - Static method in class com.ibm.ctg.client.EPIRequest
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway.
addTerminalAsync(String, String, String, String, String, int, int, int, int) - Static method in class com.ibm.ctg.client.EPIRequest
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway.
addTerminalEventListener(TerminalEventListener) - Method in class com.ibm.ctg.epi.EPITerminal
Adds a TerminalEventListener to the list of screen handlers.
addtype - Variable in class com.ibm.ctg.client.EPIRequest
Method of adding a terminal either synchronously (EPI_ADD_SYNC) or asynchronously (EPI_ADD_ASYNC).
afterDecode(GatewayRequest) - Method in interface com.ibm.ctg.security.ClientSecurity
This method is called after an in-bound reply has been decoded.
afterDecode(GatewayRequest, X509Certificate[]) - Method in interface com.ibm.ctg.security.JSSEServerSecurity
This method is called after an in-bound request has been decoded.
afterDecode(GatewayRequest) - Method in interface com.ibm.ctg.security.ServerSecurity
This method is called after an in-bound request has been decoded.
AID - Class in com.ibm.ctg.epi
This class represents an AID character to be sent to CICS.
AID(String) - Constructor for class com.ibm.ctg.epi.AID
Construct an AID from a string representation.
AIDKey - Class in com.ibm.connector2.cics
This class represents an AID character to be sent to CICS.
AIDKey(String) - Constructor for class com.ibm.connector2.cics.AIDKey
Construct an AID Key from a string representation; for example 'enter'.
alphanumeric - Static variable in class com.ibm.ctg.epi.Field
Alphanumeric field.
alterSecurity(String, String) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object.
alterSecurity(String, String, int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object.
appendText(String) - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Append the given string to this field.
appendText(String) - Method in class com.ibm.ctg.epi.Field
Appends the given String to the field text.
asInt() - Method in class com.ibm.ctg.epi.Terminal.EPISignOnType
Returns the int value of the EPISignOnType.
astrCics_Rc - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Error code enumeration.
astrCics_Rc - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Error code enumeration.
astrCics_Rc - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
Error code enumeration.
astrCics_Rc2 - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Error code enumeration.
astrEndReason - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Error code enumeration.
astrGateway_Rc - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
Error code enumeration.
async - Static variable in interface com.ibm.ctg.epi.Session
Asynchronous EPI calls.
atiState - Variable in class com.ibm.ctg.client.EPIRequest
Input and output field for atiState() calls (Call_Type = EPI_ATI_STATE)
atiState(int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_ATI_STATE and also sets the atiState associated with this object.
atiState(int, int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_ATI_STATE and also sets the termIndex and atiState associated with this object.
ATTRIBUTE_BACKGROUNDCOLOR - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain the background colour attribute for streamable records
ATTRIBUTE_BASE - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain the base attribute for streamable records
ATTRIBUTE_FOREGROUNDCOLOR - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain the foreground colour attribute for streamable records
ATTRIBUTE_HIGHLIGHT - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain the highlight attribute for streamable records
ATTRIBUTE_MARKER - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain a field marker byte.
ATTRIBUTE_NONE - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain 0x20 for streamable records
ATTRIBUTE_TRANSPARENCY - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
Selects Attribute byte for field to contain the transparency attribute for streamable records
AutoJavaGateway - Class in com.ibm.ctg.client
This is a bootstrap class.

B

backgroundColor() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating the background color of the field.
baseAttribute() - Method in class com.ibm.ctg.epi.Field
Returns the 3270 base attribute of the field.
begin() - Method in class com.ibm.connector2.cics.CCILocalTransaction
Begins a new Local Transaction for the related Connection.
beginBuild(IScreenInfo, boolean) - Method in interface com.ibm.connector2.screen.IScreenable
Indicate the start of the field build process, providing Information about the Screen itself.
black - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color black.
black - Static variable in class com.ibm.ctg.epi.Field
The color black.
blinkHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Blink highlight.
blinkHlt - Static variable in class com.ibm.ctg.epi.Field
Blink highlight.
blue - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color blue.
blue - Static variable in class com.ibm.ctg.epi.Field
The color blue.
buildField(IFieldData, IFieldAttrInfo, ITextAttrInfo) - Method in interface com.ibm.connector2.screen.IScreenable
Adds a field to the screen record.
BuildFieldException - Exception in com.ibm.connector2.screen
This exception is thrown to indicate that a failure occurs when a field is being added to the screen record.
BuildFieldException() - Constructor for exception com.ibm.connector2.screen.BuildFieldException
Constructs a BuildFieldException with no detail message.
BuildFieldException(String) - Constructor for exception com.ibm.connector2.screen.BuildFieldException
Constructs a BuildFieldException with the specified detail message.

C

Call_Type - Variable in class com.ibm.ctg.client.ECIRequest
CICS ECI call type.
Call_Type - Variable in class com.ibm.ctg.client.EPIRequest
Type of EPI call.
Callbackable - Interface in com.ibm.ctg.client
The asynchronous model supported by the CICS Transaction Gateway allows the use of callback objects.
CCILocalTransaction - Class in com.ibm.connector2.cics
A CCILocalTransaction object is used to control the Transaction state of the ECI Connector.
CCSid - Variable in class com.ibm.ctg.client.EPIRequest
Terminal Code Page.
changePassword() - Method in class com.ibm.ctg.client.ESIRequest
Sets the ESI request object to be a Change Password Request.
changePassword(String, String, String, String) - Static method in class com.ibm.ctg.client.ESIRequest
This method returns a new ESI Request object which can be used to invoke a changePassword request.
changePassword(String) - Method in class com.ibm.ctg.epi.EPITerminal
Allows modification of the password for a given userid and current password with the External Security Manager
changePassword(String) - Method in class com.ibm.ctg.epi.Terminal
Allows you to change the password for a given user ID and current password with the External Security Manager.
changePassword(String) - Method in interface com.ibm.ctg.epi.TerminalSession
Allows you to change the password for a given userid and current password with the External Security Manager
Channel - Class in com.ibm.ctg.client
A Channel is a named collection of Container objects that can be passed to a CICS program.
Channel(String) - Constructor for class com.ibm.ctg.client.Channel
Creates a new empty Channel with the specified name.
channel - Variable in class com.ibm.ctg.client.ECIRequest
The Channel to be passed to the CICS program.
ChannelException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown when an error occurs while using a Channel.
ChannelException() - Constructor for exception com.ibm.ctg.client.exceptions.ChannelException
Creates a new exception with no message.
ChannelException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelException
Creates a new exception with the specified message.
ChannelException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelException
Creates a new exception with the specified cause.
ChannelException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelException
Creates a new exception with the specified message and cause.
ChannelNameException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown if an application attempts to create a Channel with a name that is not valid.
ChannelNameException() - Constructor for exception com.ibm.ctg.client.exceptions.ChannelNameException
Creates a new exception with no message.
ChannelNameException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelNameException
Creates a new exception with the specified message.
ChannelNameException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelNameException
Creates a new exception with the specified cause.
ChannelNameException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ChannelNameException
Creates a new exception with the specified message and cause.
CICS_EciListSystems - Static variable in class com.ibm.ctg.client.ECIRequest
List CICS servers.
Cics_Rc - Variable in class com.ibm.ctg.client.ECIRequest
CICS ECI return code.
Cics_Rc - Variable in class com.ibm.ctg.client.EPIRequest
CICS return code.
CicsClientStatus - Variable in class com.ibm.ctg.client.ECIRequest
After getStatus(), shows status of CICS client.
CICSConnection - Class in com.ibm.connector2.cics
This abstract class provides the general CICS connection class.
CICSConnectionFactory - Class in com.ibm.connector2.cics
This abstract class provides the framework for CICS connection factories.
CICSConnectionMetaData - Class in com.ibm.connector2.cics
This class contains the connection metadata as defined in the J2EE Connector specification.
CICSConnectionSpec - Class in com.ibm.connector2.cics
Framework class for the connection spec.
CICSConnectionSpec() - Constructor for class com.ibm.connector2.cics.CICSConnectionSpec
Default constructor.
CicsCpRequest - Class in com.ibm.ctg.client
This class contains the details of the codepage used by the Client daemon.
CicsCpRequest() - Constructor for class com.ibm.ctg.client.CicsCpRequest
Default constructor.
CICSInteraction - Class in com.ibm.connector2.cics
Framework abstract class for Interaction.
CICSInteractionSpec - Class in com.ibm.connector2.cics
This abstract class allows you to set the values for a general CICS request.
CICSInteractionSpec() - Constructor for class com.ibm.connector2.cics.CICSInteractionSpec
Constructs an CICSInteractionSpec object
CICSLogTraceLevels - Interface in com.ibm.connector2.cics
This interface contains the trace level enumerations.
CICSManagedConnectionFactory - Class in com.ibm.connector2.cics
Abstract class that provides the managed connection factory framework for CICS resource adapters.
CICSManagedConnectionFactory() - Constructor for class com.ibm.connector2.cics.CICSManagedConnectionFactory
Default constructor.
CICSRequestExit - Interface in com.ibm.ctg.ha
All implementations of CICS Transaction Gateway CICS request exit classes must implement the CICSRequestExit interface.
CICSResourceAdapterMetaData - Class in com.ibm.connector2.cics
This class provides information about the specific CICS resource adapter.
CicsServerStatus - Variable in class com.ibm.ctg.client.ECIRequest
After getStatus(), shows status of CICS server.
CICSTxnAbendException - Exception in com.ibm.connector2.cics
This exception represents invalid user input for the CICS resource adapters.
CICSUserInputException - Exception in com.ibm.connector2.cics
Deprecated. since CICS TG v6.0, replaced by InvalidPropertyException
clear - Static variable in class com.ibm.connector2.cics.AIDKey
'clear' key
clear() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Removes all entries from the Channel
clear - Static variable in class com.ibm.ctg.epi.AID
Clear key.
clearWarnings() - Method in class com.ibm.connector2.cics.CICSInteraction
Clears any warnings logged.
client - Static variable in interface com.ibm.ctg.epi.TerminalSession
Server expecting reply.
ClientSecurity - Interface in com.ibm.ctg.security
All implementations of CICS Transaction Gateway client-side security classes must implement the ClientSecurity interface.
clone() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Not supported
clone() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Creates a new object of the same class as this object.
clone() - Method in interface com.ibm.connector2.screen.ITextAttrInfo
Creates a new object of the same class as this object.
close() - Method in class com.ibm.connector2.cics.CICSConnection
Closes this connection if it is not already closed.
close() - Method in class com.ibm.connector2.cics.CICSInteraction
Close this connection.
close() - Method in class com.ibm.connector2.cics.ECIConnection
Closes the ECI connection, disabling it from further use.
close() - Method in class com.ibm.connector2.cics.ECIInteraction
Close the interaction and disable any further communication with CICS.
close() - Method in class com.ibm.connector2.cics.EPIConnection
This method closes a connection.
close() - Method in class com.ibm.connector2.cics.EPIInteraction
Close this connection.
close() - Method in class com.ibm.ctg.client.JavaGateway
Closes the connection to the CICS Transaction Gateway.
close() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Closes a connection to a Gateway daemon.
closeTimeout - Variable in class com.ibm.ctg.client.LocalJavaGateway
Time given for in-progress work to end when Gateway is closed
CODEPAGE_ERR - Static variable in class com.ibm.ctg.client.CicsCpRequest
The CICS Transaction Gateway detected an error.
CODEPAGE_NORMAL - Static variable in class com.ibm.ctg.client.CicsCpRequest
The request completed normally.
CODEPAGE_NOT_AVAILABLE - Static variable in class com.ibm.ctg.client.CicsCpRequest
A code page cannot be obtained.
col - Variable in class com.ibm.ctg.epi.FieldData
The column at which the field starts within the map.
col - Variable in class com.ibm.ctg.epi.MapData
The column at which the map starts.
color - Variable in class com.ibm.ctg.client.EPIRequest
1 = terminal resource supports color; else 0.
com.ibm.connector2.cics - package com.ibm.connector2.cics
Provides classes for developing J2EE ECI and EPI applications.
com.ibm.connector2.screen - package com.ibm.connector2.screen
Provides classes for developing J2EE applications that use the EPI screenable interface.
com.ibm.ctg.client - package com.ibm.ctg.client
Provides ECI, EPI and ESI base classes for developing Java client applications.
com.ibm.ctg.client.exceptions - package com.ibm.ctg.client.exceptions
Contains exceptions thrown by the Java client API classes.
com.ibm.ctg.client.stats - package com.ibm.ctg.client.stats
Provides classes for developing applications that obtain statistics information from one or more Gateway daemons.
com.ibm.ctg.epi - package com.ibm.ctg.epi
Provides EPI support classes for developing Java applications without requiring a detailed knowledge of 3270 data streams.
com.ibm.ctg.ha - package com.ibm.ctg.ha
Provides classes for developing CICS request exits that resolve CICS server names on ECI and XA requests.
com.ibm.ctg.monitoring - package com.ibm.ctg.monitoring
Provides classes for developing request monitoring exits.
com.ibm.ctg.security - package com.ibm.ctg.security
Provides classes for developing client and server security exits.
com.ibm.ctg.util - package com.ibm.ctg.util
Contains utility classes.
Commarea - Variable in class com.ibm.ctg.client.ECIRequest
COMMAREA to be passed to the CICS program.
Commarea_Length - Variable in class com.ibm.ctg.client.ECIRequest
Length of COMMAREA.
commit() - Method in class com.ibm.connector2.cics.CCILocalTransaction
Commits the current Local Transaction on the CICS Server.
connect() - Method in class com.ibm.ctg.epi.EPITerminal
Connects to the CICS server.
connect(int) - Method in class com.ibm.ctg.epi.EPITerminal
Connects to the CICS server.
connect(Session, int) - Method in class com.ibm.ctg.epi.Terminal
Connects an extended terminal to the CICS server.
connect(int) - Method in class com.ibm.ctg.epi.Terminal
Connects an extended terminal to the CICS server.
connect() - Method in class com.ibm.ctg.epi.Terminal
Connects a basic or extended terminal to the server.
connect(Session, int) - Method in interface com.ibm.ctg.epi.TerminalInterface
Connects an Extended terminal to the server, within a given timeout.
connect() - Method in interface com.ibm.ctg.epi.TerminalSession
Connects the terminal to the server.
connect(int) - Method in interface com.ibm.ctg.epi.TerminalSession
Connects an Extended terminal to the server, within a given timeout.
ConnectionType - Variable in class com.ibm.ctg.client.ECIRequest
After getStatus(), shows type of CICS system.
Container - Interface in com.ibm.ctg.client
A container is a uniquely named block of data that can be passed to a subsequent program or transaction.
Container.ContainerType - Enum in com.ibm.ctg.client
Defines the type of data in a Container and whether it is subject to code page conversion.
ContainerException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown when an error occurs while using a Container.
ContainerException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerException
Creates a new exception with no message.
ContainerException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerException
Creates a new exception with the specified message.
ContainerException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerException
Creates a new exception with the specified cause.
ContainerException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerException
Creates a new exception with the specified message and cause.
ContainerExistsException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown when an application attempts to create, add, copy or move a Container to a Channel which already holds a Container with the same name.
ContainerExistsException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerExistsException
Creates a new exception with no message.
ContainerExistsException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerExistsException
Creates a new exception with the specified message.
ContainerExistsException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerExistsException
Creates a new exception with the specified cause.
ContainerExistsException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerExistsException
Creates a new exception with the specified message and cause.
ContainerNameException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown if an application attempts to create a Container with a name that is not valid.
ContainerNameException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNameException
Creates a new exception with no message.
ContainerNameException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNameException
Creates a new exception with the specified message.
ContainerNameException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNameException
Creates a new exception with the specified cause.
ContainerNameException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNameException
Creates a new exception with the specified message and cause.
ContainerNotFoundException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown when an application attempts to access a Container which is not in the Channel.
ContainerNotFoundException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNotFoundException
Creates a new exception with no message.
ContainerNotFoundException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNotFoundException
Creates a new exception with the specified message.
ContainerNotFoundException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNotFoundException
Creates a new exception with the specified cause.
ContainerNotFoundException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerNotFoundException
Creates a new exception with the specified message and cause.
ContainerTypeException - Exception in com.ibm.ctg.client.exceptions
This exception is thrown when an application attempts to get the wrong type of data from a Container or put the wrong type of data into it.
ContainerTypeException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerTypeException
Creates a new exception with no message.
ContainerTypeException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerTypeException
Creates a new exception with the specified message.
ContainerTypeException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerTypeException
Creates a new exception with the specified cause.
ContainerTypeException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerTypeException
Creates a new exception with the specified message and cause.
containsKey(Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns whether or not the specified Container name exists in the Channel.
containsValue(Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns whether or not the Container value is within the Channel.
copyContainer(String, Channel) - Method in class com.ibm.ctg.client.Channel
Copy a container from another channel
copyContainer(String, Channel, String) - Method in class com.ibm.ctg.client.Channel
Copy a container from another channel
createConnectionFactory() - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
This method is the default route to creating ECIConnectionFactory objects.
createConnectionFactory(ConnectionManager) - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
This method allows a ConnectionManager to be specified as the one to be used by the returned ECIConnectionFactory.
createConnectionFactory() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
This will create an EPIConnectionFactory.
createConnectionFactory(ConnectionManager) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
This will create an EPIConnectionFactory.
createContainer(String, byte[]) - Method in class com.ibm.ctg.client.Channel
Creates a container to hold binary data within the channel.
createContainer(String, String, String) - Method in class com.ibm.ctg.client.Channel
Deprecated.  
createContainer(String, byte[], String) - Method in class com.ibm.ctg.client.Channel
Creates a container to hold character data within the channel.
createContainer(String, String) - Method in class com.ibm.ctg.client.Channel
Creates a container to hold character data within the channel.
createContainer(String, byte[], int) - Method in class com.ibm.ctg.client.Channel
Creates a container to hold character data within the channel.
createInteraction() - Method in class com.ibm.connector2.cics.ECIConnection
Get a new ECIInteraction object with which to flow requests to CICS.
createInteraction() - Method in class com.ibm.connector2.cics.EPIConnection
This method creates an interaction which you use to perform actions on this connection.
CTG_PROP_INTERCEPT_PLUGIN - Static variable in interface com.ibm.ctg.client.GatewayIntercept
The Java property that can be used to set the GatewayIntercept plug-in class to use.
cyan - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color cyan.
cyan - Static variable in class com.ibm.ctg.epi.Field
The color cyan.

D

dark - Static variable in class com.ibm.ctg.epi.Field
Dark.
darkblue - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color dark blue.
darkblue - Static variable in class com.ibm.ctg.epi.Field
The color dark blue.
data - Variable in class com.ibm.ctg.client.EPIRequest
CICS 3270 data stream in byte array
dataTag() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating whether or not the data in the field has been modified.
decodeReply(byte[]) - Method in interface com.ibm.ctg.security.ClientSecurity
This method is called to decode a reply from the CICS Transaction Gateway, which has been encoded by its partner ServerSecurity instance's encodeReply method.
decodeRequest(byte[]) - Method in interface com.ibm.ctg.security.JSSEServerSecurity
This method is called to decode a client request, which has been encoded by its partner ClientSecurity instance's encodeRequest method.
decodeRequest(byte[]) - Method in interface com.ibm.ctg.security.ServerSecurity
This method is called to decode a client request, which has been encoded by its partner ClientSecurity instance's encodeRequest method.
defaultColor - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Default colour.
defaultColor - Static variable in class com.ibm.ctg.epi.Field
Default colour.
defaultHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Default highlight.
defaultHlt - Static variable in class com.ibm.ctg.epi.Field
Default highlight.
defaultTran - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Default transparency.
defaultTran - Static variable in class com.ibm.ctg.epi.Field
Default transparency.
deleteContainer(String) - Method in class com.ibm.ctg.client.Channel
Deletes the container from the channel.
delTerminal() - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_DEL_TERMINAL.
delTerminal(int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_DEL_TERMINAL and also sets the termIndex associated with this object.
depth - Variable in class com.ibm.ctg.epi.MapData
The map depth in rows.
destroy() - Static method in class com.ibm.ctg.client.LocalJavaGateway
When the CICS Transaction Gateway is cleanly shutdown, it will run termination routines for all the different type of requests it has seen.
deviceType - Variable in class com.ibm.ctg.client.EPIRequest
CICS model terminal name - defined in CICS server environment.
discon - Static variable in interface com.ibm.ctg.epi.TerminalSession
Terminal disconnected.
disconnect() - Method in class com.ibm.ctg.epi.EPITerminal
Disconnects from the CICS server.
disconnect() - Method in class com.ibm.ctg.epi.Terminal
Disconnects the terminal from the server.
disconnect() - Method in interface com.ibm.ctg.epi.TerminalSession
Disconnects the terminal from the server.
DistributedIdentity - Class in com.ibm.ctg.monitoring
This class contains the distributed identity that is used to identify a user across multiple software components.
DistributedIdentity(IDID) - Constructor for class com.ibm.ctg.monitoring.DistributedIdentity
 
DLLVersionMismatchException - Exception in com.ibm.ctg.util
This exception is thrown when an application attempts to load a native library at a different version to the Gateway classes.
DLLVersionMismatchException(String, String) - Constructor for exception com.ibm.ctg.util.DLLVersionMismatchException
Creates a new exception with the specified Gateway classes version and the specified native library version.
DUPLICATE_STATGROUPID - Static variable in class com.ibm.ctg.client.stats.ResponseData
The statistic group ID specified on the query was a duplicate of another ID on the query.
DUPLICATE_STATID - Static variable in class com.ibm.ctg.client.stats.ResponseData
The statistic ID specified on the query was a duplicate of another ID on the query.

E

ECI_ASYNC - Static variable in class com.ibm.ctg.client.ECIRequest
Asynchronous call.
ECI_ASYNC_TPN - Static variable in class com.ibm.ctg.client.ECIRequest
Asynchronous call with eci_tpn.
ECI_BACKOUT - Static variable in class com.ibm.ctg.client.ECIRequest
End LUW and backout changes.
ECI_CANCEL - Static variable in class com.ibm.ctg.client.ECIRequest
Deprecated. End LUW and commit changes, exactly the same as ECI_COMMIT.
ECI_CLIENTSTATE_INAPPLICABLE - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_CLIENTSTATE_UNKNOWN - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_CLIENTSTATE_UP - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_COMMIT - Static variable in class com.ibm.ctg.client.ECIRequest
End LUW and commit changes.
ECI_CONNECTED_NOWHERE - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_CONNECTED_TO_CLIENT - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_CONNECTED_TO_SERVER - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_ERR_ALREADY_ACTIVE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
An attempt was made to continue an existing logical unit of work, but there was an outstanding asynchronous call for the same logical unit of work.
ECI_ERR_CALL_FROM_CALLBACK - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
On the CICS client, the call was made from a callback routine.
ECI_ERR_CICS_DIED - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The specified server is no longer available.
ECI_ERR_EXEC_NOT_RESIDENT - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Deprecated.  
ECI_ERR_INVALID_CALL_TYPE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The call type was not valid.
ECI_ERR_INVALID_DATA_AREA - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Data area is not valid.
ECI_ERR_INVALID_DATA_LENGTH - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Invalid data length.
ECI_ERR_INVALID_EXTEND_MODE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The extend mode field is invalid.
ECI_ERR_INVALID_VERSION - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Version is not valid.
ECI_ERR_LUW_TOKEN - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The value in Luw_Token is incorrect.
ECI_ERR_MAX_SESSIONS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not enough communication resources to satisfy request.
ECI_ERR_MAX_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Reached limit on maximum number of systems.
ECI_ERR_MORE_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Insufficient space for server list.
ECI_ERR_MSG_QUAL_IN_USE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The supplied message qualifier is already in use and cannot be used at this time.
ECI_ERR_NO_CICS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
No CICS system available.
ECI_ERR_NO_MSG_QUALS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
An attempt to auto generate a message qualifier failed.
ECI_ERR_NO_REPLY - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
No reply received.
ECI_ERR_NO_SESSIONS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not enough communication resources to satisfy request.
ECI_ERR_NO_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
No CICS servers could be located.
ECI_ERR_NULL_MESSAGE_ID - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not returned by the CICS Transaction Gateway Java API.
ECI_ERR_NULL_SEM_HANDLE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not returned by the CICS Transaction Gateway Java API.
ECI_ERR_NULL_WIN_HANDLE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not returned by the CICS Transaction Gateway Java API.
ECI_ERR_REQUEST_TIMEOUT - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The value supplied for timeout is negative.
ECI_ERR_RESOURCE_SHORTAGE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Not enough resource to complete the request.
ECI_ERR_RESPONSE_TIMEOUT - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The ECI call timed out.
ECI_ERR_ROLLEDBACK - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
An attempt was made to commit a logical unit of work, but the server was unable to commit the changes, and backed them out instead.
ECI_ERR_SECURITY_ERROR - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
An invalid combination of user ID and password was specified.
ECI_ERR_SYSTEM_ERROR - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
An internal system error occurred.
ECI_ERR_THREAD_CREATE_ERROR - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
Error creating thread.
ECI_ERR_TRANSACTION_ABEND - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The CICS transaction abended.
ECI_ERR_UNKNOWN_SERVER - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The requested server could not be located.
ECI_ERR_XID_INVALID - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
No transaction exists with the specified XID
ECI_EXTENDED - Static variable in class com.ibm.ctg.client.ECIRequest
This request is part of an Extended Logical Unit of Work.
ECI_GET_SPECIFIC_REPLY - Static variable in class com.ibm.ctg.client.ECIRequest
Get a specific asynchronous reply.
ECI_GET_SPECIFIC_REPLY_WAIT - Static variable in class com.ibm.ctg.client.ECIRequest
Await a specific asynchronous reply.
ECI_LUW_NEW - Static variable in class com.ibm.ctg.client.ECIRequest
New LUW.
ECI_NO_ERROR - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
The function completed normally.
ECI_NO_EXTEND - Static variable in class com.ibm.ctg.client.ECIRequest
Non-extended LUW call, or the last call in a LUW.
ECI_SERVERSTATE_DOWN - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_SERVERSTATE_UNKNOWN - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_SERVERSTATE_UP - Static variable in class com.ibm.ctg.client.ECIRequest
Return value from a getStatus() call.
ECI_STATE_ASYNC - Static variable in class com.ibm.ctg.client.ECIRequest
Asynchronous request for status.
ECI_STATE_ASYNC_JAVA - Static variable in class com.ibm.ctg.client.ECIRequest
Asynchronous request for status information as Java values, i.e.
ECI_STATE_CANCEL - Static variable in class com.ibm.ctg.client.ECIRequest
Cancel an ECI_STATE_CHANGED request.
ECI_STATE_CHANGED - Static variable in class com.ibm.ctg.client.ECIRequest
If status changes then send reply.
ECI_STATE_IMMEDIATE - Static variable in class com.ibm.ctg.client.ECIRequest
Return state information immediately.
ECI_STATE_SYNC - Static variable in class com.ibm.ctg.client.ECIRequest
Synchronous request for status information.
ECI_STATE_SYNC_JAVA - Static variable in class com.ibm.ctg.client.ECIRequest
Synchronous request for status information as Java values, i.e.
ECI_STATUS_LENGTH - Static variable in class com.ibm.ctg.client.ECIRequest
Length of COMMAREA needed for status information.
ECI_SYNC - Static variable in class com.ibm.ctg.client.ECIRequest
Synchronous call.
ECI_SYNC_TPN - Static variable in class com.ibm.ctg.client.ECIRequest
Synchronous call with eci_tpn.
ECIChannelRecord - Class in com.ibm.connector2.cics
ECIChannelRecord is part of the API for Channels and Containers support for the CICS ECI Resource Adapters.
ECIChannelRecord(String) - Constructor for class com.ibm.connector2.cics.ECIChannelRecord
Creates the Channel Record.
ECIConnection - Class in com.ibm.connector2.cics
The ECIConnection class represents an applications handle to an underlying ECIManagedConnection.
ECIConnectionFactory - Class in com.ibm.connector2.cics
The ECIConnectionFactory allows a client component to request a connection to CICS.
ECIConnectionFactory() - Constructor for class com.ibm.connector2.cics.ECIConnectionFactory
Default constructor.
ECIConnectionFactory(ConnectionManager, ECIManagedConnectionFactory) - Constructor for class com.ibm.connector2.cics.ECIConnectionFactory
Constructor.
ECIConnectionSpec - Class in com.ibm.connector2.cics
When a client component wants an ECIConnection with specific properties to be returned by an ECIConnectionFactory.getConnection() call then an ECIConnectionSpec is used to wrapp these properties.
ECIConnectionSpec() - Constructor for class com.ibm.connector2.cics.ECIConnectionSpec
Default constructor.
ECIConnectionSpec(String, String) - Constructor for class com.ibm.connector2.cics.ECIConnectionSpec
Constructor that builds an ECIConnectionSpec using the given user credentials.
ECIInteraction - Class in com.ibm.connector2.cics
The ECI implementation of the javax.resource.cci.Interaction interface.
ECIInteractionSpec - Class in com.ibm.connector2.cics
An ECIInteractionSpec is used to define the details of an interaction with CICS.
ECIInteractionSpec(int, String, int, int, int) - Constructor for class com.ibm.connector2.cics.ECIInteractionSpec
Complete constructor allows specification of all properties.
ECIInteractionSpec(int, String) - Constructor for class com.ibm.connector2.cics.ECIInteractionSpec
Simple constructor.
ECIInteractionSpec() - Constructor for class com.ibm.connector2.cics.ECIInteractionSpec
Default constructor.
ECIManagedConnectionFactory - Class in com.ibm.connector2.cics
An ECIManagedConnectionFactory is used to create physical ECI connections to the CICS Transaction Gateway.
ECIManagedConnectionFactory() - Constructor for class com.ibm.connector2.cics.ECIManagedConnectionFactory
 
ECIRequest - Class in com.ibm.ctg.client
This class contains the details of an ECI request to the CICS Transaction Gateway.
ECIRequest() - Constructor for class com.ibm.ctg.client.ECIRequest
Default constructor, which leaves all the values set to their defaults.
ECIRequest(String, String, String, String, byte[], int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
Beta style constructor, which takes the relevant parameters for a simple synchronous call, and sets the contents of the object.
ECIRequest(int, String, String, String, String, String, byte[]) - Constructor for class com.ibm.ctg.client.ECIRequest
Basic constructor.
ECIRequest(int, String, String, String, String, String, byte[], int, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
Extended constructor.
ECIRequest(int, String, String, String, String, String, byte[], int, int, int, int, Callbackable) - Constructor for class com.ibm.ctg.client.ECIRequest
Extended constructor.
ECIRequest(int, String, String, String, String, String, Channel, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
Extended constructor.
ECIRequest(int, String, String, String, String, String, Channel, int, int, int, Callbackable) - Constructor for class com.ibm.ctg.client.ECIRequest
Extended constructor.
ECIRequest(String, String, String, String, Channel, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
Beta style constructor, which takes the relevant parameters for a simple synchronous call, and sets the contents of the object.
ECIResourceAdapterRc - Class in com.ibm.connector2.cics
This class contains all the return code enumerations from all the exceptions that could be thrown within the ECI Resource Adapter.
ECIReturnCodes - Interface in com.ibm.ctg.client
Gateway ECI Return codes.
encodeReply(byte[], GatewayRequest) - Method in interface com.ibm.ctg.security.JSSEServerSecurity
This method is called to encode a reply to the client program.
encodeReply(byte[], GatewayRequest) - Method in interface com.ibm.ctg.security.ServerSecurity
This method is called to encode a reply to the client program.
encodeRequest(byte[], GatewayRequest) - Method in interface com.ibm.ctg.security.ClientSecurity
This method is called to encode a request to the CICS Transaction Gateway.
endBuild() - Method in interface com.ibm.connector2.screen.IScreenable
Indicate the end of the field build process.
endReason - Variable in class com.ibm.ctg.client.EPIRequest
Reason why the terminal resource was deleted.
endReturnCode - Variable in class com.ibm.ctg.client.EPIRequest
The return code for END_TRAN and ADD_TERM events.
enter - Static variable in class com.ibm.connector2.cics.AIDKey
'enter' key
enter - Static variable in class com.ibm.ctg.epi.AID
Enter key.
EPI3270Exception - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPI_ABEND_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of CICS abend code.
EPI_ADD_ASYNC - Static variable in class com.ibm.ctg.client.EPIRequest
Add terminal asynchronously.
EPI_ADD_EX_TERMINAL - Static variable in class com.ibm.ctg.client.EPIRequest
Install an extended terminal resource.
EPI_ADD_SYNC - Static variable in class com.ibm.ctg.client.EPIRequest
Add terminal synchronously.
EPI_ADD_TERMINAL - Static variable in class com.ibm.ctg.client.EPIRequest
Install a terminal resource.
EPI_ATI_HOLD - Static variable in class com.ibm.ctg.client.EPIRequest
Hold ATI requests and return the previous ATI state.
EPI_ATI_ON - Static variable in class com.ibm.ctg.client.EPIRequest
Allow ATI requests and return the previous ATI state.
EPI_ATI_QUERY - Static variable in class com.ibm.ctg.client.EPIRequest
Return the current ATI state.
EPI_ATI_STATE - Static variable in class com.ibm.ctg.client.EPIRequest
Change or get the ATI state of a terminal resource.
EPI_COLOR - Static variable in class com.ibm.ctg.client.EPIRequest
Terminal resource supports color.
EPI_DEL_TERMINAL - Static variable in class com.ibm.ctg.client.EPIRequest
Delete a terminal resource.
EPI_DESCRIPTION_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of CICS server description.
EPI_DEVTYPE_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of model terminal definition.
EPI_END_FAILED - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
An attempt to delete the terminal resource failed.
EPI_END_OUTSERVICE - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
The terminal resource has been switched out of service.
EPI_END_SHUTDOWN - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
The CICS Server is shutting down.
EPI_END_SIGNOFF - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Terminal was signed off.
EPI_END_UNKNOWN - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
An unexpected error occurred.
EPI_ERR_ABENDED - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
A read timeout occurred for the current transaction.
EPI_ERR_ADDTYPE_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The Terminal Add Type was invalid (in CICS client).
EPI_ERR_ALREADY_INSTALLED - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The terminal ID is already installed.
EPI_ERR_ATI_ACTIVE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
An ATI transaction is already active.
EPI_ERR_ATI_STATE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Invalid atiState provided.
EPI_ERR_BAD_INDEX - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Invalid termIndex.
EPI_ERR_CCSID_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The CCSid supplied was invalid.
EPI_ERR_FAILED - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The function failed for an unexpected reason.
EPI_ERR_IN_CALLBACK - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
On the CICS client, the call was made from a callback routine.
EPI_ERR_IS_INIT - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The EPI is already initialized.
EPI_ERR_MAX_SESSIONS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Not enough communication resources to satisfy request.
EPI_ERR_MAX_SYSTEMS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Reached limit on maximum number of systems.
EPI_ERR_MAX_TERMS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Maximum number of terminals reached.
EPI_ERR_MODELID_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The model ID was invalid.
EPI_ERR_MORE_DATA - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
getEvent supplied data array too small, data has been truncated.
EPI_ERR_MORE_EVENTS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
There are more events outstanding.
EPI_ERR_MORE_SYSTEMS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Insufficient space for server list.
EPI_ERR_NO_CICS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
No CICS system available.
EPI_ERR_NO_CONVERSE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
No reply expected by the terminal resource.
EPI_ERR_NO_DATA - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
No reply data was provided.
EPI_ERR_NO_EVENT - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
There are no events outstanding.
EPI_ERR_NO_SYSTEMS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
No CICS servers can be located.
EPI_ERR_NOT_3270_DEVICE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Not a 3270 device.
EPI_ERR_NOT_INIT - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The EPI environment has not been initialized.
EPI_ERR_NULL_PARM - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
termIndex was null (in CICS client).
EPI_ERR_NULL_PASSWORD - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The password supplied was an empty string or NULL.
EPI_ERR_NULL_USERID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The user ID supplied was an empty string or NULL.
EPI_ERR_PASSWORD_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Not returned by the CICS Transaction Gateway Java API.
EPI_ERR_RESOURCE_SHORTAGE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Resource shortage, e.g.
EPI_ERR_RESPONSE_TIMEOUT - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The terminal did not install within the given timeout.
EPI_ERR_SECURITY - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
A server security error occurred, such as an incorrect user ID or password.
EPI_ERR_SENSE_CODE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
An invalid sense code was provided.
EPI_ERR_SERVER_BUSY - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The CICS server was too busy to handle the request.
EPI_ERR_SERVER_DOWN - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The CICS server is not available.
EPI_ERR_SIGNON_NOT_POSS - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
A request for a signon capable terminal was not possible.
EPI_ERR_SIGNONCAP_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The Terminal Signon Capability flag was invalid (in CICS client).
EPI_ERR_SYSTEM - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The specified server is not known.
EPI_ERR_TERMID_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The requested terminal ID was invalid.
EPI_ERR_TRAN_ACTIVE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
There is a transaction running against the terminal resource, or there are unprocessed events.
EPI_ERR_TTI_ACTIVE - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
An EPI transaction is already active.
EPI_ERR_USERID_INVALID - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Not returned by the CICS Transaction Gateway Java API.
EPI_ERR_VERSION - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The CICS EPI cannot support the EPI version requested.
EPI_ERR_WAIT - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
Invalid waitState.
EPI_ERRINTENSIFY - Static variable in class com.ibm.ctg.client.EPIRequest
Terminal displays error messages intensified.
EPI_ERRLASTLINE - Static variable in class com.ibm.ctg.client.EPIRequest
Terminal displays error messages on last row.
EPI_ERROR_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of error text.
EPI_EVENT_ADD_TERM - Static variable in class com.ibm.ctg.client.EPIRequest
An Add Terminal event has been received.
EPI_EVENT_CONVERSE - Static variable in class com.ibm.ctg.client.EPIRequest
A transaction is expecting an EPI_REPLY.
EPI_EVENT_END_TERM - Static variable in class com.ibm.ctg.client.EPIRequest
This terminal resource no longer exists - check endReason value.
EPI_EVENT_END_TRAN - Static variable in class com.ibm.ctg.client.EPIRequest
A transaction has ended.
EPI_EVENT_SEND - Static variable in class com.ibm.ctg.client.EPIRequest
A transaction has sent 3270 data to a terminal resource (no reply is expected).
EPI_EVENT_START_ATI - Static variable in class com.ibm.ctg.client.EPIRequest
An ATI transaction has been started against the terminal.
EPI_GET_EVENT - Static variable in class com.ibm.ctg.client.EPIRequest
Get event information.
EPI_HILIGHT - Static variable in class com.ibm.ctg.client.EPIRequest
Terminal resource supports extended highlighting.
EPI_INITIALIZE - Static variable in class com.ibm.ctg.client.EPIRequest
Initialize the EPI.
EPI_INQUIRE_SYSTEM - Static variable in class com.ibm.ctg.client.EPIRequest
Inquire as to server on which terminal exists.
EPI_LIST_SYSTEMS - Static variable in class com.ibm.ctg.client.EPIRequest
List of CICS servers.
EPI_MAPNAME_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of map name.
EPI_MAPSETNAME_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of map set name.
EPI_MIN_TERMINDEX - Static variable in class com.ibm.ctg.client.EPIRequest
Minimum termIndex value.
EPI_NETNAME_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of terminal's netName.
EPI_NOEVENT - Static variable in class com.ibm.ctg.client.EPIRequest
No events returned for this terminal resource.
EPI_NORMAL - Static variable in interface com.ibm.ctg.client.EPIReturnCodes
The function completed normally.
EPI_NOWAIT - Static variable in class com.ibm.ctg.client.EPIRequest
Return immediately (with Cics_Rc).
EPI_PASSWORD_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of password.
EPI_PURGE_TERMINAL - Static variable in class com.ibm.ctg.client.EPIRequest
Purge a terminal resource.
EPI_READTIMEOUT_EXPIRED - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Conversional transaction timed out.
EPI_REPLY - Static variable in class com.ibm.ctg.client.EPIRequest
Send a reply (used after an EPI_EVENT_CONVERSE has been received).
EPI_SET_SECURITY - Static variable in class com.ibm.ctg.client.EPIRequest
Change the security for an installed terminal.
EPI_SIGNON_CAPABLE - Static variable in class com.ibm.ctg.client.EPIRequest
Signon capable terminal.
EPI_SIGNON_CAPABLE - Static variable in class com.ibm.ctg.epi.Terminal
Signon Capable enumeration.
EPI_SIGNON_INCAPABLE - Static variable in class com.ibm.ctg.client.EPIRequest
Signon incapable terminal.
EPI_SIGNON_INCAPABLE - Static variable in class com.ibm.ctg.epi.Terminal
Signon Incapable enumeration.
EPI_SIGNON_UNKNOWN - Static variable in class com.ibm.ctg.client.EPIRequest
Signon capability unknown.
EPI_SIGNON_UNKNOWN - Static variable in class com.ibm.ctg.epi.Terminal
Signon Unknown enumeration, do not use to try to create a terminal.
EPI_START_TRAN - Static variable in class com.ibm.ctg.client.EPIRequest
Start a transaction.
EPI_SYSTEM_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of CICS server name.
EPI_TERM_INDEX_NONE - Static variable in class com.ibm.ctg.client.EPIRequest
termIndex not specified.
EPI_TERMID_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of terminal ID.
EPI_TRAN_NO_ERROR - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Transaction ended without error.
EPI_TRAN_NOT_STARTED - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Transaction failed to start.
EPI_TRAN_STATE_UNKNOWN - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
Transaction failed to complete.
EPI_TRANSID_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of CICS server transaction ID.
EPI_USERID_MAX - Static variable in class com.ibm.ctg.client.EPIRequest
Maximum length of user ID.
EPI_WAIT - Static variable in class com.ibm.ctg.client.EPIRequest
Wait for the next terminal event to occur.
EPIConnection - Class in com.ibm.connector2.cics
EPIConnection represents the application level connection to a CICS Terminal.
EPIConnectionFactory - Class in com.ibm.connector2.cics
Use an instance of this class to request EPI Connections.
EPIConnectionFactory() - Constructor for class com.ibm.connector2.cics.EPIConnectionFactory
Default constructor.
EPIConnectionSpec - Class in com.ibm.connector2.cics
The EPI connection spec allows you to specify extra or different properties on the connection you require.
EPIConnectionSpec() - Constructor for class com.ibm.connector2.cics.EPIConnectionSpec
Default constructor.
EPIEndReasonCodes - Interface in com.ibm.ctg.client
Constant values representing EPI transaction end and terminal disconnect return codes.
EPIException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIException(String) - Constructor for exception com.ibm.ctg.epi.EPIException
Constructs an EPIException with a message.
EPIFieldException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIFieldRecord - Interface in com.ibm.connector2.cics
This interface provides access to information about a specific field retrieved from the EPI screen record.
EPIGateway - Class in com.ibm.ctg.epi
This class extends JavaGateway to provide some EPI specific behaviour.
EPIGateway() - Constructor for class com.ibm.ctg.epi.EPIGateway
Constructs an EPIGateway.
EPIGateway(String, int) - Constructor for class com.ibm.ctg.epi.EPIGateway
Constructs an EPIGateway to a CICS Transaction Gateway at the specified address and port and opens the gateway.
EPIGatewayException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIInteraction - Class in com.ibm.connector2.cics
An EPIInteraction is used to interact with the terminal requested from the connection factory.
EPIInteractionSpec - Class in com.ibm.connector2.cics
This class allows you to set the values for a CICS EPI request.
EPIInteractionSpec() - Constructor for class com.ibm.connector2.cics.EPIInteractionSpec
Constructs an EPIInteractionSpec Object
EPIManagedConnectionFactory - Class in com.ibm.connector2.cics
An EPIManagedConnectionFactory is used to create physical EPI connections to the CICS Transaction Gateway.
EPIManagedConnectionFactory() - Constructor for class com.ibm.connector2.cics.EPIManagedConnectionFactory
Default constructor.
EPIMapException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIMapException(String) - Constructor for exception com.ibm.ctg.epi.EPIMapException
Constructs an EPIMapException with a single message.
EPIRequest - Class in com.ibm.ctg.client
This class contains the details of an EPI request to the CICS Transaction Gateway.
EPIRequest() - Constructor for class com.ibm.ctg.client.EPIRequest
Creates an EPIRequest object with default values.
EPIRequest(int) - Constructor for class com.ibm.ctg.client.EPIRequest
Call_Type constructor.
EPIRequest(int, int) - Constructor for class com.ibm.ctg.client.EPIRequest
Call_Type and termIndex constructor.
EPIRequestException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIResourceAdapterRc - Class in com.ibm.connector2.cics
This class contains all the return code enumerations from all the exceptions that could be thrown within the EPI Resource Adapter.
EPIReturnCodes - Interface in com.ibm.ctg.client
Constant values representing EPI return codes.
EPIScreenException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
EPIScreenRecord - Interface in com.ibm.connector2.cics
This interface represents a screen, and provides methods for querying information about the screen and for retrieving fields from the screen.
EPISecurityAttrs - Class in com.ibm.ctg.epi
Contains information about the security credentials currently being used by the Terminal object.
EPISecurityException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs
EPITerminal - Class in com.ibm.ctg.epi
A Java bean that represents a connection to a CICS 3270 terminal.
EPITerminal() - Constructor for class com.ibm.ctg.epi.EPITerminal
Constructs an EPITerminal with a default URL of the current host and port 2006.
EPITranFailedException - Exception in com.ibm.connector2.cics
This exception can be thrown by the EPI classes when an error occurs.
EPITxnFailedException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
equals(Object) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Returns a flag indicating whether the objects are identical or not.
equals(Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
 
equals(Object) - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
This method returns true if two ECIManagedConnectionFactory objects are equal.
equals(Object) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Returns true if all the configurable properties are equal.
equals(Object) - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
This method determines if the two FieldAttrInfo types are equivalent.
equals(Object) - Method in interface com.ibm.connector2.screen.ITextAttrInfo
This method determines if the two TextAttrInfo types are equivalent.
equals(Object) - Method in class com.ibm.ctg.epi.AID
Returns true if the argument is not null and is an AID with the same value as this object.
equals(Object) - Method in class com.ibm.ctg.epi.FieldData
Returns true if the argument is a FieldData object equivalent to this one.
equals(Object) - Method in class com.ibm.ctg.epi.Map
Returns true if the given object is a Map equivalent to this one.
equals(Object) - Method in class com.ibm.ctg.epi.MapData
Returns true if the argument is a MapData object equivalent to this one.
equals(Object) - Method in class com.ibm.ctg.epi.Terminal.EPISignOnType
Compares this EPISignOnType to the specified object to determine if they are equal.
errColor - Variable in class com.ibm.ctg.client.EPIRequest
3270 color attribute used for error messages.
errHilight - Variable in class com.ibm.ctg.client.EPIRequest
3270 highlight attribute used for error messages.
errIntensify - Variable in class com.ibm.ctg.client.EPIRequest
1 = error messages displayed intensified, else 0.
errLastLine - Variable in class com.ibm.ctg.client.EPIRequest
1 = error messages displayed on last row; else 0.
error - Static variable in interface com.ibm.ctg.epi.TerminalSession
An error has occurred.
ERROR_BASE - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
Base error number.
ERROR_CONNECTION_FAILED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The connection to the CICS Transaction Gateway failed.
ERROR_EXIT_RETRY_INVALID - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The server selected by the CICSRequestExit uses a different CICS communication protocol to that of the last attempted server.
ERROR_GATEWAY_BACK_LEVEL - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The Gateway this Java Client connected to is at an earlier release.
ERROR_GATEWAY_CLOSED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The CICS Transaction Gateway has closed.
ERROR_GATEWAY_EXCEPTION - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
An exception occurred in the Gateway - used to tell callbacks what happened.
ERROR_INVALID_REQUEST_TYPE - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The request type is invalid for the protocol handler which recevied it.
ERROR_NOT_AUTHORIZED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
Flow of request was rejected, client is not authorized to flow requests.
ERROR_NOT_SUPPORTED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The request type was not supported by the CICS Transaction Gateway.
ERROR_REPLY_MISMATCH - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The reply from the CICS Transaction Gateway did not match the original request type.
ERROR_UNKNOWN_REQUEST_TYPE - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The request type was not recognised by the CICS Transaction Gateway.
ERROR_WORK_WAS_REFUSED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The CICS Transaction Gateway refused the request.
ERROR_XA_SUPPORT_NOT_ENABLED - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
The platform supports the type of request, but was not configured to allow this type of request.
ESI_CHANGE_PASSWORD - Static variable in class com.ibm.ctg.client.ESIRequest
Call type for change password request.
ESI_ERR_CALL_FROM_CALLBACK - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
On the CICS client, the call was made from a callback routine.
ESI_ERR_CICS_DIED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The specified server is no longer available.
ESI_ERR_MAX_SESSIONS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
Not enough communication resources to satisfy request.
ESI_ERR_MAX_SYSTEMS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
Reached limit on maximum number of systems.
ESI_ERR_NO_CICS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
No CICS system available.
ESI_ERR_NO_SESSIONS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
No sessions.
ESI_ERR_NULL_NEW_PASSWORD - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The new password supplied was an empty string or NULL.
ESI_ERR_NULL_OLD_PASSWORD - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The old password supplied was an empty string or NULL.
ESI_ERR_NULL_PASSWORD - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The password supplied was an empty string or NULL.
ESI_ERR_NULL_USERID - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The user ID supplied was an empty string or NULL.
ESI_ERR_PASSWORD_EXPIRED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The password has expired.
ESI_ERR_PASSWORD_INVALID - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The password is invalid.
ESI_ERR_PASSWORD_REJECTED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The new password does not conform to the standards defined by the external security manager.
ESI_ERR_PEM_NOT_ACTIVE - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The requested server does not support password expiry management.
ESI_ERR_PEM_NOT_SUPPORTED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
Password Expiry Management is only supported over SNA and only on specific servers.
ESI_ERR_RESOURCE_SHORTAGE - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
Not enough resources to complete the request.
ESI_ERR_SECURITY_ERROR - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
An error was detected by the external Security Manager.
ESI_ERR_SYSTEM_ERROR - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
An internal system error occurred.
ESI_ERR_UNKNOWN_SERVER - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The requested server could not be located.
ESI_ERR_USERID_INVALID - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The user ID is not known to the external security manager.
ESI_NO_ERROR - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
The function completed normally.
ESI_PASSWORD_MAX - Static variable in class com.ibm.ctg.client.ESIRequest
Maximum number of characters for password.
ESI_SYSTEM_MAX - Static variable in class com.ibm.ctg.client.ESIRequest
Maximum number of characters for server.
ESI_USERID_MAX - Static variable in class com.ibm.ctg.client.ESIRequest
Maximum number of characters for user ID.
ESI_VERIFY_PASSWORD - Static variable in class com.ibm.ctg.client.ESIRequest
Call type for verify password request.
ESIRequest - Class in com.ibm.ctg.client
This class contains the details of an ESI request to the CICS Transaction Gateway.
ESIRequest() - Constructor for class com.ibm.ctg.client.ESIRequest
Default constructor, this leaves all the values set to their defaults.
ESIReturnCodes - Interface in com.ibm.ctg.client
Constant values representing ESI return codes.
event - Variable in class com.ibm.ctg.client.EPIRequest
Type of event that has completed.
eventFired(ExitEvent, Map<ExitEventData, Object>) - Method in interface com.ibm.ctg.ha.CICSRequestExit
This method will be called for each defined ExitEvent.
eventFired(RequestEvent, Map<RequestData, Object>) - Method in interface com.ibm.ctg.monitoring.RequestExit
This method will be called for each defined MonitorEvent.
exceptionOccurred(TerminalEvent) - Method in class com.ibm.ctg.epi.ScreenHandler
Handles a terminal exception.
exceptionOccurred(TerminalEvent) - Method in interface com.ibm.ctg.epi.TerminalEventListener
An exception has occurred.
execute(InteractionSpec, Record) - Method in class com.ibm.connector2.cics.CICSInteraction
This form of execute is not supported by the CICS resource adapters
execute(InteractionSpec, Record, Record) - Method in class com.ibm.connector2.cics.ECIInteraction
In order to interact with CICS this method must be used to pass the definition of the call in an ECIInteractionSpec and the input and output records that will carry the data used in the interaction.
execute(InteractionSpec, Record, Record) - Method in class com.ibm.connector2.cics.EPIInteraction
This method will send the input record via a CICS terminal and return the new screen returned in the output record.
EXIT_SCREEN_REQUEST - Static variable in class com.ibm.ctg.epi.TerminalEvent
The terminal requests the screen handler to exit this screen.
ExitEvent - Enum in com.ibm.ctg.ha
This enumeration defines the event that triggers the eventFired() method of the CICSRequestExit.
ExitEventData - Enum in com.ibm.ctg.ha
This enumeration defines the data passed to the eventFired() method.
exitScreen() - Method in class com.ibm.ctg.epi.ScreenHandler
Exit the screen.
Extend_Mode - Variable in class com.ibm.ctg.client.ECIRequest
Extend mode of request.

F

failed - Static variable in interface com.ibm.ctg.epi.TerminalSession
Transaction failed to start/complete or timed out.
Field - Class in com.ibm.ctg.epi
This class represents a field in a 3270 screen and provides methods to query and set the contents and attributes of the field.
field(int) - Method in class com.ibm.ctg.epi.Map
Returns the field at the given index within this map.
field(int, int) - Method in class com.ibm.ctg.epi.Map
Returns the field at the given row and column within this map.
field(int) - Method in class com.ibm.ctg.epi.Screen
Gets a field by index.
field(int, int) - Method in class com.ibm.ctg.epi.Screen
Gets a field by screen position.
fieldCount() - Method in class com.ibm.ctg.epi.Screen
Gets the number of fields.
FieldData - Class in com.ibm.ctg.epi
This class contains information about a field in a BMS map.
FieldData(int, int, int) - Constructor for class com.ibm.ctg.epi.FieldData
Constructs a FieldData object with the given information.
FieldData(String, int, int, int) - Constructor for class com.ibm.ctg.epi.FieldData
Constructs a FieldData object with the given information.
FieldNotFoundException - Exception in com.ibm.connector2.screen
This exception is thrown to indicate that a failure occurs when trying to find the field.
FieldNotFoundException() - Constructor for exception com.ibm.connector2.screen.FieldNotFoundException
Constructs a FieldNotFoundException with no detail message.
FieldNotFoundException(String) - Constructor for exception com.ibm.connector2.screen.FieldNotFoundException
Constructs a FieldNotFoundException with the specified detail message.
FieldProtectedException - Exception in com.ibm.connector2.screen
This exception is thrown when an attempt is made to modify a field which is protected.
FieldProtectedException() - Constructor for exception com.ibm.connector2.screen.FieldProtectedException
Constructs a FieldProtectedException with no detail message.
FieldProtectedException(String) - Constructor for exception com.ibm.connector2.screen.FieldProtectedException
Constructs a FieldProtectedException with the specified detail message.
fields - Variable in class com.ibm.ctg.epi.MapData
The number of fields in the map.
fields() - Method in class com.ibm.ctg.epi.Screen
Returns an Enumeration of the fields in the screen.
FieldTextOverflowException - Exception in com.ibm.connector2.screen
This exception is thrown when the text being appended or set in a field would cause the text of the field to exceed its maximum length.
FieldTextOverflowException() - Constructor for exception com.ibm.connector2.screen.FieldTextOverflowException
Constructs a FieldTextOverflowException with no detail message.
FieldTextOverflowException(String) - Constructor for exception com.ibm.connector2.screen.FieldTextOverflowException
Constructs a FieldTextOverflowException with the specified detail message.
finalize() - Method in class com.ibm.connector2.cics.ECIInteraction
Clean up any outstanding Async replies if necessary.
fireEvent() - Method in class com.ibm.ctg.epi.ScreenHandler
Send appropriate event to all listeners.
firePropertyChange(String, Object, Object) - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Fires a PropertyChangeEvent to any listeners.
firePropertyChange(String, Object, Object) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Fires a PropertyChangeEvent to any listeners.
flow(GatewayRequest) - Method in class com.ibm.ctg.client.JavaGateway
Flows the specified GatewayRequest to the CICS Transaction Gateway and then waits for the reply.
FlowTopology - Enum in com.ibm.ctg.monitoring
FlowTopology enumerates the parts of the topologies over which a flow may pass.
FlowType - Enum in com.ibm.ctg.monitoring
Flows on requests are of different types.
foregroundColor() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating the foreground color of the field.

G

GatewayConnection - Class in com.ibm.ctg.client.stats
The GatewayConnection is used to retrieve statistical information from a CICS Transaction Gateway instance.
GatewayConnection() - Constructor for class com.ibm.ctg.client.stats.GatewayConnection
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway on the default statistics port.
GatewayConnection(int) - Constructor for class com.ibm.ctg.client.stats.GatewayConnection
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway using the specified port.
GatewayConnection(String, int) - Constructor for class com.ibm.ctg.client.stats.GatewayConnection
Constructs a GatewayConnection object and opens a connection to the CICS Transaction Gateway using the specified IP address and port.
GatewayIntercept - Interface in com.ibm.ctg.client
Provides a plug-in interface that allows JavaGateway method calls to be intercepted.
GatewayIntercept.InterceptAction - Enum in com.ibm.ctg.client
Indicates whether a JavaGateway method call should continue as normal or be intercepted.
GatewayRequest - Class in com.ibm.ctg.client
This is the root class that all the different types of Gateway request are built off.
GatewayReturnCodes - Interface in com.ibm.ctg.client
Constant values representing Gateway return codes.
generateHandshake(InetAddress) - Method in interface com.ibm.ctg.security.ClientSecurity
This method is called to generate the initial client-to-Gateway handshake flow.
get(Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Retrieves a Container from the Channel.
getAdapterName() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns the adapter name.
getAdapterShortDescription() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns a short description of the adapter.
getAdapterVendorName() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns the adapter vendor name.
getAdapterVersion() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns the adapter version.
getAddress() - Method in class com.ibm.ctg.client.JavaGateway
Returns the address that this JavaGateway is currently or will be connected to.
getAddress() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Gets the address for the Gateway daemon that this GatewayConnection will associate.
getAddTypeString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the add type for an extended Terminal Request for this object and returns it as a string
getAID() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Returns the AID property.
getAID() - Method in class com.ibm.ctg.epi.Screen
Gets the AID that will be sent back to the server.
getAID() - Method in class com.ibm.ctg.epi.ScreenHandler
Get the current AID value.
getApplid() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the applid for this connection.
getApplid() - Method in class com.ibm.ctg.util.OriginData
Returns the APPLID of the Java client application from which the transaction was started.
getApplidQualifier() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the applid qualifier for this connection.
getApplidQualifier() - Method in class com.ibm.ctg.util.OriginData
Returns the APPLID qualifier of the Java client application from which the transaction was started.
getBackGroundColor() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a constant which represents the background color of the screen.
getBackGroundColor() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns extended background attribute property.
getBITData() - Method in interface com.ibm.ctg.client.Container
Gets binary data from a BIT container.
getByte() - Method in enum com.ibm.ctg.client.Container.ContainerType
Gets a byte representing this ContainerType.
getBytes() - Method in class com.ibm.ctg.epi.Field
Returns the text currently in the field as a byte array.
getBytes(int, int) - Method in interface com.ibm.ctg.monitoring.TransientPayLoad
Returns a byte array of length bytes taken from offset bytes into the payload.
getCallType() - Method in class com.ibm.ctg.client.ECIRequest
This method returns the Call_Type field of this ECIRequest object.
getCallType() - Method in class com.ibm.ctg.client.EPIRequest
Returns the Call_Type set in this object.
getCallType() - Method in class com.ibm.ctg.client.ESIRequest
This method returns the Call_Type field of this ESIRequest object.
getCallTypeString() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a String representing the Call_Type field of this ECIRequest object.
getCallTypeString() - Method in class com.ibm.ctg.client.EPIRequest
Returns the Call_Type set in this object, as a String.
getCallTypeString() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a String describing the Call_Type field of this ESIRequest object.
getCCSID() - Method in class com.ibm.ctg.client.Channel
Returns the default CCSID associated with the channel
getCCSID() - Method in interface com.ibm.ctg.client.Container
Returns the CCSID of the data in the container.
getChannel() - Method in class com.ibm.ctg.client.ECIRequest
Gets the Channel associated with the request.
getCharacterSet() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns character set extended attribute.
getCHARData() - Method in interface com.ibm.ctg.client.Container
Gets character data from a CHAR container.
getCicsRc() - Method in class com.ibm.ctg.client.ECIRequest
Gets the CICS return code set in this object.
getCicsRc() - Method in class com.ibm.ctg.client.EPIRequest
Gets the CICS return code set in this object, if there is one.
getCicsRc() - Method in class com.ibm.ctg.client.ESIRequest
Gets the CICS return code set in this object.
getCicsRcString() - Method in class com.ibm.ctg.client.ECIRequest
Gets the CICS return code set in this object and returns it as a String.
getCicsRcString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the CICS return code set in this object and returns it as a String.
getCicsRcString() - Method in class com.ibm.ctg.client.ESIRequest
Gets the CICS return code set in this object and returns it as a String.
getCICSServer(Map<RequestDetails, Object>) - Method in interface com.ibm.ctg.ha.CICSRequestExit
This method will be called at the start of every extended LUW or XA transaction and for every SYNCONRETURN ECI request that is received by the CICS Transaction Gateway.
getCipherSuites() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Return the comma delimited list of cipher suites a SSL connection is able to use.
getClientCp() - Method in class com.ibm.ctg.client.CicsCpRequest
Returns the Client daemon's codepage (after the CicsCpRequest object has been flowed to the Gateway).
getClientIpaddr() - Method in class com.ibm.ctg.util.OriginData
Returns the IP address from which the transaction was started.
getClientPort() - Method in class com.ibm.ctg.util.OriginData
Returns the TCP/IP port from which the transaction was started.
getClientRc() - Method in class com.ibm.ctg.client.CicsCpRequest
Gets the Client Request return code set in this object, if there is one.
getClientRcString() - Method in class com.ibm.ctg.client.CicsCpRequest
Returns the String representation of the return code relating to a Client daemon codepage request, or "Return Code Out of Range".
getClientSecurity() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the client security class name.
getClientStatusString() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a String describing the CicsClientStatus field of this ECIRequest object.
getCodePage() - Method in class com.ibm.ctg.client.Channel
Returns the default code page associated with the channel
getColumn() - Method in class com.ibm.ctg.epi.Field
Returns the column at which the field starts on the screen.
getCommareaInboundLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns an int, which is the Commarea inbound length.
getCommareaLength() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for commareaLength.
getCommareaOutboundLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns an int, which is the Commarea outbound length.
getConnection() - Method in class com.ibm.connector2.cics.CICSConnectionFactory
Returns a connection within a non-managed environment.
getConnection() - Method in class com.ibm.connector2.cics.CICSInteraction
Returns the connection associated with this interaction.
getConnection(ConnectionSpec) - Method in class com.ibm.connector2.cics.ECIConnectionFactory
This is the extended version of getConnection() which allows the user to pass an ECIConnectionSpec parameter containing their user credentials.
getConnection(ConnectionSpec) - Method in class com.ibm.connector2.cics.EPIConnectionFactory
This method returns a connection object.
getConnectionTypeString() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a String describing the ConnectionType field of this ECIRequest object.
getConnectionURL() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the CTG gateway URL.
getContainer(String) - Method in class com.ibm.ctg.client.Channel
This method will examine the current containers within this channel looking for a container with the name supplied.
getContainerNames() - Method in class com.ibm.ctg.client.Channel
Gets a collection containing the names of all the containers in the channel.
getContainers() - Method in class com.ibm.ctg.client.Channel
Get a collection of all of the containers held within the channel
getCurrentPassword() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a String of the current password defined.
getCursorColumn() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Returns the cursor column property.
getCursorColumn() - Method in class com.ibm.ctg.epi.Screen
Gets the column position of the cursor.
getCursorColumn() - Method in class com.ibm.ctg.epi.ScreenHandler
Get the cursor column position.
getCursorRow() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Returns the cursor row property.
getCursorRow() - Method in class com.ibm.ctg.epi.Screen
Gets the row position of the cursor.
getCursorRow() - Method in class com.ibm.ctg.epi.ScreenHandler
Get the cursor row position.
getDataType() - Method in enum com.ibm.ctg.ha.ExitEventData
 
getDataType() - Method in enum com.ibm.ctg.ha.RequestDetails
 
getDataType() - Method in enum com.ibm.ctg.monitoring.RequestData
 
getDefaultBackgroundColor() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the default background color for the screen.
getDefaultCharSet() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the default character set for the screen.
getDefaultForegroundColor() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the default foreground color of the screen.
getDepth() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the depth or number of rows in the screen.
getDepth() - Method in class com.ibm.ctg.epi.Screen
Gets the screen depth.
getDeviceType() - Method in class com.ibm.connector2.cics.EPIConnectionSpec
Return the device type for this object.
getDeviceType() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Return the current device type.
getDeviceType() - Method in class com.ibm.ctg.epi.Terminal
Returns the device type of the terminal, or the device type to be used if the terminal is not currently connected.
getDistinguishedName() - Method in class com.ibm.ctg.monitoring.DistributedIdentity
Returns a string which represents the distinguished name.
getDllVer() - Method in exception com.ibm.ctg.util.DLLVersionMismatchException
Returns the version of the native library that caused the exception to be thrown.
getECITimeout() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a short.
getEISProductName() - Method in class com.ibm.connector2.cics.CICSConnectionMetaData
Return the EIS product name.
getEISProductVersion() - Method in class com.ibm.connector2.cics.CICSConnectionMetaData
Return the EIS product version.
getEncoding() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Return the current encoding.
getEncoding() - Method in class com.ibm.ctg.epi.Screen
Returns the character encoding that the Screen will use.
getEncoding() - Method in class com.ibm.ctg.epi.Terminal
Returns the current encoding used for a connected extended terminal or the encoding to be used if an extended terminal is not connected.
getEndReason() - Method in class com.ibm.ctg.client.EPIRequest
Returns the End Reason value which is set when an END_TERM event has been received.
getEndReason() - Method in class com.ibm.ctg.epi.Terminal
Returns the end reason code.
getEndReasonString() - Method in class com.ibm.ctg.client.EPIRequest
Returns the End Reason value as a string, which is set when an END_TERM event has been received.
getEndReasonString() - Method in class com.ibm.ctg.epi.Terminal
Returns the end reason code as a string.
getEndReturnCode() - Method in class com.ibm.ctg.client.EPIRequest
Gets the extra CICS return code from an END_TRAN or ADD_TERM event.
getEndReturnCodeString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the extra CICS return code from an END_TRAN or ADD_TERM event and returns it as a String.
getErrorCode() - Method in exception com.ibm.ctg.epi.EPIException
Returns the error code for this exception.
getEvent() - Method in class com.ibm.ctg.client.EPIRequest
Returns the event set in this object.
getEvent(int, int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the waitState and size associated with this object.
getEvent(int, int, int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, waitState and size associated with this object.
getEventString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the event set in this object and returns it as a String.
getEventWithCallback(int, Callbackable) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the size and Callbackable object associated with this object.
getEventWithCallback(int, int, Callbackable) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, size and Callbackable object associated with this object.
getException() - Method in class com.ibm.ctg.epi.TerminalEvent
Returns the exception associated with this event.
getExecuteTimeout() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for executeTimeout.
getExpiry() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a java.util.Calendar object containing the date/time of when the user ID/password will expire on the server.
getExpiry() - Method in class com.ibm.ctg.epi.EPISecurityAttrs
Returns information on when the password will expire.
getExtendMode() - Method in class com.ibm.ctg.client.ECIRequest
This method returns the Extend_Mode field of this ECIRequest object.
getExtendModeString() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a String describing the Extend_Mode field of this ECIRequest object.
getField(int) - Method in interface com.ibm.connector2.cics.EPIScreenRecord
Returns a field at the given index.
getFieldCount() - Method in interface com.ibm.connector2.cics.EPIScreenRecord
Returns the number of fields on the screen.
getFieldCount() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the number of fields on the screen.
getFieldLabels() - Method in class com.ibm.ctg.epi.Map
Returns the names of the fields.
getFields() - Method in interface com.ibm.connector2.cics.EPIScreenRecord
This returns an iterator which can be used to access all the fields on the screen in a sequential manner.
getFields() - Method in interface com.ibm.connector2.screen.IScreenable
Returns an iterator for the fields contained in the screen record.
getForeGroundColor() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a constant which represents the foreground color of the field text.
getForeGroundColor() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns extended foreground attribute property.
getFunctionName() - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Return the function name.
getFunctionName() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for function name.
getGatewayClientSecurity() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the name of the client security class that the CICS Transaction Gateway will use.
getGatewayLocale() - Method in class com.ibm.ctg.client.JavaGateway
Returns the Locale of the machine running the remote Gateway daemon if it is known.
getGatewayOs() - Method in class com.ibm.ctg.client.JavaGateway
Returns a string containing the operating system, architecture and version of the machine running the remote Gateway daemon.
getGatewayRc() - Method in class com.ibm.ctg.client.GatewayRequest
Gets the gateway return code set in this object.
getGatewayRcString() - Method in class com.ibm.ctg.client.GatewayRequest
Gets the Gateway return code set in this object and returns it as a String.
getGatewayServerSecurity() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the name of the server security class that the CICS Transaction Gateway will use.
getGatewayURL() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the URL of the CICS Transaction Gateway that the terminal will connect to.
getGwVer() - Method in exception com.ibm.ctg.util.DLLVersionMismatchException
Returns the version of the Gateway classes.
getHighlight() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a constant which indicates the type of highlight for the field.
getHighLight() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns extended highlight attribute property.
getId() - Method in class com.ibm.ctg.client.stats.IdData
Returns the statistic ID.
getInboundDataLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns an integer, which is the inbound data length.
getInstallTimeout() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Get the install timeout value in seconds.
getInstallTimeout() - Method in class com.ibm.ctg.epi.Terminal
Returns the install timeout associated with this terminal.
getInteractionSpecsSupported() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns a string array containing the names of the interaction specs supported by this implementation.
getInteractionVerb() - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Returns the interactionVerb property (int) value.
getInteractionVerb() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for interaction verb.
getInterceptPlugin() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Gets the name of the GatewayIntercept plugin class for this managed connection factory.
getInvalidConnections(Set) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Returns a Set of invalid connections (those that have been identifed as dirty) from the entire set of CICS managed connections that current exist
getInvalidCount() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a int containing the number of invalid password attempts for that user ID on the specified server.
getInvalidCount() - Method in class com.ibm.ctg.epi.EPISecurityAttrs
Returns the number of invalid access attempts made by this userid.
getIpAddrFamily() - Method in class com.ibm.ctg.util.OriginData
Returns the IP address family associated with the client IP address.
getKeyRing() - Static method in class com.ibm.ctg.client.SslJavaGateway
Deprecated. As of v6.0, deprecated in favour of JavaGateway.getProtocolProperties()
getKeyRingClass() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the key ring class name (applicable only to SSL Protocol).
getKeyRingPassword() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the key ring password (applicable only to SSL Protocol(s)).
getLastAccess() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a java.util.Calendar object containing the date/time of when the user ID/password was last accessed on the server.
getLastAccess() - Method in class com.ibm.ctg.epi.EPISecurityAttrs
Returns information on when the user last accessed.
getLastVerified() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a java.util.Calendar object containing the date/time of when the user ID/password was last verified on the server.
getLastVerified() - Method in class com.ibm.ctg.epi.EPISecurityAttrs
Returns information on when the security credentials were last verified.
getLength() - Method in interface com.ibm.ctg.monitoring.TransientPayLoad
Returns the number of bytes in the payload.
getLocalAddress() - Method in class com.ibm.ctg.client.SslJavaGateway
 
getLocalTransaction() - Method in class com.ibm.connector2.cics.ECIConnection
Return a CCI local transaction handle for use in controlling the ECIConnections transaction state.
getLocalTransaction() - Method in class com.ibm.connector2.cics.EPIConnection
This method will throw a NotSupportedException.
getLogHelper() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the log helper object.
getLogonLogoffClass() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Return the current logonLogoff class name.
getLogWriter() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Return the current log writer for this instance.
getMapName() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the map name
getMapName() - Method in class com.ibm.ctg.epi.Screen
Gets the map name for this screen.
getMapSetName() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the mapset name
getMapSetName() - Method in class com.ibm.ctg.epi.Screen
Gets the map set name for this screen.
getMaxLength() - Method in interface com.ibm.connector2.screen.IFieldData
Returns the maximum length of the field, including any attribute bytes.
getMaxTextLength() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns the maximum length of the field.
getMessageQualifier() - Method in class com.ibm.ctg.client.ECIRequest
Returns the Message Qualifier associated with this request.
getMetaData() - Method in class com.ibm.connector2.cics.CICSConnection
Returns the metadata for this connection.
getMetaData() - Method in class com.ibm.connector2.cics.ECIConnectionFactory
Returns information about the resource adapter.
getMetaData() - Method in class com.ibm.connector2.cics.EPIConnectionFactory
Return the resource adapter meta data.
getModifiedFields() - Method in interface com.ibm.connector2.screen.IScreenable
Returns an iterator for the modified fields contained in the screen record.
getName() - Method in interface com.ibm.connector2.screen.IFieldData
Returns field name if one exists, null or "" otherwise.
getName() - Method in interface com.ibm.connector2.screen.IFieldInfo
Returns the name of the field.
getName() - Method in class com.ibm.ctg.client.Channel
Returns the name of the channel
getName() - Method in interface com.ibm.ctg.client.Container
Gets the name of the container
getName() - Method in class com.ibm.ctg.epi.Map
Returns the name of the map.
getNetName() - Method in class com.ibm.connector2.cics.EPIConnectionSpec
Return the net name for this object.
getNetName() - Method in class com.ibm.ctg.epi.Terminal
Returns the netname of the terminal, or the netname to be used if the terminal is not currently connected.
getNetworkProtocol() - Static method in class com.ibm.ctg.client.AutoJavaGateway
Returns the protocol used when an automatic JavaGateway object determines that a network JavaGateway object is required.
getNewPassword() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a String of the new password defined.
getOutputAttributeType() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the outputAttributetype (int) value.
getPassword() - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Gets the password for this connection spec.
getPassword() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the password for this connection.
getPassword() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the password associated with the terminal, or null if the password is null or the terminal is a basic terminal.
getPassword() - Method in class com.ibm.ctg.epi.Terminal
Returns the password associated with the terminal, or null if the password is null or the terminal is a basic terminal.
getPassword() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns the password associated with the terminal, or null if the password is null or the terminal is a basic terminal.
getPort() - Method in class com.ibm.ctg.client.JavaGateway
Returns the port of the CICS Transaction Gateway that this JavaGateway instance is currently or will be connected to.
getPort() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Gets the port that this GatewayConnection is connected to.
getPortNumber() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the port to communicate with the CTG on.
getPos() - Method in interface com.ibm.connector2.screen.IFieldData
Returns the position of the field on the screen.
getPosition() - Method in class com.ibm.ctg.epi.Field
Returns the position of the start of the field on the screen.
getPrincipalFacilityType() - Method in class com.ibm.ctg.util.OriginData
Returns the principal facility type of the origin data.
getProtocol() - Method in class com.ibm.ctg.client.JavaGateway
Returns the protocol that this JavaGateway instance is currently using or will use to connect to the CICS Transaction Gateway.
getProtocolProperties() - Method in class com.ibm.ctg.client.JavaGateway
Returns a Properties object containing any settings specific to the protocol used to connect to the CICS Transaction Gateway, or null if there are none.
getQueryElement() - Method in class com.ibm.ctg.client.stats.IdData
Returns the query string used to retrieve this statistic ID.
getQueryElement() - Method in class com.ibm.ctg.client.stats.StatData
Get the query used to obtain this statistic.
getRACFUserid() - Method in class com.ibm.ctg.util.RACFUserid
Returns the RACF user ID which maps to the supplied X.509 certificate.
getRc() - Method in class com.ibm.ctg.client.CicsCpRequest
Returns the Gateway return code, set in this object.
getRc() - Method in class com.ibm.ctg.client.ECIRequest
Gets the return code set in this object.
getRc() - Method in class com.ibm.ctg.client.EPIRequest
Gets the return code set in this object.
getRc() - Method in class com.ibm.ctg.client.ESIRequest
Gets the return code set in this object.
getRc() - Method in class com.ibm.ctg.client.stats.IdData
The return code for obtaining this statistic ID.
getRc() - Method in class com.ibm.ctg.client.stats.StatData
Get the return code for obtaining this statistic.
getRc() - Method in exception com.ibm.ctg.client.TFileException
Gets the return code indicating the reason the exception was thrown.
getRcString() - Method in class com.ibm.ctg.client.ECIRequest
Gets the return code set in this object and return it as a string.
getRcString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the return code set in this object and return it as a string.
getRcString() - Method in class com.ibm.ctg.client.ESIRequest
Gets the return code set in this object and return it as a string.
getReadTimeout() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Returns the current read timeout value in seconds.
getReadTimeout() - Method in class com.ibm.ctg.epi.Terminal
Returns the read timeout associated with this terminal or the read timeout to be set if the terminal is not connected.
getRealmName() - Method in class com.ibm.ctg.monitoring.DistributedIdentity
Returns a string which represents the realm name.
getRecordFactory() - Method in class com.ibm.connector2.cics.CICSConnectionFactory
This will throw a NotSupportedException if invoked.
getRecordName() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns the name of the Channel record
getRecordShortDescription() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns a short description of this record
getReference() - Method in class com.ibm.connector2.cics.CICSConnectionFactory
Return the reference object associated with this object.
getReplyLength() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for replyLength.
getRequestExits() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the requestExits for this connection.
getRequestExits() - Method in class com.ibm.ctg.client.JavaGateway
Get a string containing the comma-delimited package-qualified classnames of the RequestExit monitors that were or will be enabled when the open() method is called on this object.
getRequestType() - Method in enum com.ibm.ctg.monitoring.FlowType
 
getResourceAdapter() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
 
getResourceGroupIds() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Returns an IdResultSet of IdData objects representing the set of all the resource group IDs available from the Gateway daemon.
getResultSetInfo() - Method in class com.ibm.connector2.cics.CICSConnection
Returns the resultSetInfo object.
getRetryCount() - Method in interface com.ibm.ctg.ha.CICSRequestExit
This method will be called after the exit is loaded to determine the maximum number of times a request will be retried when it fails with one of the following errors: ECI_ERR_NO_CICS ECI_ERR_CICS_DIED ECI_ERR_RESOURCE_SHORTAGE
getReturnString(int) - Method in class com.ibm.ctg.client.stats.ResponseData
Returns a string representation of the specfied return code.
getRow() - Method in class com.ibm.ctg.epi.Field
Returns the row at which the field starts on the screen.
getScreen() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the Screen object associated with this terminal.
getScreen() - Method in class com.ibm.ctg.epi.Map
Returns the screen associated with this map.
getScreen() - Method in class com.ibm.ctg.epi.Terminal
Returns the screen associated with the terminal.
getScreen() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns the screen associated with the terminal.
getScreenDepth() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the screen depth (int) value.
getScreenDepth() - Method in interface com.ibm.connector2.cics.EPIScreenRecord
Return the number of rows the screen has.
getScreenHandler() - Method in class com.ibm.ctg.epi.ScreenEvent
Returns the screen handler.
getScreenId() - Method in interface com.ibm.connector2.screen.IScreenable
Returns the screen record ID.
getScreenWidth() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the screen wdith (int) value.
getScreenWidth() - Method in interface com.ibm.connector2.cics.EPIScreenRecord
Return the number of columns on the screen.
getServer() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a String of the server defined.
getServerName() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Return the server to connect to (must be defined to the CTG).
getServerName() - Method in class com.ibm.ctg.epi.Terminal
Returns the name of the server the terminal is connected to, or will be connected to if the terminal is not currently connected.
getServerSecurity() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the server security class name.
getServerStatusString() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a String describing the CicsServerStatus field of this ECIRequest object.
getShortDesc() - Method in class com.ibm.ctg.client.stats.StatData
Get the short description of the statistic represented by this object.
getSignonCapability() - Method in class com.ibm.ctg.epi.Terminal
If the terminal is connected, the signon capability of the associated EPI terminal is returned.
getSignonString() - Method in class com.ibm.ctg.client.EPIRequest
Gets the Signon Capability set in this object and return it as a string
getSignonString() - Method in class com.ibm.ctg.epi.Terminal
Gets the Signon Capability set in this object and return it as a string.
getSignonType() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Return the sign on type:
getSocketConnectTimeout() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Returns the socket connect timeout value for a connection to CICS TG.
getSocketConnectTimeout() - Method in class com.ibm.ctg.client.JavaGateway
Returns the socket connect timeout value for this JavaGateway instance.
getSpecVersion() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns the version of the J2EE connector spec implemented by this resource adapter.
getStartCol() - Method in interface com.ibm.connector2.screen.IFieldInfo
Returns the starting column of the field.
getStartPos() - Method in interface com.ibm.connector2.screen.IFieldInfo
Returns the starting position of the field.
getStartRow() - Method in interface com.ibm.connector2.screen.IFieldInfo
Returns the starting row which contains the field.
getStartStck() - Method in class com.ibm.ctg.util.OriginData
Returns a store clock value representing the time when the origin data was created.
getState() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the terminal state.
getState() - Method in class com.ibm.ctg.epi.Terminal
Returns the state of the terminal as defined in TerminalSession.
getState() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns the state of the terminal.
getStatId() - Method in class com.ibm.ctg.client.stats.StatData
Get the statistic ID that this object represents.
getStatIds(String) - Method in class com.ibm.ctg.client.stats.GatewayConnection
Returns an IdResultSet containing a set of IdData objects representing the statistic IDs that match the supplied query string "ids".
getStatIds() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Returns an IdResultSet containing a set of IdData objects that represent all available statistic IDs.
getStats(String) - Method in class com.ibm.ctg.client.stats.GatewayConnection
Returns a StatResultSet containing a set of StatData objects representing the statistics that match the supplied query string "ids".
getStats() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Returns a StatResultSet containing a set of StatData objects that represents all available statistics.
getStatsAPIVersion() - Method in class com.ibm.ctg.client.stats.GatewayConnection
Get the Statistics API version.
getStatus(String) - Method in class com.ibm.ctg.client.ECIRequest
This method sets the values of an ECIRequest object for an ECI_STATE_SYNC_JAVA call on the CICS Transaction Gateway.
getStatus(String, int, Callbackable) - Method in class com.ibm.ctg.client.ECIRequest
This method sets the values of an ECIRequest object for an ECI_STATE_ASYNC_JAVA call on the CICS Transaction Gateway.
getSyncType() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the type of synchronization the terminal is using.
getSyncType() - Method in interface com.ibm.ctg.epi.Session
Gets the type of synchronization to be used for this session.
getTermId() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns the terminal id
getTermid() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the terminal id associated with the terminal.
getTermid() - Method in class com.ibm.ctg.epi.Terminal
Returns the terminal ID associated with the terminal.
getTermid() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns the terminal id associated with the terminal.
getTerminal() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the terminal that will be used to connect to CICS..
getTerminal() - Method in class com.ibm.ctg.epi.TerminalEvent
Returns the terminal associated with this event.
getTerminalRequest() - Method in class com.ibm.ctg.epi.TerminalEvent
Returns the terminal request ID.
getText() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Get the text of the field.
getText() - Method in interface com.ibm.connector2.screen.IFieldData
Returns the text of the field.
getText() - Method in interface com.ibm.connector2.screen.IFieldInfo
Returns the text of the field.
getText() - Method in class com.ibm.ctg.epi.Field
Returns the contents of the field as a String.
getTextCol() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Return the current column of the text for the field.
getTextColors() - Method in interface com.ibm.connector2.screen.ITextAttrInfo
Returns a character array of the text colors.
getTextExtAttrs() - Method in interface com.ibm.connector2.screen.ITextAttrInfo
Returns a character array of the extended attributes.
getTextPos() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Return the current position of the text for the field.
getTextRow() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Return the current row of the text for the field.
getTimeout() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the terminal timeout.
getTPNName() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for TPNName.
getTPNName() - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Accessor for TPNName.
getTraceLevel() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the trace level for this managed connection factory.
getTranFailedReason() - Method in exception com.ibm.connector2.cics.EPITranFailedException
Returns the reason code for the transaction failure, for example EPI_TRAN_NOT_STARTED or EPI_READTIMEOUT_EXPIRED.
getTranName() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Accessor for tranName.
getTranName() - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Accessor for tranName.
getTransaction() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the transaction that will be started if startTran is called.
getTransactionData() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the parameters that will be passed when startTran is called.
getTransactionType() - Method in enum com.ibm.ctg.monitoring.FlowType
 
getTransGroupId() - Method in class com.ibm.ctg.util.OriginData
Returns the transaction group ID associated with the origin data.
getTransID() - Method in class com.ibm.ctg.epi.Terminal
Returns the transaction ID of the current transaction.
getTransId() - Method in class com.ibm.ctg.util.OriginData
Returns the CICS mirror transaction under which the transaction was started.
getTransparency() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a constant which indicates the type of transparency for the field.
getTransparency() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns extended transparency attribute property.
getTxnFailedReason() - Method in exception com.ibm.ctg.epi.EPITxnFailedException
Returns the reason code for the transaction failure, for example EPI_TRAN_NOT_STARTED or EPI_READTIMEOUT_EXPIRED.
getType() - Method in interface com.ibm.ctg.client.Container
Gets the ContainerType of the container.
getURL() - Method in class com.ibm.ctg.client.JavaGateway
Returns the URL of the CICS Transaction Gateway that this JavaGateway is currently or will be connected to.
getUserid() - Method in class com.ibm.ctg.client.ESIRequest
This method returns a String of the current user ID defined.
getUserid() - Method in class com.ibm.ctg.epi.EPITerminal
Returns the userid associated with the terminal, or null if the userid is null or the terminal is a basic terminal.
getUserid() - Method in class com.ibm.ctg.epi.Terminal
Returns the user ID associated with the terminal, or null if the user ID is null or the terminal is a basic terminal.
getUserid() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns the userid associated with the terminal, or null if the userid is null or the terminal is a basic terminal.
getUserid() - Method in class com.ibm.ctg.util.OriginData
Returns the CICS user ID under which the transaction was started.
getUserName() - Method in class com.ibm.connector2.cics.CICSConnectionMetaData
Return the current username for this connection.
getUserName() - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Gets the username for this connection spec.
getUserName() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Get the username for this connection.
getValue() - Method in class com.ibm.ctg.client.stats.StatData
Get the value of the statistic this object represents.
getWarnings() - Method in class com.ibm.connector2.cics.CICSInteraction
Retrieves the first warning in the warning chain.
getWidth() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns the width or number of columns in the screen.
getWidth() - Method in class com.ibm.ctg.epi.Screen
Gets the screen width.
gray - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color gray.
gray - Static variable in class com.ibm.ctg.epi.Field
The color gray.
green - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color green.
green - Static variable in class com.ibm.ctg.epi.Field
The color green.

H

handleException(TerminalInterface, Exception) - Method in class com.ibm.ctg.epi.EPITerminal
Handles an exception received from the Terminal class is in the right state.
handleReply(TerminalInterface) - Method in class com.ibm.ctg.epi.EPITerminal
Handles a reply from CICS by sending handleScreen events to all listeners if the terminal is in the right state.
handleReply(TerminalInterface) - Method in interface com.ibm.ctg.epi.Session
Implement this method to handle EPI Events.
handleScreen(TerminalEvent) - Method in interface com.ibm.ctg.epi.TerminalEventListener
A screen has arrived from CICS.
hasAttribute() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns whether a field has any attribute bytes (ie it is a formatted field or not).
hasAttribute() - Method in class com.ibm.ctg.epi.Field
Returns a boolean indicating the presence of a field attribute.
hasChannel() - Method in class com.ibm.ctg.client.ECIRequest
Gets a value indicating whether the request has an associated Channel.
hashCode() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Returns a hashcode based on connectionURL, serverName and portNumber which uniquely identifies the backend server.
hashCode() - Method in class com.ibm.connector2.cics.ECIChannelRecord
 
hashCode() - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Returns a hashcode based on all configurable properties.
hashCode() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Returns a hashcode based on all configurable properties.
hashCode() - Method in class com.ibm.ctg.epi.Terminal.EPISignOnType
Returns a hash code for this EPISignOnType.
highlight() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating which type of highlight is being used.
hilight - Variable in class com.ibm.ctg.client.EPIRequest
1 = terminal resource supports extended highlighting; else 0.

I

IdData - Class in com.ibm.ctg.client.stats
This class is a representation of a single statistic ID.
idle - Static variable in interface com.ibm.ctg.epi.TerminalSession
Terminal idle.
IdResultSet - Class in com.ibm.ctg.client.stats
This is a collection of IdData objects returned from a statistics request made through a GatewayConnection.
IExtendedAttributes - Interface in com.ibm.connector2.screen
This interface defines the constant values used when working with extended attributes.
IFieldAttrInfo - Interface in com.ibm.connector2.screen
This interface defines the field attribute interface.
IFieldData - Interface in com.ibm.connector2.screen
This interface defines the field data interface used by the resource adapter.
IFieldInfo - Interface in com.ibm.connector2.screen
This interface defines the field information interface used by an application to obtain the name, starting column, starting row, starting position, or text of a field.
INCOMPLETE_RESULTSET - Static variable in class com.ibm.ctg.client.stats.ResponseData
A partial set of statistics have been returned for the statistic group ID specified on the query.
IndexOutOfBoundsException - Exception in com.ibm.connector2.screen
This exception is thrown when the specified field index is outside the valid range for the ScreenRecord.
IndexOutOfBoundsException() - Constructor for exception com.ibm.connector2.screen.IndexOutOfBoundsException
Constructs a IndexOutOfBoundsException with no detail message.
IndexOutOfBoundsException(String) - Constructor for exception com.ibm.connector2.screen.IndexOutOfBoundsException
Constructs a IndexOutOfBoundsException with the specified detail message.
inputProt() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating whether or not the field is protected.
inputType() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating the input data type for this field.
inquireSystem() - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_INQUIRE_STATE.
inquireSystem(int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_INQUIRE_STATE and also sets the termIndex associated with this object.
installTimeout - Variable in class com.ibm.ctg.client.EPIRequest
Terminal Install Timeout.
intense - Static variable in class com.ibm.ctg.epi.Field
Intense.
intenseHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Intense highlight.
intenseHlt - Static variable in class com.ibm.ctg.epi.Field
Intense highlight.
intensity() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating the field intensity.
interceptClose(JavaGateway) - Method in interface com.ibm.ctg.client.GatewayIntercept
Allows the JavaGateway.close() method to be intercepted.
interceptFlow(JavaGateway, GatewayRequest) - Method in interface com.ibm.ctg.client.GatewayIntercept
Allows the JavaGateway.flow(GatewayRequest) method to be intercepted.
interceptOpen(JavaGateway) - Method in interface com.ibm.ctg.client.GatewayIntercept
Allows the JavaGateway.open() method to be intercepted.
INVALID_ROWCOL - Static variable in exception com.ibm.ctg.epi.EPIScreenException
The DataStream has an unsupported 3270 Command
InvalidRequestException - Exception in com.ibm.ctg.ha
This exception can be thrown by a CICS request exit if the exit determines that the request should not be sent to CICS.
InvalidRequestException() - Constructor for exception com.ibm.ctg.ha.InvalidRequestException
Creates a new exception with no message.
InvalidRequestException(String) - Constructor for exception com.ibm.ctg.ha.InvalidRequestException
Creates a new exception with the specified message.
InvalidRequestException(Throwable) - Constructor for exception com.ibm.ctg.ha.InvalidRequestException
Creates a new exception with the specified cause
InvalidRequestException(String, Throwable) - Constructor for exception com.ibm.ctg.ha.InvalidRequestException
Creates a new exception with the specified message and cause.
isATI() - Method in class com.ibm.ctg.epi.EPITerminal
Returns true if ATI is currently enabled for this terminal.
isAuthenticated() - Method in class com.ibm.ctg.monitoring.DistributedIdentity
Returns a boolean which indicates whether or not the distributed identity has been authenticated by a security registry.
isAutoMsgQual() - Method in class com.ibm.ctg.client.ECIRequest
Returns whether Automatic Message Qualifier generation is on or not.
isCallback() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a boolean indicating whether there is a Callbackable object associated with this ECIRequest object.
isCallback() - Method in class com.ibm.ctg.client.EPIRequest
This method returns a boolean indicating whether there is a Callbackable object associated with this EPIRequest object.
isCicsContainer() - Method in interface com.ibm.ctg.client.Container
Gets a value indicating whether the container was created by CICS.
isCommareaInboundLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a boolean value which indicates that setCommareaInboundLength was called with a valid value.
isCommareaOutboundLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a boolean indicating whether the Commarea outbound length is valid.
isConnected() - Method in class com.ibm.ctg.epi.EPITerminal
Returns true if the terminal is connected to CICS.
IScreenable - Interface in com.ibm.connector2.screen
This interface defines the screen interface used by the resource adapter to build screen output, or obtain the fields it needs.
IScreenInfo - Interface in com.ibm.connector2.screen
This interface defines the screen information interface.
isDisplay() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a flag indicating whether the field should be displayed or not.
isDisplay() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns base display attribute property.
isEmpty() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns whether the Channel is empty or not.
isExtendedTerminal() - Method in class com.ibm.ctg.epi.Terminal
Returns whether the connected terminal is extended or not, or the type of terminal that will be requested if not connected.
isHandled() - Method in class com.ibm.ctg.epi.TerminalEvent
Returns true if the event is already being handled by another listener.
isHandling() - Method in class com.ibm.ctg.epi.ScreenHandler
Returns true if the ScreenHandler is handling the current screen.
isHighIntensity() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a flag indicating whether the field is high intensity.
isHighIntensity() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns base intensity attribute property.
isInboundDataLength() - Method in class com.ibm.ctg.client.ECIRequest
This method returns a boolean indicating whether automatic null stripping took place.
isInitialFlow() - Method in class com.ibm.ctg.client.JavaGateway
Checks whether an initial flow will be sent when this JavaGateway is opened.
isLeftline() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Left vertical line required for field outlining extended attribute.
isLocal(String) - Static method in class com.ibm.ctg.client.JavaGateway
Tests if a specified protocol string represents a local JavaGateway.
isMandatoryEntry() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Mandatory entry from field validation extended attribute.
isMandatoryFill() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Mandatory fill from field validation extended attribute.
isModified() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a flag indicating whether the field has been modified.
isModified() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns base modified attribute property.
isNumeric() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a flag indicating whether the field is only numeric.
isNumeric() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns base numeric attribute property.
isOpen() - Method in class com.ibm.ctg.client.JavaGateway
Checks both our expected state and the real state of any wrappered object.
isOverline() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Overline required for field outlining extended attribute.
isPenDetectable() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns penDetectable property.
isprotect - Static variable in class com.ibm.ctg.epi.Field
Protected field which does not allow data entry.
isProtected() - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Returns a flag indicating whether the field is protected.
isProtected() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Returns base protected attribute property.
isPurgeOnDisconnect() - Method in class com.ibm.ctg.epi.Terminal
Returns the purgeOnDisconnect flag for this terminal.
isReadOnly() - Method in interface com.ibm.ctg.client.Container
Gets a value indicating whether the container was marked as read-only by CICS.
isRightline() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Right vertical line required for field outlining extended attribute.
isTPNTransid() - Method in class com.ibm.ctg.client.ECIRequest
Returns a boolean indicating whether the Transid field is interpreted as an eci_tpn transid (if supported) by the CICS client.
isTrigger() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Mandatory fill from field validation extended attribute.
isUnderline() - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Underline required for field outlining extended attribute.
isValid() - Method in class com.ibm.ctg.epi.Map
Returns true if map is currently valid.
iterator() - Method in class com.ibm.ctg.client.stats.IdResultSet
Obtain an Iterator for this Collection.
iterator() - Method in class com.ibm.ctg.client.stats.StatResultSet
Obtain an Iterator for this Collection.
ITextAttrInfo - Interface in com.ibm.connector2.screen
This interface defines the text attribute field interface.

J

JavaGateway - Class in com.ibm.ctg.client
The JavaGateway represents a logical connection between your program and the CICS Transaction Gateway when you specify a remote protocol.
JavaGateway() - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a default JavaGateway object.
JavaGateway(String, int) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a remote Gateway daemon or local client.
JavaGateway(String, int, Properties) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a remote Gateway daemon or local client.
JavaGateway(String, int, String, String, Properties) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a remote Gateway daemon or local client.
JavaGateway(String, int, String, String) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a remote Gateway daemon or local client.
JavaGateway(String, int, int, Properties) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a Gateway daemon or local client.
JavaGateway(String, int, int, String, String, Properties) - Constructor for class com.ibm.ctg.client.JavaGateway
Constructs a JavaGateway object and connects it via the defined protocol to a Gateway daemon or local client.
JNI_TRACE_OFF - Static variable in class com.ibm.ctg.client.T
Turn JNI trace off.
JNI_TRACE_ON - Static variable in class com.ibm.ctg.client.T
Turn JNI trace on.
JSSEServerSecurity - Interface in com.ibm.ctg.security
All implementations of CICS Transaction Gateway server-side security classes which require the exposure of SSL Client Certificates must implement the JSSEServerSecurity interface.

K

keySet() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns a Set with the Container names in it.

L

label - Variable in class com.ibm.ctg.epi.FieldData
The field label, or null if it is not labelled.
labels - Variable in class com.ibm.ctg.epi.MapData
The number of labelled fields in the map.
len - Variable in class com.ibm.ctg.epi.FieldData
The field length.
length() - Method in class com.ibm.ctg.epi.Field
Returns the total length of the field.
listSystems(int) - Static method in class com.ibm.ctg.client.ECIRequest
This method returns an ECIRequest object which can be flowed to a CICS Transaction Gateway to retrieve the defined CICS servers.
listSystems(int) - Static method in class com.ibm.ctg.client.EPIRequest
This method returns a new EPIRequest object which can be used to effect a CICS_EpiListSystems on the CICS Transaction Gateway.
LOCAL_PROP_APPLID - Static variable in class com.ibm.ctg.client.JavaGateway
APPLID.
LOCAL_PROP_APPLID_QUALIFIER - Static variable in class com.ibm.ctg.client.JavaGateway
APPLID HIGH LEVEL QUALIFIER.
LocalJavaGateway - Class in com.ibm.ctg.client
This class allows you to process request locally on a machine.
LocalTransactionNotStartedException - Exception in com.ibm.connector2.cics
This exception is thrown when the ECIManagedConnection attempts to end a transaction which has not been started
LocalTransactionNotStartedException(String, String) - Constructor for exception com.ibm.connector2.cics.LocalTransactionNotStartedException
 
Luw_Token - Variable in class com.ibm.ctg.client.ECIRequest
Extended Logical Unit of Work token.

M

Map - Class in com.ibm.ctg.epi
This class represents a BMS map.
Map(MapData, int[], FieldData[]) - Constructor for class com.ibm.ctg.epi.Map
Constructs a Map object with a MapData object that describes the map, an index of labelled fields and an array of FieldData objects that describe the fields within the map.
MapData - Class in com.ibm.ctg.epi
This class contains information about a BMS map.
MapData(int, int, int, int, int, int) - Constructor for class com.ibm.ctg.epi.MapData
Constructs a MapData object with the given information.
MapData(String, int, int, int, int, int, int) - Constructor for class com.ibm.ctg.epi.MapData
Constructs a MapData object with the given information.
mapName - Variable in class com.ibm.ctg.client.EPIRequest
The map name for the transaction (if any).
mapSetName - Variable in class com.ibm.ctg.client.EPIRequest
The map set name for the transaction (if any).
MARKER_BYTE - Static variable in class com.ibm.connector2.cics.EPIInteractionSpec
defines the byte which represents a field marker
maxData - Variable in class com.ibm.ctg.client.EPIRequest
The maximum amount of data that could be sent to this terminal resource, and it also represents the maximum amount of data that should be sent by this terminal resource.
maxNumServers - Variable in class com.ibm.ctg.client.ECIRequest
Maximum number of CICS servers about which information is to be returned (see listSystems()).
maxNumServers - Variable in class com.ibm.ctg.client.EPIRequest
Maximum number of CICS servers about which info is to be returned (input to listSystems()).
MCF_TOKEN - Static variable in class com.ibm.ctg.client.JavaGateway
ManagedConnectionFactory token protocol property.
Message_Qualifier - Variable in class com.ibm.ctg.client.ECIRequest
Deprecated. setMessageQualifier() and getMessageQualifier() methods should now be used.
modified - Static variable in class com.ibm.ctg.epi.Field
Modified field (will be flowed back to the server).
moveContainer(String, Channel) - Method in class com.ibm.ctg.client.Channel
Move a container from another channel
moveContainer(String, Channel, String) - Method in class com.ibm.ctg.client.Channel
Move a container from another channel

N

name - Variable in class com.ibm.ctg.epi.MapData
The name of the map.
NameNotFoundException - Exception in com.ibm.connector2.screen
This exception is thrown to indicate that a failure occurs when trying to find the named object.
NameNotFoundException() - Constructor for exception com.ibm.connector2.screen.NameNotFoundException
Constructs a NameNotFoundException with no detail message.
NameNotFoundException(String) - Constructor for exception com.ibm.connector2.screen.NameNotFoundException
Constructs a NameNotFoundException with the specified detail message.
netName - Variable in class com.ibm.ctg.client.EPIRequest
Netname - platform dependent.
neutral - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Neutral foreground color.
neutral - Static variable in class com.ibm.ctg.epi.Field
Neutral foreground color.
neutralBGrnd - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Neutral background colour.
neutralBGrnd - Static variable in class com.ibm.ctg.epi.Field
Neutral background colour.
NLS_NOT_SUPPORTED - Static variable in class com.ibm.ctg.client.CicsCpRequest
The Java Virtual Machine on which the CICS Transaction Gateway application is running is pre v1.1.
NO_ENCODING_CLASS - Static variable in class com.ibm.ctg.client.CicsCpRequest
The Java Virtual Machine on which the CICS Transaction Gateway application is running does not have a suitable encoding class.
NO_REQUEST - Static variable in class com.ibm.ctg.epi.TerminalEvent
No terminal request.
normal - Static variable in class com.ibm.ctg.epi.Field
Normal intensity.
normalHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Normal highlight.
normalHlt - Static variable in class com.ibm.ctg.epi.Field
Normal highlight.
NULL_ID - Static variable in class com.ibm.ctg.client.stats.ResponseData
The ID provided on the query was null.
numColumns - Variable in class com.ibm.ctg.client.EPIRequest
Number of columns supported by the terminal resource.
numeric - Static variable in class com.ibm.ctg.epi.Field
Numeric field (non-numeric characters cannot be entered).
numLines - Variable in class com.ibm.ctg.client.EPIRequest
Number of rows supported by the terminal resource.
numServersKnown - Variable in class com.ibm.ctg.client.ECIRequest
Number of CICS servers which are defined (output from listSystems() flow).
numServersKnown - Variable in class com.ibm.ctg.client.EPIRequest
Number of CICS servers which are defined (output from listSystems() flow).
numServersReturned - Variable in class com.ibm.ctg.client.ECIRequest
Number of CICS servers about which information has been returned (output from listSystems() flow).
numServersReturned - Variable in class com.ibm.ctg.client.EPIRequest
Number of CICS servers about which information has been returned (output from listSystems() flow).

O

opaqueTran - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Opaque transparency.
opaqueTran - Static variable in class com.ibm.ctg.epi.Field
Opaque transparency.
open() - Method in class com.ibm.ctg.client.JavaGateway
Opens this JavaGateway type object.
open() - Method in class com.ibm.ctg.epi.EPIGateway
Opens the Gateway.
OPSYS_NOT_RECOGNISED - Static variable in class com.ibm.ctg.client.CicsCpRequest
The machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") which the CICS Transaction Gateway does not recognize.
OPSYS_OS390 - Static variable in class com.ibm.ctg.client.CicsCpRequest
The Java Virtual Machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") of OS/390.
OPSYS_ZOS - Static variable in class com.ibm.ctg.client.CicsCpRequest
The Java Virtual Machine on which the CICS Transaction Gateway application is running has an Operating System (System Property "os.name") of z/OS.
orange - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color orange.
orange - Static variable in class com.ibm.ctg.epi.Field
The color orange.
OriginData - Class in com.ibm.ctg.util
Represents IPIC origin data which can be used to associate the flow from a Java application through to a CICS region.
OriginData(String, String, String, String, InetAddress, int) - Constructor for class com.ibm.ctg.util.OriginData
Builds a new OriginData based on the information provided and the time that his object was created.
orTran - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
OR transparency.
orTran - Static variable in class com.ibm.ctg.epi.Field
OR transparency.

P

PA1 - Static variable in class com.ibm.connector2.cics.AIDKey
PA1 key
PA1 - Static variable in class com.ibm.ctg.epi.AID
PA1 key.
PA2 - Static variable in class com.ibm.connector2.cics.AIDKey
PA2 key
PA2 - Static variable in class com.ibm.ctg.epi.AID
PA2 key.
PA3 - Static variable in class com.ibm.connector2.cics.AIDKey
PA3 key
PA3 - Static variable in class com.ibm.ctg.epi.AID
PA3 key.
paleCyan - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color pale cyan.
paleCyan - Static variable in class com.ibm.ctg.epi.Field
The color pale cyan.
paleGreen - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color pale green.
paleGreen - Static variable in class com.ibm.ctg.epi.Field
The color pale green.
Password - Variable in class com.ibm.ctg.client.ECIRequest
Password for CICS server.
password - Variable in class com.ibm.ctg.client.EPIRequest
Password associated with the terminal.
PF1 - Static variable in class com.ibm.connector2.cics.AIDKey
PF1 key
PF1 - Static variable in class com.ibm.ctg.epi.AID
PF1 key.
PF10 - Static variable in class com.ibm.connector2.cics.AIDKey
PF10 key
PF10 - Static variable in class com.ibm.ctg.epi.AID
PF10 key.
PF11 - Static variable in class com.ibm.connector2.cics.AIDKey
PF11 key
PF11 - Static variable in class com.ibm.ctg.epi.AID
PF11 key.
PF12 - Static variable in class com.ibm.connector2.cics.AIDKey
PF12 key
PF12 - Static variable in class com.ibm.ctg.epi.AID
PF12 key.
PF13 - Static variable in class com.ibm.connector2.cics.AIDKey
PF13 key
PF13 - Static variable in class com.ibm.ctg.epi.AID
PF13 key.
PF14 - Static variable in class com.ibm.connector2.cics.AIDKey
PF14 key
PF14 - Static variable in class com.ibm.ctg.epi.AID
PF14 key.
PF15 - Static variable in class com.ibm.connector2.cics.AIDKey
PF15 key
PF15 - Static variable in class com.ibm.ctg.epi.AID
PF15 key.
PF16 - Static variable in class com.ibm.connector2.cics.AIDKey
PF16 key
PF16 - Static variable in class com.ibm.ctg.epi.AID
PF16 key.
PF17 - Static variable in class com.ibm.connector2.cics.AIDKey
PF17 key
PF17 - Static variable in class com.ibm.ctg.epi.AID
PF17 key.
PF18 - Static variable in class com.ibm.connector2.cics.AIDKey
PF18 key
PF18 - Static variable in class com.ibm.ctg.epi.AID
PF18 key.
PF19 - Static variable in class com.ibm.connector2.cics.AIDKey
PF19 key
PF19 - Static variable in class com.ibm.ctg.epi.AID
PF19 key.
PF2 - Static variable in class com.ibm.connector2.cics.AIDKey
PF2 key
PF2 - Static variable in class com.ibm.ctg.epi.AID
PF2 key.
PF20 - Static variable in class com.ibm.connector2.cics.AIDKey
PF20 key
PF20 - Static variable in class com.ibm.ctg.epi.AID
PF20 key.
PF21 - Static variable in class com.ibm.connector2.cics.AIDKey
PF21 key
PF21 - Static variable in class com.ibm.ctg.epi.AID
PF21 key.
PF22 - Static variable in class com.ibm.connector2.cics.AIDKey
PF22 key
PF22 - Static variable in class com.ibm.ctg.epi.AID
PF22 key.
PF23 - Static variable in class com.ibm.connector2.cics.AIDKey
PF23 key
PF23 - Static variable in class com.ibm.ctg.epi.AID
PF23 key.
PF24 - Static variable in class com.ibm.connector2.cics.AIDKey
PF24 key
PF24 - Static variable in class com.ibm.ctg.epi.AID
PF24 key.
PF3 - Static variable in class com.ibm.connector2.cics.AIDKey
PF3 key
PF3 - Static variable in class com.ibm.ctg.epi.AID
PF3 key.
PF4 - Static variable in class com.ibm.connector2.cics.AIDKey
PF4 key
PF4 - Static variable in class com.ibm.ctg.epi.AID
PF4 key.
PF5 - Static variable in class com.ibm.connector2.cics.AIDKey
PF5 key
PF5 - Static variable in class com.ibm.ctg.epi.AID
PF5 key.
PF6 - Static variable in class com.ibm.connector2.cics.AIDKey
PF6 key
PF6 - Static variable in class com.ibm.ctg.epi.AID
PF6 key.
PF7 - Static variable in class com.ibm.connector2.cics.AIDKey
PF7 key
PF7 - Static variable in class com.ibm.ctg.epi.AID
PF7 key.
PF8 - Static variable in class com.ibm.connector2.cics.AIDKey
PF8 key
PF8 - Static variable in class com.ibm.ctg.epi.AID
PF8 key.
PF9 - Static variable in class com.ibm.connector2.cics.AIDKey
PF9 key
PF9 - Static variable in class com.ibm.ctg.epi.AID
PF9 key.
pink - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color pink.
pink - Static variable in class com.ibm.ctg.epi.Field
The color pink.
Program - Variable in class com.ibm.ctg.client.ECIRequest
Program to invoke on CICS server.
PROTOCOL_VERSION - Static variable in class com.ibm.ctg.client.stats.ResponseData
The version of the information returned to the client.
purgeTerminal() - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_PURGE_TERMINAL.
purgeTerminal(int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_PURGE_TERMINAL and also sets the termIndex associated with this object.
purple - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color purple.
purple - Static variable in class com.ibm.ctg.epi.Field
The color purple.
put(Object, Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Adds a Container to the Channel
putAll(Map) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Puts a group of Containers in a Channel

Q

queryATI() - Method in class com.ibm.ctg.epi.EPITerminal
Determines whether ATI is currently enabled for this terminal.
queryATI() - Method in class com.ibm.ctg.epi.Terminal
Returns a boolean indicating whether the terminal ATI state is enabled or disabled.
queryATI() - Method in interface com.ibm.ctg.epi.TerminalSession
Returns a boolean indicating whether the terminal ATI state is enabled or disabled.

R

RACFUserid - Class in com.ibm.ctg.util
This class is a CICS Transaction Gateway for OS/390 utility.
RACFUserid() - Constructor for class com.ibm.ctg.util.RACFUserid
Constructs a default RACFUserid object.
RACFUserid(byte[]) - Constructor for class com.ibm.ctg.util.RACFUserid
Constructs a RACFUserid object and sets its internal data members with an X.509 certificate.
RAS_TRACE_ENTRY_EXIT - Static variable in interface com.ibm.connector2.cics.CICSLogTraceLevels
Output method entry and exit trace lines.
RAS_TRACE_ERROR_EXCEPTION - Static variable in interface com.ibm.connector2.cics.CICSLogTraceLevels
Output exception stack traces.
RAS_TRACE_INTERNAL - Static variable in interface com.ibm.connector2.cics.CICSLogTraceLevels
Output debug trace entries.
RAS_TRACE_OFF - Static variable in interface com.ibm.connector2.cics.CICSLogTraceLevels
Disable all tracing.
rcLookup - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
 
readTimeout - Variable in class com.ibm.ctg.client.EPIRequest
Terminal Read Timeout.
receiveHandshake(byte[], InetAddress) - Method in interface com.ibm.ctg.security.JSSEServerSecurity
This method is called in response to the initial client-to-Gateway handshake flow, that is the handshake returned by its partner ClientSecurity instance's generateHandshake method.
receiveHandshake(byte[], InetAddress) - Method in interface com.ibm.ctg.security.ServerSecurity
This method is called in response to the initial client-to-Gateway handshake flow, that is the handshake returned by its partner ClientSecurity instance's generateHandshake method.
red - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color red.
red - Static variable in class com.ibm.ctg.epi.Field
The color red.
remove(Object) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Removes a Container from the Channel
removePropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Removes a PropertyChangeListener.
removePropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Removes a PropertyChangeListener.
removePropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Removes a PropertyChangeListener.
removePropertyChangeListener(PropertyChangeListener) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Remove a registered listener from the list.
removeScreenEventListener(ScreenEventListener) - Method in class com.ibm.ctg.epi.ScreenHandler
Remove this ScreenEventListener from the internal list.
removeTerminalEventListener(TerminalEventListener) - Method in class com.ibm.ctg.epi.EPITerminal
Removes a TerminalEventListener from the list of screen handlers.
repliedHandshake(byte[]) - Method in interface com.ibm.ctg.security.ClientSecurity
This method is called in response to the replied Gateway-to-client handshake flow, that is the handshake returned by its partner ServerSecurity instance's receiveHandshake method.
RequestCallType - Enum in com.ibm.ctg.ha
An enumeration of the request types that can be seen by a CICS request exit, allowing the exit to select a CICS server based on the type of request being flowed.
RequestData - Enum in com.ibm.ctg.monitoring
This enumeration defines the data passed to the RequestExit eventFired() method.
RequestDetails - Enum in com.ibm.ctg.ha
The RequestDetails enum contains the definitions of the data that is passed through to the CICSRequestExit getCICSServer() method.
RequestEvent - Enum in com.ibm.ctg.monitoring
This enumeration defines the event that triggers the eventFired() method of the RequestExit.
RequestExit - Interface in com.ibm.ctg.monitoring
All implementations of CICS Transaction Gateway RequestExit monitoring classes must implement the RequestExit interface.
RequestPayloadType - Enum in com.ibm.ctg.ha
An enumeration of the ECI payload types.
RequestType - Enum in com.ibm.ctg.monitoring
Flows on a request can carry different types of work.
resetDataTag() - Method in class com.ibm.ctg.epi.Field
Resets the Modified Data Tag (MDT) to unmodified.
ResponseData - Class in com.ibm.ctg.client.stats
Return values for statistic requests.
ResponseData() - Constructor for class com.ibm.ctg.client.stats.ResponseData
 
reverseHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Reverse highlight.
reverseHlt - Static variable in class com.ibm.ctg.epi.Field
Reverse highlight.
rollback() - Method in class com.ibm.connector2.cics.CCILocalTransaction
Reverts the state of the CICS Server to that before begin() was called.
row - Variable in class com.ibm.ctg.epi.FieldData
The row at which the field starts within the map.
row - Variable in class com.ibm.ctg.epi.MapData
The row at which the map starts.

S

Screen - Class in com.ibm.ctg.epi
This class represents a 3270 terminal screen and provides methods to query and set screen information.
ScreenEvent - Class in com.ibm.ctg.epi
This event is raised by ScreenHandler.
ScreenEvent(Object, ScreenHandler) - Constructor for class com.ibm.ctg.epi.ScreenEvent
Construct a screen event.
ScreenEventListener - Interface in com.ibm.ctg.epi
This interface defines the events that can be raised by ScreenHandler.
ScreenException - Exception in com.ibm.connector2.screen
This exception is thrown to indicate that a failure occurs while working with a Screen Record.
ScreenException() - Constructor for exception com.ibm.connector2.screen.ScreenException
Constructs a ScreenException with no detail message.
ScreenException(String) - Constructor for exception com.ibm.connector2.screen.ScreenException
Constructs a ScreenException with the specified detail message.
screenHandled(ScreenEvent) - Method in interface com.ibm.ctg.epi.ScreenEventListener
The screen handler has begun handling screens.
ScreenHandler - Class in com.ibm.ctg.epi
This class can be used as a base class for screen handlers.
ScreenHandler() - Constructor for class com.ibm.ctg.epi.ScreenHandler
 
screenUnhandled(ScreenEvent) - Method in interface com.ibm.ctg.epi.ScreenEventListener
The screen handler is no longer handling screens.
send() - Method in class com.ibm.ctg.epi.EPITerminal
Sends the current screen to CICS.
send(String, String) - Method in class com.ibm.ctg.epi.EPITerminal
Starts a new transaction.
send() - Method in class com.ibm.ctg.epi.ScreenHandler
Send the screen to CICS.
send(Session, String, String) - Method in class com.ibm.ctg.epi.Terminal
Starts a transaction on the server.
send(String, String) - Method in class com.ibm.ctg.epi.Terminal
Starts a transaction on the server using the current session.
send(Session) - Method in class com.ibm.ctg.epi.Terminal
Sends the current screen to the server.
send() - Method in class com.ibm.ctg.epi.Terminal
Sends the current screen to the server using the current session.
send(Session, String, String) - Method in interface com.ibm.ctg.epi.TerminalInterface
Sends the current screen to the server.
send(Session) - Method in interface com.ibm.ctg.epi.TerminalInterface
Sends the current screen to the server.
send(String, String) - Method in interface com.ibm.ctg.epi.TerminalSession
Starts a transaction on the server using the current Session.
send() - Method in interface com.ibm.ctg.epi.TerminalSession
Sends the current screen to the server using the current Session.
sendReply(byte[], int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_REPLY and also sets the data and size associated with this object.
sendReply(int, byte[], int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_REPLY and also sets the termIndex, data and size associated with this object.
Server - Variable in class com.ibm.ctg.client.ECIRequest
CICS server to direct request to.
Server - Variable in class com.ibm.ctg.client.EPIRequest
CICS server to use (or which are using).
server - Static variable in interface com.ibm.ctg.epi.TerminalSession
Terminal waiting for server.
serverCount() - Method in class com.ibm.ctg.epi.EPIGateway
Returns the number of servers available for use.
serverDesc(int) - Method in class com.ibm.ctg.epi.EPIGateway
Returns the description of the server at the specified index in the list of available servers.
serverName(int) - Method in class com.ibm.ctg.epi.EPIGateway
Returns the name of the server at the specified index in the list of available servers.
ServerSecurity - Interface in com.ibm.ctg.security
All implementations of CICS Transaction Gateway server-side security classes must implement the ServerSecurity interface.
Session - Interface in com.ibm.ctg.epi
An object that implements the Session interface can be passed to the Terminal send method.
setAddress(String) - Method in class com.ibm.ctg.client.JavaGateway
Set the address of the CICS Transaction Gateway that this JavaGateway instance connects to.
setAID(AID) - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Sets the AID property.
setAID(AID) - Method in class com.ibm.ctg.epi.Screen
Sets the AID that will be sent back to the server.
setAID(AID) - Method in class com.ibm.ctg.epi.ScreenHandler
Set the AID.
setApplid(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the applid for this connection.
setApplidQualifier(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the applid qualifier for this connection.
setATI(boolean) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the Terminal ATI state.
setATI(boolean) - Method in class com.ibm.ctg.epi.Terminal
Sets the terminal ATI state to be enabled or disabled.
setATI(boolean) - Method in interface com.ibm.ctg.epi.TerminalSession
Sets the terminal ATI state to be enabled or disabled.
setAutoMsgQual(boolean) - Method in class com.ibm.ctg.client.ECIRequest
Allows you to turn on or off the Automatic Message Qualifier generation facility.
setBaseAttribute(char) - Method in class com.ibm.ctg.epi.Field
Sets the 3270 base attribute.
setBITData(byte[]) - Method in interface com.ibm.ctg.client.Container
Puts binary data into a BIT container.
setBytes(int, byte[], int) - Method in class com.ibm.ctg.epi.Field
Deprecated. This Method is not recommended for use as extreme care is required To ensure that the bytes are in the correct encoding and the buffer address and length are exactly correct. You should use setText instead to ensure correct field manipulation.
setCallback(Callbackable) - Method in class com.ibm.ctg.client.ECIRequest
Sets the Callbackable object associated with this ECIRequest object.
setCallback(Callbackable) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Callbackable object associated with this object.
setCCSID(int) - Method in class com.ibm.ctg.client.Channel
Sets the CCSID of the channel
setCertificate(byte[]) - Method in class com.ibm.ctg.util.RACFUserid
Sets the X.509 certificate data.
setChannel(Channel) - Method in class com.ibm.ctg.client.ECIRequest
Sets the Channel associated with the request.
setCHARData(String) - Method in interface com.ibm.ctg.client.Container
Puts character data into a CHAR container.
setCipherSuites(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the cipher suites a SSL connection is able to use.
setClientSecurity(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the client security class name to be used.
setCommareaInboundLength(boolean) - Method in class com.ibm.ctg.client.ECIRequest
This method controls how much of the Commarea, (associated with this ECIRequest object), will be returned by the CICS Transaction Gateway.
setCommareaInboundLength(int) - Method in class com.ibm.ctg.client.ECIRequest
This method controls how much of the Commarea, (associated with this ECIRequest object), will be flowed from the CICS Transaction Gateway.
setCommareaLength(int) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for commareaLength.
setCommareaOutboundLength(boolean) - Method in class com.ibm.ctg.client.ECIRequest
This method controls how much of the Commarea, (associated with this ECIRequest object), will be flowed to the CICS Transaction Gateway.
setCommareaOutboundLength(int) - Method in class com.ibm.ctg.client.ECIRequest
This method controls how much of the Commarea, (associated with this ECIRequest object), will be flowed to the CICS Transaction Gateway.
setConnectionURL(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the CTG gateway URL.
setCurrentPassword(String) - Method in class com.ibm.ctg.client.ESIRequest
Set the current password for this object.
setCursor(int, int) - Method in class com.ibm.ctg.epi.Screen
Sets the cursor position.
setCursor(int, int) - Method in class com.ibm.ctg.epi.ScreenHandler
Set the cursor position.
setCursorColumn(int) - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Sets the cursor column property.
setCursorRow(int) - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Sets the cursor row property.
setDebugOn(boolean) - Static method in class com.ibm.ctg.client.T
Turns all tracing on or off.
Note: In addition to activating all trace points setDebugOn switches off dump truncation and dump offsets causing the entire data dump to be output to trace.
setDeviceType(String) - Method in class com.ibm.connector2.cics.EPIConnectionSpec
Set the device type required.
setDeviceType(String) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the device type that terminals created through this factory should use.
setDeviceType(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the device type the terminal should use.
setDumpOffset(int) - Static method in class com.ibm.ctg.client.T
Sets the offset that tracing will start hex dumps of the commarea and data flows from.
setECITimeout(short) - Method in class com.ibm.ctg.client.ECIRequest
This method controls whether there will be an eci_timeout value associated with this ECIRequest object.
setEncoding(String) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the encoding you wish to have the 3270 datastreams converted to and send to the CICS server.
setEncoding(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the Java Encoding associated with the terminal.
setExecuteTimeout(int) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for executeTimeout.
setExtAttribute(char, char) - Method in class com.ibm.ctg.epi.Field
Sets an extended 3270 attribute.
setExtendedTerminal(boolean) - Method in class com.ibm.ctg.epi.Terminal
Sets whether this terminal is an extended terminal or not.
setfullDataDumpOn(boolean) - Static method in class com.ibm.ctg.client.T
Turns full commarea tracing on or off.
setFunctionName(String) - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Set the function to be run.
setFunctionName(String) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for function name.
setGateway(JavaGateway) - Method in class com.ibm.ctg.epi.Terminal
Sets the Java Gateway that this terminal should use to connect to the server.
setGateway(JavaGateway) - Method in interface com.ibm.ctg.epi.TerminalInterface
Sets the JavaGateway that this terminal should use to connect to the server.
setGatewayClientSecurity(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the client security class that the CICS Transaction Gateway will use (If the terminal is connected, this change does not affect it).
setGatewayServerSecurity(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the server security class that the CICS Transaction Gateway will use (If the terminal is connected, this change has no effect).
setGatewayURL(String) - Method in class com.ibm.ctg.epi.EPITerminal
Set the URL of the CICS Transaction Gateway to connect to (If already connected, this change has no effect).
setHandled() - Method in class com.ibm.ctg.epi.TerminalEvent
Set the event to be handled.
setInitialFlow(boolean) - Method in class com.ibm.ctg.client.JavaGateway
When a JavaGateway instance connects to a remote Gateway, an initial flow takes place.
setInstallTimeout(Integer) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the install timeout.
setInstallTimeout(int) - Method in class com.ibm.ctg.epi.Terminal
Sets the install timeout associated with the terminal.
setInteractionVerb(int) - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Sets the interactionVerb property (int) value.
setInteractionVerb(int) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for interaction verb.
setInterceptPlugin(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Sets the name of the GatewayIntercept plugin class for this managed connection factory.
setJNITFile(int, String) - Static method in class com.ibm.ctg.client.T
Set the JNI trace file.
setJNITrace(int) - Static method in class com.ibm.ctg.client.T
Enables or disables JNI tracing.
setKeyRing(String, String) - Static method in class com.ibm.ctg.client.SslJavaGateway
Deprecated. As of v6.0, deprecated in favour of JavaGateway.setProtocolProperties(Properties)
setKeyRingClass(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the key ring class name to use (applicable and mandatory for SSL protocol(s)).
setKeyRingPassword(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the key ring password to use (applicable and mandatory for SSL protocol).
setLogonLogoffClass(String) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the logonLogoff class to be instantiated and called if a signon capable or signon unknown terminal is created.
setLogWriter(PrintWriter) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the log writer to be used by this object.
setMessageQualifier(int) - Method in class com.ibm.ctg.client.ECIRequest
Sets the Message Qualifier associated with this request.
setModified(boolean) - Method in interface com.ibm.connector2.screen.IFieldAttrInfo
Method to change the Modified Data tag for a field, ie to indicate it has been modified.
setNetName(String) - Method in class com.ibm.connector2.cics.EPIConnectionSpec
Set the net name required.
setNetName(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the netname that terminal should use.
setNetworkProtocol(String) - Static method in class com.ibm.ctg.client.AutoJavaGateway
This method sets the protocol used when an automatic JavaGateway object determines that a network JavaGateway object is required.
setNewPassword(String) - Method in class com.ibm.ctg.client.ESIRequest
Set the new password for this object.
setOn(boolean) - Static method in class com.ibm.ctg.client.T
Turns product tracing on or off
setOutput(PrintStream) - Static method in class com.ibm.ctg.client.T
Sets the PrintStream object that the extra tracing messages are sent to.
setOutputAttributeType(int) - Method in class com.ibm.connector2.cics.EPIInteractionSpec
Sets the outputAttributeType (int) value.
setPassword(String) - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Sets the password for this connection spec.
setPassword(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the password for this connection.
setPassword(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the password associated with the terminal.
setPassword(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the password associated with the terminal.
setPassword(String) - Method in interface com.ibm.ctg.epi.TerminalSession
Sets the password associated with the terminal.
setPort(int) - Method in class com.ibm.ctg.client.JavaGateway
Sets the port of the CICS Transaction Gateway that this JavaGateway instance connects to.
setPortNumber(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the port to communicate with the CTG on.
setProtocol(String) - Method in class com.ibm.ctg.client.JavaGateway
Set the protocol that this JavaGateway will use to connect to the CICS Transaction Gateway.
setProtocolProperties(Properties) - Method in class com.ibm.ctg.client.JavaGateway
Sets the protocol specific properties for this JavaGateway.
setPurgeOnDisconnect(boolean) - Method in class com.ibm.ctg.epi.Terminal
Sets whether a terminal will purge on disconnect or not.
setReadTimeout(Integer) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the read timeout.
setReadTimeout(int) - Method in class com.ibm.ctg.epi.Terminal
Sets the read timeout associated with the terminal.
setRecordName(String) - Method in class com.ibm.connector2.cics.ECIChannelRecord
This method does not change the record name.
setRecordShortDescription(String) - Method in class com.ibm.connector2.cics.ECIChannelRecord
Sets a short record description.
setReference(Reference) - Method in class com.ibm.connector2.cics.CICSConnectionFactory
Sets the reference instance.
setReplyLength(int) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for replyLength.
setRequestExits(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the requestExits for this connection.
setRequestExits(String) - Method in class com.ibm.ctg.client.JavaGateway
Set the RequestExit monitors that will be enabled when the open() method is called on this object.
setResourceAdapter(ResourceAdapter) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
 
setResults(GatewayRequest) - Method in interface com.ibm.ctg.client.Callbackable
This method is called prior to a Callbackable object being run.
setScreen(Screen) - Method in class com.ibm.ctg.epi.Map
Sets the screen associated with this map and check if it is valid.
setScreenId(String) - Method in interface com.ibm.connector2.screen.IScreenable
Set the screen ID.
setSecurity(String, String) - Method in class com.ibm.ctg.client.JavaGateway
Sets the security classes to be used on the client and server sides of this connection.
setServer(String) - Method in class com.ibm.ctg.client.ESIRequest
Sets the server to be used for this object.
setServerName(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the server to connect to (this name must be defined in the CTG config).
setServerName(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the name of the server the terminal should connect to.
setServerSecurity(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the server security class name to be used.
setSession(Session) - Method in class com.ibm.ctg.epi.Terminal
Set the Session object associated with the terminal.
setSession(Session) - Method in interface com.ibm.ctg.epi.TerminalInterface
Sets the Session associated with this terminal.
setSignonCapability(Terminal.EPISignOnType) - Method in class com.ibm.ctg.epi.Terminal
Sets the signon capability associated with the terminal.
setSignonType(Integer) - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Set the sign on type:
0 = Signon Capable
1 = Signon InCapable
setSocketConnectTimeout(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Sets the socket connection timeout value for a connection to CICS TG.
setSocketConnectTimeout(int) - Method in class com.ibm.ctg.client.JavaGateway
Sets the socket connection timeout value for this JavaGateway instance.
setStackOn(boolean) - Static method in class com.ibm.ctg.client.T
Turns stack tracing on or off.
setTerminal(TerminalInterface) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the terminal that will be used to connect to CICS (Disconnect and reconnect for this change to take effect).
setText(String) - Method in interface com.ibm.connector2.cics.EPIFieldRecord
Set the text of the field to the given string.
setText(String) - Method in class com.ibm.ctg.epi.Field
Set the contents of the field to the given String.
setTFile(boolean, String) - Static method in class com.ibm.ctg.client.T
Turns on tracefile option with no wrapping, filename = strTFile.
setTFile(boolean, String, long) - Static method in class com.ibm.ctg.client.T
Turns Tracing on or off.
setTimeout(long) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the terminal timeout.
setTimingOn(boolean) - Static method in class com.ibm.ctg.client.T
Deprecated. 
setTPNName(String) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for TPNName.
setTPNName(String) - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Setter for TPNName.
setTraceLevel(Integer) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the trace level for this managed connection factory and anything it creates.
setTranName(String) - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Setter for tranName.
setTranName(String) - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Setter for tranName.
setTransaction(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the transaction to be started when startTran is called.
setTransactionData(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the parameters to pass when startTran is called.
setTruncationSize(int) - Static method in class com.ibm.ctg.client.T
Sets the size that tracing will truncate hex dumps of the commarea and data flows.
Note: the setDebugOn(true) and setfullDataDumpOn(true) API calls disable data dump truncation, and cause entire data blocks to be output to trace.
setURL(String) - Method in class com.ibm.ctg.client.JavaGateway
Sets the protocol, address and port of this JavaGateway by means of a single URL string.
setUserid(String) - Method in class com.ibm.ctg.client.ESIRequest
Set the user ID for this object.
setUserid(String) - Method in class com.ibm.ctg.epi.EPITerminal
Sets the userid associated with the terminal.
setUserid(String) - Method in class com.ibm.ctg.epi.Terminal
Sets the user ID associated with the terminal.
setUserid(String) - Method in interface com.ibm.ctg.epi.TerminalSession
Sets the userid associated with the terminal.
setUserName(String) - Method in class com.ibm.connector2.cics.CICSConnectionSpec
Sets the username for this connection spec.
setUserName(String) - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Set the username for this connection.
signonCapability - Variable in class com.ibm.ctg.client.EPIRequest
Signon capability of the terminal.
size() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns the number of Containers in the Channel
size - Variable in class com.ibm.ctg.client.EPIRequest
Total length of the 3270 datastream from the CICS server.
size() - Method in class com.ibm.ctg.client.stats.IdResultSet
Returns the number of IdData items that are in this IdResultSet
size() - Method in class com.ibm.ctg.client.stats.StatResultSet
Returns the number of StatData items that are in this ResultSet.
SSL_PROP_CIPHER_SUITES - Static variable in class com.ibm.ctg.client.JavaGateway
SSL protocol cipher suites property.
SSL_PROP_KEYRING_CLASS - Static variable in class com.ibm.ctg.client.JavaGateway
SSL protocol key ring class or keystore property.
SSL_PROP_KEYRING_PW - Static variable in class com.ibm.ctg.client.JavaGateway
SSL protocol key ring or keystore password property.
SslJavaGateway - Class in com.ibm.ctg.client
This class manages the connection between a program and a CICS Transaction Gateway.
start - Static variable in interface com.ibm.ctg.epi.TerminalSession
Terminal starting.
startTran(String, byte[], int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_START_TRAN and also sets the Transid, data and size associated with this object.
startTran(int, String, byte[], int) - Method in class com.ibm.ctg.client.EPIRequest
Sets the Call_Type of this object to EPI_START_TRAN and also sets the termIndex, Transid, data and size associated with this object.
startTran() - Method in class com.ibm.ctg.epi.EPITerminal
Starts a transaction on the terminal, using the current transaction ID and data.
StatData - Class in com.ibm.ctg.client.stats
This class is a representation of a single statistic ID and value pair.
StatResultSet - Class in com.ibm.ctg.client.stats
This is a collection of StatData objects returned from a statistics request made through a GatewayConnection.
stringClientStatus(int) - Method in class com.ibm.ctg.client.ECIRequest
This method takes an int representing the status of the Client i.e.
stringConnectionType(int) - Method in class com.ibm.ctg.client.ECIRequest
This method takes an int representing the status of the Connection, that is, the ConnectionType, and returns a String describing the ConnectionType.
stringServerStatus(int) - Method in class com.ibm.ctg.client.ECIRequest
This method takes an int representing the status of the Server, this is, the CicsServerStatus, and returns a String describing the ServerStatus.
strINVALID_END_REASON - Static variable in interface com.ibm.ctg.client.EPIEndReasonCodes
 
strINVALID_GATEWAY_RC - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
 
SUCCESSFUL_QUERY - Static variable in class com.ibm.ctg.client.stats.ResponseData
Successful return code used by StatController and StatCollector
supportsExecuteWithInputAndOutputRecord() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns whether this resource adapter supports execute with both input and output records supplied.
supportsExecuteWithInputRecordOnly() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns whether this resource adapter supports execute with input record only returning a newly created output record.
supportsHighlighting() - Method in interface com.ibm.connector2.screen.IScreenInfo
Returns whether a screen supports extended highlighting
supportsLocalTransactionDemarcation() - Method in class com.ibm.connector2.cics.CICSResourceAdapterMetaData
Returns whether the adapter supports local transaction demarcation.
sync - Static variable in interface com.ibm.ctg.epi.Session
Synchronous EPI calls (the default).
SystemList - Variable in class com.ibm.ctg.client.ECIRequest
List of known systems and system descriptions following a listSystems() call.
SystemList - Variable in class com.ibm.ctg.client.EPIRequest
Vector of CICS servers and their descriptions: 1st element is server, 2nd element is description, etc.

T

T - Class in com.ibm.ctg.client
This class controls the CICS Transaction Gateway trace.
tags - Static variable in class com.ibm.ctg.epi.AID
Array of String names of AID values.
TERM_ERROR_BASE - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Terminal specific error codes.
TERM_ERROR_DEL_FAILED - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Terminal failed to delete.
TERM_ERROR_INTERNAL - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Internal error occurred.
TERM_ERROR_INVALID_STATE - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Terminal state invalid for attempted action.
TERM_ERROR_JGATE_NULL - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
No JavaGateway or EPIGateway instance has been associated with this terminal.
TERM_ERROR_NO_EQUIV_CCSID - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
No equivalent CCSid found for encoding.
TERM_ERROR_NOT_EXTENDED - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Terminal defined cannot use these enhanced connect methods.
TERM_ERROR_NULL_TRANSID - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Null transaction ID supplied.
TERM_ERROR_TOO_MUCH_DATA - Static variable in interface com.ibm.ctg.epi.TerminalReturnCodes
Too much data returned from CICS.
termID - Variable in class com.ibm.ctg.client.EPIRequest
The name of the terminal resource.
Terminal - Class in com.ibm.ctg.epi
This class represents an EPI terminal.
Terminal() - Constructor for class com.ibm.ctg.epi.Terminal
Constructs a terminal which must be connected to a Java Gateway before it can be used.
Terminal(JavaGateway, String, String, String) - Constructor for class com.ibm.ctg.epi.Terminal
Constructs a basic terminal to the given server using the given gateway and automatically connects the terminal.
Terminal(JavaGateway, String, String, String, Terminal.EPISignOnType, String, String, int, String) - Constructor for class com.ibm.ctg.epi.Terminal
Constructs an extended terminal to the given server using the given gateway which must be connected to explicitly before it can be used.
Terminal.EPISignOnType - Class in com.ibm.ctg.epi
Class to allow for compile time checking of signon enumerations.
terminalConnected(TerminalEvent) - Method in class com.ibm.ctg.epi.ScreenHandler
Handles a terminal connect event.
terminalConnected(TerminalEvent) - Method in interface com.ibm.ctg.epi.TerminalEventListener
The terminal has connected to CICS.
terminalDisconnected(TerminalEvent) - Method in class com.ibm.ctg.epi.ScreenHandler
Handles a terminal disconnect event.
terminalDisconnected(TerminalEvent) - Method in interface com.ibm.ctg.epi.TerminalEventListener
The terminal has disconnected from CICS.
TerminalEvent - Class in com.ibm.ctg.epi
This event is raised by the EPITerminal bean when the terminal connects or disconnects, when a new screen is received from the server, or when an exception occurs.
TerminalEvent(Object, TerminalSession) - Constructor for class com.ibm.ctg.epi.TerminalEvent
Construct a terminal event.
TerminalEvent(Object, TerminalSession, int) - Constructor for class com.ibm.ctg.epi.TerminalEvent
Construct a terminal event.
TerminalEvent(Object, TerminalSession, Exception) - Constructor for class com.ibm.ctg.epi.TerminalEvent
Construct a terminal exception event.
TerminalEventListener - Interface in com.ibm.ctg.epi
This interface can be implemented by classes that want to be informed about terminal events.
TerminalException - Exception in com.ibm.ctg.epi
This exception can be thrown by the EPI classes when an error occurs.
TerminalInterface - Interface in com.ibm.ctg.epi
This interface defines the behaviour of a terminal.
TerminalReturnCodes - Interface in com.ibm.ctg.epi
This interface holds terminal specific error codes.
TerminalSession - Interface in com.ibm.ctg.epi
This interface defines the behaviour of a terminal which is in session, ie: has an associated Session object.
terminate() - Method in class com.ibm.ctg.epi.EPITerminal
Waits for the terminal to finish disconnecting and then closes the connection to the CICS Transaction Gateway.
termIndex - Variable in class com.ibm.ctg.client.EPIRequest
The terminal index identifying the terminal resource.
textLength() - Method in class com.ibm.ctg.epi.Field
Returns the number of characters in the field.
TFILE_ERR_CHANGE_WHEN_RUNNING - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
The JNI trace file name cannot be changed while JNI tracing is enabled
TFILE_ERR_DIRECTORY - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
The filename specified is a directory
TFILE_ERR_INVALID_PATH - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
The path or file name is invalid
TFILE_ERR_PERMISSION_DENIED - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
The file permissions do not allow write access
TFILE_ERR_UNKNOWN - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
An unknown error occurred
TFILE_NO_ERROR - Static variable in interface com.ibm.ctg.client.TFileReturnCodes
No error occurred
TFileException - Exception in com.ibm.ctg.client
This exception is thrown by the T class when an error occurs.
TFileException(int) - Constructor for exception com.ibm.ctg.client.TFileException
Creates a new TFileException with a null message and the specified return code.
TFileException(String, int) - Constructor for exception com.ibm.ctg.client.TFileException
Creates a new TFileException with the specified message and return code.
TFileReturnCodes - Interface in com.ibm.ctg.client
Constant values representing return codes reported when a TFileException is thrown.
toString() - Method in class com.ibm.connector2.cics.CICSConnectionFactory
Return a string representation of this instance.
toString() - Method in class com.ibm.connector2.cics.CICSInteractionSpec
Returns a string representation of this instance.
toString() - Method in class com.ibm.connector2.cics.CICSManagedConnectionFactory
Return a string representation of this object.
toString() - Method in class com.ibm.connector2.cics.ECIConnection
Returns a string representation of this instance for use in tracing.
toString() - Method in class com.ibm.connector2.cics.ECIConnectionFactory
Return a String representation of this class.
toString() - Method in class com.ibm.connector2.cics.ECIInteractionSpec
Provides a string representation of this object.
toString() - Method in class com.ibm.connector2.cics.ECIManagedConnectionFactory
Returns a string representation of this object.
toString() - Method in class com.ibm.connector2.cics.EPIConnectionFactory
Return a string representation of this class.
toString() - Method in class com.ibm.connector2.cics.EPIConnectionSpec
Returns a string representation of this instance, in this case it lists the contents of the properties.
toString() - Method in class com.ibm.connector2.cics.EPIInteractionSpec
returns a string representation of this instance, in this case it lists the contents of the write properties.
toString() - Method in class com.ibm.connector2.cics.EPIManagedConnectionFactory
Return a string representation of this class.
toString() - Method in class com.ibm.ctg.client.Channel
Returns a string representation of the channel.
toString() - Method in exception com.ibm.ctg.client.TFileException
Returns a string representation of this exception
toString() - Method in class com.ibm.ctg.epi.AID
Returns a String object representing this AID, for example "enter", "PF3".
toString() - Method in class com.ibm.ctg.epi.FieldData
Returns a String representaion of this FieldData object.
toString() - Method in class com.ibm.ctg.epi.Map
Returns a String representation of the Map.
toString() - Method in class com.ibm.ctg.epi.Terminal.EPISignOnType
Returns a string representation of this EPISignOnType.
toString() - Method in class com.ibm.ctg.monitoring.DistributedIdentity
 
toString() - Method in class com.ibm.ctg.util.OriginData
Returns a string representation of the origin data.
TransactionType - Enum in com.ibm.ctg.monitoring
Flows on a request can be part of different transactions.
Transid - Variable in class com.ibm.ctg.client.ECIRequest
Transaction ID to run CICS program under.
Transid - Variable in class com.ibm.ctg.client.EPIRequest
Transaction to be run on the CICS server.
TransientPayLoad - Interface in com.ibm.ctg.monitoring
Provides a representation of the COMMAREA being passed to or returned from a CICS program call.
transparency() - Method in class com.ibm.ctg.epi.Field
Returns a constant indicating the background transparency of the field.
txnTimedOut - Static variable in interface com.ibm.ctg.epi.TerminalSession
A Transaction has timed out through readtimeout property but the application has not been informed as yet of the exception.

U

underscoreHlt - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
Underscore highlight.
underscoreHlt - Static variable in class com.ibm.ctg.epi.Field
Underscore highlight.
UNKNOWN_ATTR - Static variable in exception com.ibm.ctg.epi.EPIFieldException
Unknown attribute in 3270 datastream.
UNKNOWN_STATGROUPID - Static variable in class com.ibm.ctg.client.stats.ResponseData
The statistic group ID specified on the query was not recognized.
UNKNOWN_STATID - Static variable in class com.ibm.ctg.client.stats.ResponseData
The statistic ID specified on the query was not recognized.
unmodified - Static variable in class com.ibm.ctg.epi.Field
Unmodified field (does not need to be flowed back to the server).
unprotect - Static variable in class com.ibm.ctg.epi.Field
Unprotected field allowing text to be modified.
UNSUPPORTED_DS - Static variable in exception com.ibm.ctg.epi.EPI3270Exception
The DataStream has an unsupported 3270 command.
UNSUPPORTED_ENCODING - Static variable in exception com.ibm.ctg.epi.EPI3270Exception
Cannot convert fields to bytes as Java encoding unsupported.
UPDATE_EXCEPTION - Static variable in class com.ibm.ctg.client.stats.ResponseData
An exception occurred updating the statistic value.
Userid - Variable in class com.ibm.ctg.client.ECIRequest
User ID for CICS server.
userid - Variable in class com.ibm.ctg.client.EPIRequest
User ID associated with the terminal.

V

valueOf(String) - Static method in enum com.ibm.ctg.client.Container.ContainerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.client.GatewayIntercept.InterceptAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.ha.ExitEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.ha.ExitEventData
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.ha.RequestCallType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.ha.RequestDetails
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.ha.RequestPayloadType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.FlowTopology
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.FlowType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.RequestData
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.RequestEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.RequestType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.ctg.monitoring.TransactionType
Returns the enum constant of this type with the specified name.
values() - Method in class com.ibm.connector2.cics.ECIChannelRecord
Returns the contents of all the Containers in the Channel
values() - Static method in enum com.ibm.ctg.client.Container.ContainerType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.client.GatewayIntercept.InterceptAction
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.ha.ExitEvent
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.ha.ExitEventData
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.ha.RequestCallType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.ha.RequestDetails
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.ha.RequestPayloadType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.FlowTopology
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.FlowType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.RequestData
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.RequestEvent
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.RequestType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.ctg.monitoring.TransactionType
Returns an array containing the constants of this enum type, in the order they're declared.
verifyPassword() - Method in class com.ibm.ctg.client.ESIRequest
Sets the ESI request object to be a Verify Password Request.
verifyPassword(String, String, String) - Static method in class com.ibm.ctg.client.ESIRequest
This method returns a new ESI Request object which can be used to invoke a verifyPassword request.
verifyPassword() - Method in class com.ibm.ctg.epi.EPITerminal
Verifies the userid and password with the External Security Manager
verifyPassword() - Method in class com.ibm.ctg.epi.Terminal
Verifies the user ID and password with the External Security Manager.
verifyPassword() - Method in interface com.ibm.ctg.epi.TerminalSession
Verifies the userid and password with the External Security Manager

W

waitState - Variable in class com.ibm.ctg.client.EPIRequest
Input for getEvent() calls (Call_Type = EPI_GET_EVENT).
white - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color white.
white - Static variable in class com.ibm.ctg.epi.Field
The color white.
width - Variable in class com.ibm.ctg.epi.MapData
The map width in columns.
writeLogToTrace(String) - Static method in class com.ibm.ctg.client.T
Write log messages to trace.

X

xorTran - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
XOR transparency.
xorTran - Static variable in class com.ibm.ctg.epi.Field
XOR transparency.

Y

yellow - Static variable in interface com.ibm.connector2.screen.IExtendedAttributes
The color yellow.
yellow - Static variable in class com.ibm.ctg.epi.Field
The color yellow.

A B C D E F G H I J K L M N O P Q R S T U V W X Y
©Copyright IBM Corp. 1994, 2014
Legal