- Call_Type - Variable in class com.ibm.ctg.client.ECIRequest
-
CICS ECI call type.
- Callbackable - Interface in com.ibm.ctg.client
-
The asynchronous model supported by the CICS Transaction Gateway allows the
use of callback objects.
- changePassword() - Method in class com.ibm.ctg.client.ESIRequest
-
Sets the call type of the ESI request to be Change Password.
- changePassword(String, String, String, String) - Static method in class com.ibm.ctg.client.ESIRequest
-
Returns a new ESI Request object that can be used to invoke
a changePassword request.
- 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.
- CicsClientStatus - Variable in class com.ibm.ctg.client.ECIRequest
-
After getStatus()
, shows status of the Client daemon.
- CicsCpRequest - Class in com.ibm.ctg.client
-
This class contains the details of the code page used by the CICS TG.
- CicsCpRequest() - Constructor for class com.ibm.ctg.client.CicsCpRequest
-
Default constructor.
- CicsServerStatus - Variable in class com.ibm.ctg.client.ECIRequest
-
After getStatus()
, shows status of CICS server.
- close() - Method in class com.ibm.ctg.client.JavaGateway
-
Closes the connection to the CICS Transaction Gateway.
- 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.
- com.ibm.ctg.client - package com.ibm.ctg.client
-
Provides 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.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.
- 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.
- ContainerBidiException - Exception in com.ibm.ctg.client.exceptions
-
This exception is thrown if an application attempts to create a
Container
with the Java
system property ctg.bidi.target.layout set to an unknown value.
- ContainerBidiException() - Constructor for exception com.ibm.ctg.client.exceptions.ContainerBidiException
-
Creates a new exception with no message.
- ContainerBidiException(String) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerBidiException
-
Creates a new exception with the specified message.
- ContainerBidiException(Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerBidiException
-
Creates a new exception with the specified cause.
- ContainerBidiException(String, Throwable) - Constructor for exception com.ibm.ctg.client.exceptions.ContainerBidiException
-
Creates a new exception with the specified message and cause.
- 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.
- 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
- 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.
- 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
-
The call was made from a Client daemon callback routine.
- ECI_ERR_CICS_DIED - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
Communication with the target CICS server was interrupted during
the request.
- 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 COMMAREA length.
- ECI_ERR_INVALID_EXTEND_MODE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
- ECI_ERR_INVALID_VERSION - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
Deprecated.
Not returned by the CICS Transaction Gateway Java API.
- ECI_ERR_LUW_TOKEN - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
- ECI_ERR_MAX_SESSIONS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
There are insufficient communication resources to complete the
request.
- ECI_ERR_MAX_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
The CICS TG has reached its limit on the maximum number of CICS
servers.
- ECI_ERR_MORE_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
There are more systems to return than were requested.
- 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
-
Communication with the target CICS server could not be established.
- 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
-
There are insufficient communication resources to communicate with
the target CICS server.
- ECI_ERR_NO_SYSTEMS - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
There are no servers known to the Gateway daemon.
- ECI_ERR_NULL_MESSAGE_ID - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
Deprecated.
Not returned by the CICS Transaction Gateway Java API.
- ECI_ERR_NULL_SEM_HANDLE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
Deprecated.
Not returned by the CICS Transaction Gateway Java API.
- ECI_ERR_NULL_WIN_HANDLE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
Deprecated.
Not returned by the CICS Transaction Gateway Java API.
- ECI_ERR_REQUEST_TIMEOUT - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
- ECI_ERR_RESOURCE_SHORTAGE - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
There are insufficient resources to communicate with the target
CICS server; details might be available in the CICS TG error log
files.
- ECI_ERR_RESPONSE_TIMEOUT - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
The ECI call timed out while waiting for a response.
- 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
CICS 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
-
- ECI_ERR_SYSTEM_ERROR - Static variable in interface com.ibm.ctg.client.ECIReturnCodes
-
An internal system error has 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 target CICS server is unknown to the Gateway daemon.
- 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_REPLY - Static variable in class com.ibm.ctg.client.ECIRequest
-
In local mode, use this call type to get any reply to an asynchronous call.
- ECI_GET_REPLY_WAIT - Static variable in class com.ibm.ctg.client.ECIRequest
-
In local mode, use this call type to await any reply to an asynchronous call.
- 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
-
Deprecated.
The getStatus(String,int,Callbackable) method of ECIRequest should be used to
retrieve immediate asynchronous status information about a CICS server.
- ECI_STATE_CANCEL - Static variable in class com.ibm.ctg.client.ECIRequest
-
Cancel a previous request to be alerted on a state change
- ECI_STATE_CHANGED - Static variable in class com.ibm.ctg.client.ECIRequest
-
Return state information when the CICS Server changes state e.g.
- 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
-
Deprecated.
The getStatus(String) method of ECIRequest should be used to retrieve immediate
synchronous status information about a CICS server.
- 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.
- 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
-
Creates an ECIRequest object with commarea for a simple synchronous call.
- ECIRequest(int, String, String, String, String, String, byte[]) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with commarea for a basic request using
the most commonly used ECI parameters.
- ECIRequest(int, String, String, String, String, String, byte[], int, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with commarea which expands on the basic values
to allow Extended Logical Unit-of-Work requests.
- ECIRequest(int, String, String, String, String, String, byte[], int, int, int, int, Callbackable) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with commarea for ECI asynchronous call types.
- ECIRequest(String, String, String, String, Channel, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with a Channel using the most commonly
used ECI parameters.
- ECIRequest(int, String, String, String, String, String, Channel, int, int) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with a Channel to make Extended Logical
Unit-of-Work requests.
- ECIRequest(int, String, String, String, String, String, Channel, int, int, int, Callbackable) - Constructor for class com.ibm.ctg.client.ECIRequest
-
Creates an ECIRequest object with a Channel for ECI asynchronous call types.
- ECIReturnCodes - Interface in com.ibm.ctg.client
-
Gateway ECI Return codes.
- 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 received 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 a request that changes a password or password phrase.
- ESI_ERR_CALL_FROM_CALLBACK - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
The call was made from a Client daemon callback routine.
- ESI_ERR_CICS_DIED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
Communication with the target CICS server was interrupted during
the request.
- ESI_ERR_MAX_SESSIONS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
There are insufficient communication resources to complete the
request.
- ESI_ERR_MAX_SYSTEMS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
The CICS TG has reached its limit on the maximum number of CICS
servers.
- ESI_ERR_NO_CICS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
Communication with the target CICS server could not be established.
- ESI_ERR_NO_SESSIONS - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
There are insufficient communication resources to communicate with
the target CICS server.
- 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 current 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 or password phrase has expired.
- ESI_ERR_PASSWORD_INVALID - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
The password or password phrase is invalid.
- ESI_ERR_PASSWORD_REJECTED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
The new password or password phrase 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
-
Password Expiry Management is not enabled on the CICS server or the
request was rejected by the active
CICSRequestExit
.
- ESI_ERR_PEM_NOT_SUPPORTED - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
Password Expiry Management is not supported by the CICS server or is
not supported for the protocol used to communicate with the CICS server.
- ESI_ERR_RESOURCE_SHORTAGE - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
There are insufficient resources to communicate with the target
CICS server; details might be available in the CICS TG error log
files.
- 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 has occurred.
- ESI_ERR_UNKNOWN_SERVER - Static variable in interface com.ibm.ctg.client.ESIReturnCodes
-
The target CICS server is unknown to the Gateway daemon.
- 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
-
Deprecated.
This field is deprecated.
The maximum supported password or password phrase length varies by CICS
server and communication protocol. Refer to your CICS server documentation
for details.
- ESI_SYSTEM_MAX - Static variable in class com.ibm.ctg.client.ESIRequest
-
Maximum number of characters in server name.
- 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 a request that verifies a password or password phrase.
- 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
-
The default constructor that leaves all the values set to their defaults.
- ESIReturnCodes - Interface in com.ibm.ctg.client
-
Constant values representing ESI return codes.
- Extend_Mode - Variable in class com.ibm.ctg.client.ECIRequest
-
Extend mode of request.
- 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.
- getAddress() - Method in class com.ibm.ctg.client.JavaGateway
-
Returns the address that this JavaGateway is currently or will be
connected to.
- 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.
- 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.ESIRequest
-
Returns the Call_Type field of the ESI Request as an int.
- 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.ESIRequest
-
Returns the Call_Type field of the ESI Request as a String.
- 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.
- 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.ESIRequest
-
Returns the CICS return code set in this ESI Request as an int.
- 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.ESIRequest
-
Returns the CICS return code set in this ESI Request as a String.
- getClientCp() - Method in class com.ibm.ctg.client.CicsCpRequest
-
Returns the code page of the CICS TG (after the
CicsCpRequest object has been flow
ed to the CICS TG).
- getClientRc() - Method in class com.ibm.ctg.client.CicsCpRequest
-
Gets the CICS TG 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
CICS TG code page request, or "Return Code Out of Range".
- 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
- getCommareaInboundLength() - Method in class com.ibm.ctg.client.ECIRequest
-
This method returns an int, which is the Commarea inbound length.
- getCommareaOutboundLength() - Method in class com.ibm.ctg.client.ECIRequest
-
This method returns an int, which is the Commarea outbound length.
- getConnectionTypeString() - Method in class com.ibm.ctg.client.ECIRequest
-
This method returns a String describing the ConnectionType field of
this ECIRequest object.
- 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
-
Returns the current password or password phrase as a String.
- 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.
- getExpiry() - Method in class com.ibm.ctg.client.ESIRequest
-
Returns the date/time of when the password or password phrase is due to
expire on the server as a java.util.Calendar object.
- 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.
- 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.
- getGwVer() - Method in exception com.ibm.ctg.util.DLLVersionMismatchException
-
Returns the version of the Gateway classes.
- getInboundDataLength() - Method in class com.ibm.ctg.client.ECIRequest
-
This method returns an integer, which is the inbound data length.
- getInvalidCount() - Method in class com.ibm.ctg.client.ESIRequest
-
Returns the number of invalid password
verification attempts for that user ID on the specified server since the
last successful password verification as an int.
- getKeyRing() - Static method in class com.ibm.ctg.client.SslJavaGateway
-
- getLastAccess() - Method in class com.ibm.ctg.client.ESIRequest
-
Returns the date/time of when the user ID was last accessed on the server
as a java.util.Calendar object.
- getLastVerified() - Method in class com.ibm.ctg.client.ESIRequest
-
Returns the date/time of when the user ID credentials were last verified on the server
as a java.util.Calendar object.
- getLocalAddress() - Method in class com.ibm.ctg.client.SslJavaGateway
-
- getMessageQualifier() - Method in class com.ibm.ctg.client.ECIRequest
-
Returns the Message Qualifier associated with this request.
- 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
- 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
-
Returns the new password or password phrase as a String.
- 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.
- 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.
- 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.ESIRequest
-
Returns the return code set in this ESI Request by the Gateway as an int.
- 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.ESIRequest
-
Returns the return code set in this ESI Request as a String.
- 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.
- getServer() - Method in class com.ibm.ctg.client.ESIRequest
-
Returns the server name as a String.
- getServerStatusString() - Method in class com.ibm.ctg.client.ECIRequest
-
This method returns a String describing the CicsServerStatus field of
this ECIRequest object.
- getSocketConnectTimeout() - Method in class com.ibm.ctg.client.JavaGateway
-
Returns the socket connect timeout value for this JavaGateway instance.
- getStatus(String) - Method in class com.ibm.ctg.client.ECIRequest
-
This method creates an ECIRequest object which can be used to find the
current status of a CICS system.
- getStatus(String, int, Callbackable) - Method in class com.ibm.ctg.client.ECIRequest
-
This method creates an ECIRequest object which can be used to find the
current status of a CICS system.
- getType() - Method in interface com.ibm.ctg.client.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
-
Returns the current user ID as a String.
- Server - Variable in class com.ibm.ctg.client.ECIRequest
-
CICS server to direct request to.
- setAddress(String) - Method in class com.ibm.ctg.client.JavaGateway
-
Set the address of the CICS Transaction Gateway that this JavaGateway
instance connects to.
- setAutoMsgQual(boolean) - Method in class com.ibm.ctg.client.ECIRequest
-
Allows you to turn on or off the Automatic Message Qualifier generation
facility.
- setBITData(byte[]) - Method in interface com.ibm.ctg.client.Container
-
Puts binary data into a
BIT
container.
- setCallback(Callbackable) - Method in class com.ibm.ctg.client.ECIRequest
-
Sets the Callbackable object associated with this ECIRequest object.
- setCCSID(int) - Method in class com.ibm.ctg.client.Channel
-
Sets the CCSID of the channel
- 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.
- 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.
- 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.
- setCurrentPassword(String) - Method in class com.ibm.ctg.client.ESIRequest
-
Sets the current password or password phrase for the ESI Request.
- setDebugOn(boolean) - Static method in class com.ibm.ctg.client.T
-
Turns all levels of 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.
- 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.
- setfullDataDumpOn(boolean) - Static method in class com.ibm.ctg.client.T
-
Turns full commarea tracing on or off.
- setInitialFlow(boolean) - Method in class com.ibm.ctg.client.JavaGateway
-
When a JavaGateway instance connects to a remote Gateway, an initial
flow takes place.
- 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
-
- setMessageQualifier(int) - Method in class com.ibm.ctg.client.ECIRequest
-
Sets the Message Qualifier associated with this request.
- 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
-
Sets the new password or password phrase for the ESI Request.
- 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.
- setPort(int) - Method in class com.ibm.ctg.client.JavaGateway
-
Sets the port of the CICS Transaction Gateway that this JavaGateway
instance connects to.
- 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.
- 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.
- setResults(GatewayRequest) - Method in interface com.ibm.ctg.client.Callbackable
-
This method is called prior to a Callbackable object being run.
- 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 name to be used for this ESI Request.
- 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.
- 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.
- setTimingOn(boolean) - Static method in class com.ibm.ctg.client.T
-
Deprecated.
- 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
-
Sets the user ID for the ESI request.
- 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.
- 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_GATEWAY_RC - Static variable in interface com.ibm.ctg.client.GatewayReturnCodes
-
- SystemList - Variable in class com.ibm.ctg.client.ECIRequest
-