CICS® Transaction Gateway Programming Reference V3.1

com.ibm.ctg.client
Class EPIRequest

java.lang.Object
  |
  +--com.ibm.ctg.client.GatewayRequest
        |
        +--com.ibm.ctg.client.EPIRequest

public class EPIRequest
extends GatewayRequest

This class contains the details of an EPI request to the CICS Transaction Gateway. To execute the request, the EPIRequest object should be flowed to the Gateway using the JavaGateway.flow method.

NOTE: It should not be necessary to initialize the EPI since this is a done by the Gateway Server. However, in the Open Systems environment it is possible that the Gateway's DCE credentials have expired. In this case it is necessary to re-establish the EPI environment (and add any required terminal resources again).

NOTE: It is illegal to attempt to terminate the EPI, since this is done when the Gateway itself terminates.

See Also:
GatewayRequest

Field Summary
 java.lang.String Abend_Code
          Deprecated. The Abend code field is not used, and only remains here for backward compatability
 int addtype
          Way to Add a terminal EPI_ADD_SYNC for Synchronous, EPI_ADD_ASYNC for ASynchronous
 int atiState
          Input and Output field for atiState() calls (Call_Type = EPI_ATI_STATE)
 int Call_Type
          Type of EPI Call
 int cause
          Deprecated. This will always be 0.
 int CCSid
          Terminal Code page
 int Cics_Rc
          CICS return code
 int color
          1 = terminal resource supports color; else 0
 byte[] data
          CICS 3270 data stream in byte array
 java.lang.String deviceType
          CICS model terminal name - defined in CICS Server environment
 int endReason
          Reason why the terminal resource was deleted
 int endReturnCode
          The Return code for END_TRAN and ADD_TERM events
static int EPI_ABEND_MAX
          Max length of CICS abend code
static int EPI_ADD_ASYNC
          Add Terminal Asynchronously
static int EPI_ADD_EX_TERMINAL
          Install an extended terminal resource
static int EPI_ADD_SYNC
          Add Terminal Synchronously
static int EPI_ADD_TERMINAL
          Install a terminal resource
static int EPI_ATI_HOLD
          Hold ATI requests and return the previous ATI state
static int EPI_ATI_ON
          Allow ATI requests and return the previous ATI state
static int EPI_ATI_QUERY
          Return the current ATI state
static int EPI_ATI_STATE
          Change or get the ATI state of a terminal resource
static int EPI_COLOR
          Terminal resource supports color
static int EPI_DEL_TERMINAL
          Delete a terminal resource
static int EPI_DESCRIPTION_MAX
          Max length of CICS Server description
static int EPI_DEVTYPE_MAX
          Max length of model terminal definition
static int EPI_END_FAILED
          An attempt to delete a terminal resource failed
static int EPI_END_OUTSERVICE
          The terminal resource is out of service
static int EPI_END_SHUTDOWN
          The CICS server is shutting down
static int EPI_END_SIGNOFF
          The Terminal resource was signed off (for example because of delTerminal)
static int EPI_END_UNKNOWN
          An unexpected error has occurred
static int EPI_ERR_ABENDED
          A Read Timeout occurred for the current Txn.
static int EPI_ERR_ADDTYPE_INVALID
          The Terminal Add type was invalid (in CICS Client)
static int EPI_ERR_ALREADY_INSTALLED
          Already Installed
static int EPI_ERR_ATI_ACTIVE
          An ATI transaction is already active
static int EPI_ERR_ATI_STATE
          Invalid atiState provided
static int EPI_ERR_BAD_INDEX
          Invalid termIndex
static int EPI_ERR_CCSID_INVALID
          The CCSid supplied was invalid
static int EPI_ERR_FAILED
          The function failed for an unexpected reason
static int EPI_ERR_IN_CALLBACK
          On the CICS client, the call was made from a callback routine
static int EPI_ERR_IS_INIT
          The EPI is already initialized
static int EPI_ERR_MAX_SESSIONS
          Not enough communication resources to satisfy request
static int EPI_ERR_MAX_SYSTEMS
          Reached limit on maxmimum number of systems
static int EPI_ERR_MAX_TERMS
          Max number of terminals reached
static int EPI_ERR_MODELID_INVALID
          The Model id was invalid
static int EPI_ERR_MORE_DATA
          getEvent supplied data array too small, data has been truncated
static int EPI_ERR_MORE_EVENTS
          There are more events outstanding
static int EPI_ERR_MORE_SYSTEMS
          Insufficient space for Server list
static int EPI_ERR_NO_CICS
          No CICS system Available
static int EPI_ERR_NO_CONVERSE
          No reply expected by the terminal resource
static int EPI_ERR_NO_DATA
          No reply data was provided
static int EPI_ERR_NO_EVENT
          There are no events outstanding
static int EPI_ERR_NO_SYSTEMS
          No CICS Servers can be located
static int EPI_ERR_NOT_3270_DEVICE
          Not a 3270 Device
static int EPI_ERR_NOT_INIT
          The EPI environment has not been initialized
static int EPI_ERR_NULL_PARM
          termIndex was null (in CICS Client)
static int EPI_ERR_NULL_PASSWORD
          The Password was NULL
static int EPI_ERR_NULL_USERID
          The Userid was NULL
static int EPI_ERR_PASSWORD_INVALID
          The Password was invalid
static int EPI_ERR_RESOURCE_SHORTAGE
          Resource Shortage, eg not enough SNA sessions
static int EPI_ERR_RESPONSE_TIMEOUT
          The Terminal Did not install within the given timeout
static int EPI_ERR_SECURITY
          Server security error
static int EPI_ERR_SENSE_CODE
          An invalid sense code was provided
static int EPI_ERR_SERVER_BUSY
          The CICS Server was too busy to handle the request
static int EPI_ERR_SERVER_DOWN
          The CICS server is not available
static int EPI_ERR_SIGNON_NOT_POSS
          A request for a Signon Capable Terminal was not possible
static int EPI_ERR_SIGNONCAP_INVALID
          The Terminal Signon Capability flag invalid (in CICS Client)
static int EPI_ERR_SYSTEM
          The specified Server is unknown
static int EPI_ERR_TERMID_INVALID
          The requested Terminal id was invalid
static int EPI_ERR_TRAN_ACTIVE
          There is a transaction running against the terminal resource, or there are unprocessed events
static int EPI_ERR_TTI_ACTIVE
          An EPI transaction is already active
static int EPI_ERR_USERID_INVALID
          The Userid supplied was Invalid
static int EPI_ERR_VERSION
          The CICS EPI cannot support the EPI version requested
static int EPI_ERR_WAIT
          Invalid waitState
static int EPI_ERRINTENSIFY
          Terminal displays error messages intensified
static int EPI_ERRLASTLINE
          Terminal displays error messages on last row
static int EPI_ERROR_MAX
          Max length of error text
static int EPI_EVENT_ADD_TERM
          An Add terminal event has been received.
static int EPI_EVENT_CONVERSE
          A transaction is expecting an EPI_REPLY
static int EPI_EVENT_END_TERM
          This terminal resource no longer exists - check endReason value
static int EPI_EVENT_END_TRAN
          A transaction has ended.
static int EPI_EVENT_SEND
          A transaction has sent 3270 data to a terminal resource (no reply is expected)
static int EPI_EVENT_START_ATI
          An ATI transaction has been started against the terminal
static int EPI_GET_EVENT
          Get event information
static int EPI_GET_SYS_ERROR
          Information about EPI_ERR_FAILED
static int EPI_HILIGHT
          Terminal resource supports extended highlighting
static int EPI_INITIALIZE
          Initialize the EPI.
static int EPI_INQUIRE_SYSTEM
          Inquire as to Server on which terminal exists
static int EPI_LIST_SYSTEMS
          List of CICS Servers
static int EPI_MAPNAME_MAX
          Max length of map name
static int EPI_MAPSETNAME_MAX
          Max length of map set name
static int EPI_MIN_TERMINDEX
          Minimum termIndex value
static int EPI_NETNAME_MAX
          Max length of terminal's netName
static int EPI_NOEVENT
          No events returned for this terminal resource
static int EPI_NORMAL
          The function completed normally
static int EPI_NOWAIT
          Return immediately (with Cics_Rc).
static int EPI_PASSWORD_MAX
          Max length of password
static int EPI_PRINTER
          Deprecated. This value will never be received. Left for backward compatability only
static int EPI_PURGE_TERMINAL
          Purge a terminal resource
static int EPI_READTIMEOUT_EXPIRED
          Transaction has timed out as no response given within readtimeout parameter
static int EPI_REPLY
          Send a reply (used after an EPI_EVENT_CONVERSE has been received)
static int EPI_SENSE_CODE
          Send a sense code - Open Systems only
static int EPI_SENSE_OPCHECK
          Errors detected in 3270 datastream
static int EPI_SENSE_REJECT
          Invalid 3270 commands received
static int EPI_SET_SECURITY
          Change the Security for an installed terminal
static int EPI_SIGNON_CAPABLE
          Signon Capable Terminal
static int EPI_SIGNON_INCAPABLE
          Signon Incapable Terminal
static int EPI_SIGNON_UNKNOWN
          Signon Capability unknown
static int EPI_START_TRAN
          Start a transaction
static int EPI_SYSTEM_MAX
          Max length of CICS Server name
static int EPI_TERM_INDEX_NONE
          termIndex not specified.
static int EPI_TERMID_MAX
          Max length of terminal id
static int EPI_TRAN_NO_ERROR
          No error occurred
static int EPI_TRAN_NOT_STARTED
          Transaction failed to start
static int EPI_TRAN_STATE_UNKNOWN
          Transaction state is unknown
static int EPI_TRANSID_MAX
          Max length of CICS Server transaction id
static int EPI_USERID_MAX
          Max length of userid
static int EPI_WAIT
          Wait for the next terminal event to occur
 int errColor
          3270 color attribute used for error messsages
 int errHilight
          3270 highlight attribute used for error messages
 int errIntensify
          1 = error messages displayed intensified, else 0
 int errLastLine
          1 = error messages displayed on last row; else 0
 int event
          Type of event that has completed
 int hilight
          1 = terminal resource supports extended highlighting; else 0
 int installTimeout
          Terminal Install Timeout
 java.lang.String mapName
          The Map name for the transaction (if any)
 java.lang.String mapSetName
          The Map Set name for the transaction (if any)
 int maxData
          Max data that will be sent to the terminal resource
 int maxNumServers
          Max num of CICS Servers about which info is to be returned (input to listSystems() )
 java.lang.String msg
          Deprecated. This will never contain any information
 java.lang.String netName
          Netname - platform dependent
 int numColumns
          Number of columns supported by the terminal resource
 int numLines
          Number of rows supported by the terminal resource
 int numServersKnown
          Num of CICS Servers which are defined (output from listSystems() flow)
 int numServersReturned
          Num of CICS Servers about which info has been returned (output from listSystems() flow)
 java.lang.String password
          Password associated with the terminal
 int printer
          Deprecated. This will always be 0, retained for backward compatability only
 int readTimeout
          Terminal Read Timeout
 int senseCode
          Send 3270 error - Open Systems only
 java.lang.String Server
          CICS Server to use (or which are using)
 int signonCapability
          Signon Capability of the terminal
 int size
          Maximum size of data stream to be returned
 java.util.Vector SystemList
          Vector of CICS servers and their descriptions: 1st element is Server, 2nd element is Desc.
 java.lang.String termID
          Terminal ID
 int termIndex
          Index identifying a terminal resource
 java.lang.String Transid
          Transaction to be run on the CICS Server
 java.lang.String userid
          Userid associated with the terminal
 int value
          Deprecated. This will always be 0.
 int waitState
          Input for getEvent() calls (Call_Type = EPI_GET_EVENT)
 
Fields inherited from class com.ibm.ctg.client.GatewayRequest
ERROR_CONNECTION_FAILED, ERROR_GATEWAY_CLOSED, ERROR_REPLY_MISMATCH, ERROR_UNKNOWN_REQUEST_TYPE, ERROR_WORK_WAS_REFUSED
 
Constructor Summary
EPIRequest()
          Default constructor, which leaves all the values set to their defaults.
EPIRequest(int iCallType)
          Call_Type constructor.
EPIRequest(int iCallType, int itermIndex)
          Call_Type and termIndex constructor.
 
Method Summary
(package private) static void ()
          The purpose of this static initializer is to get the appropriate ResourceBundle class.
static EPIRequest addTerminal(java.lang.String strServer, java.lang.String strNetName, java.lang.String strDeviceType)
          This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddTerminal on the CICS Transaction Gateway.
static EPIRequest addTerminal(java.lang.String strServer, java.lang.String strNetName, java.lang.String strDeviceType, java.lang.String strUserid, java.lang.String strPassword, int iInstallTimeout, int iReadTimeout, int iSignonCapability, int iCCSid)
          This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway.
static EPIRequest addTerminalAsync(java.lang.String strServer, java.lang.String strNetName, java.lang.String strDeviceType, java.lang.String strUserid, java.lang.String strPassword, int iInstallTimeout, int iReadTimeout, int iSignonCapability, int iCCSid)
          This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway.
 void alterSecurity(java.lang.String strUserid, java.lang.String strPassword)
          Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object This method defines a request which allows you to change the userid and password associated with the current terminal installed.
 void alterSecurity(java.lang.String strUserid, java.lang.String strPassword, int iTermIndex)
          Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object This method defines a request which allows you to change the userid and password associated with the current terminal installed.
 void atiState(int iATIState)
          Sets the Call_Type of this object to EPI_ATI_STATE and also sets the atiState associated with this object.
 void atiState(int itermIndex, int iATIState)
          Sets the Call_Type of this object to EPI_ATI_STATE and also sets the termIndex and atiState associated with this object.
 void delTerminal()
          Sets the Call_Type of this object to EPI_DEL_TERMINAL.
 void delTerminal(int itermIndex)
          Sets the Call_Type of this object to EPI_DEL_TERMINAL and also sets the termIndex associated with this object.
 java.lang.String getAddTypeString()
          Gets the add type for an extended Terminal Request for this ojbect and returns it as a string The String returned is the name of the appropriate Java constant e.g.
 int getCallType()
          Returns the Call_Type set in this object
 java.lang.String getCallTypeString()
          Returns the Call_Type set in this object, as a String.
 int getCicsRc()
          Gets the CICS return code set in this object, if there is one.
 java.lang.String getCicsRcString()
          Gets the CICS return code set in this object and returns it as a String.
 int getEndReason()
          returns the End Reason value which is set when an END_TERM event has been received
 java.lang.String getEndReasonString()
          returns the End Reason value as a string, which is set when an END_TERM event has been received The String returned is the name of the appropriate Java constant e.g.
 int getEndReturnCode()
          Gets the Extra CICS return code from an END_TRAN or ADD_TERM event
 java.lang.String getEndReturnCodeString()
          Gets the Extra CICS return code from an END_TRAN or ADD_TERM Event and returns it as a String.
 int getEvent()
          Returns the event set in this object.
 void getEvent(int iwaitState, int isize)
          Sets the Call_Type of this object to EPI_GET_EVENT and also sets the waitState and size associated with this object.
 void getEvent(int itermIndex, int iwaitState, int isize)
          Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, waitState and size associated with this object.
 java.lang.String getEventString()
          Gets the event set in this object and returns it as a String.
 void getEventWithCallback(int isize, Callbackable calBack)
          Sets the Call_Type of this object to EPI_GET_EVENT and also sets the size and Callbackable object associated with this object.
 void getEventWithCallback(int itermIndex, int isize, Callbackable calBack)
          Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, size and Callbackable object associated with this object.
 int getRc()
          Gets the return code set in this object.
 java.lang.String getSignonString()
          Gets the Signon Capability set in this object and return it as a string The String returned is the name of the appropriate Java constant e.g.
 void getSysError()
          Deprecated. This method does nothing. cause and value will always be 0.
 void getSysError(int itermIndex)
          Deprecated. This method does nothing. cause and value will always be 0.
 void inquireSystem()
          Sets the Call_Type of this object to EPI_INQUIRE_STATE.
 void inquireSystem(int itermIndex)
          Sets the Call_Type of this object to EPI_INQUIRE_STATE and also sets the termIndex associated with this object.
 boolean isCallback()
          This method returns a boolean indicating whether there is a Callbackable object associated with this EPIRequest object.
static EPIRequest listSystems(int iNumOfSys)
          This method returns a new EPIRequest object which can be used to effect a CICS_EpiListSystems on the CICS Transaction Gateway.
 void purgeTerminal()
          Sets the Call_Type of this object to EPI_PURGE_TERMINAL.
 void purgeTerminal(int itermIndex)
          Sets the Call_Type of this object to EPI_PURGE_TERMINAL and also sets the termIndex associated with this object.
 void sendReply(byte[] abytdata, int isize)
          Sets the Call_Type of this object to EPI_REPLY and also sets the data and size associated with this object.
 void sendReply(int itermIndex, byte[] abytdata, int isize)
          Sets the Call_Type of this object to EPI_REPLY and also sets the termIndex, data and size associated with this object.
 void setCallback(Callbackable calBack)
          Sets the Callbackable object associated with this object.
 void startTran(int itermIndex, java.lang.String strTransid, byte[] abytdata, int isize)
          Sets the Call_Type of this object to EPI_START_TRAN and also sets the termIndex, Transid, data and size associated with this object.
 void startTran(java.lang.String strTransid, byte[] abytdata, int isize)
          Sets the Call_Type of this object to EPI_START_TRAN and also sets the Transid, data and size associated with this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EPI_INITIALIZE

public static final int EPI_INITIALIZE
Initialize the EPI. This should be done by the Gateway Server

EPI_LIST_SYSTEMS

public static final int EPI_LIST_SYSTEMS
List of CICS Servers

EPI_ADD_TERMINAL

public static final int EPI_ADD_TERMINAL
Install a terminal resource

EPI_INQUIRE_SYSTEM

public static final int EPI_INQUIRE_SYSTEM
Inquire as to Server on which terminal exists

EPI_DEL_TERMINAL

public static final int EPI_DEL_TERMINAL
Delete a terminal resource

EPI_START_TRAN

public static final int EPI_START_TRAN
Start a transaction

EPI_REPLY

public static final int EPI_REPLY
Send a reply (used after an EPI_EVENT_CONVERSE has been received)

EPI_ATI_STATE

public static final int EPI_ATI_STATE
Change or get the ATI state of a terminal resource

EPI_SENSE_CODE

public static final int EPI_SENSE_CODE
Send a sense code - Open Systems only

EPI_GET_EVENT

public static final int EPI_GET_EVENT
Get event information

EPI_GET_SYS_ERROR

public static final int EPI_GET_SYS_ERROR
Information about EPI_ERR_FAILED

EPI_PURGE_TERMINAL

public static final int EPI_PURGE_TERMINAL
Purge a terminal resource

EPI_ADD_EX_TERMINAL

public static final int EPI_ADD_EX_TERMINAL
Install an extended terminal resource

EPI_SET_SECURITY

public static final int EPI_SET_SECURITY
Change the Security for an installed terminal

EPI_SYSTEM_MAX

public static final int EPI_SYSTEM_MAX
Max length of CICS Server name

EPI_DESCRIPTION_MAX

public static final int EPI_DESCRIPTION_MAX
Max length of CICS Server description

EPI_NETNAME_MAX

public static final int EPI_NETNAME_MAX
Max length of terminal's netName

EPI_TRANSID_MAX

public static final int EPI_TRANSID_MAX
Max length of CICS Server transaction id

EPI_ABEND_MAX

public static final int EPI_ABEND_MAX
Max length of CICS abend code

EPI_DEVTYPE_MAX

public static final int EPI_DEVTYPE_MAX
Max length of model terminal definition

EPI_ERROR_MAX

public static final int EPI_ERROR_MAX
Max length of error text

EPI_USERID_MAX

public static final int EPI_USERID_MAX
Max length of userid

EPI_PASSWORD_MAX

public static final int EPI_PASSWORD_MAX
Max length of password

EPI_MAPNAME_MAX

public static final int EPI_MAPNAME_MAX
Max length of map name

EPI_MAPSETNAME_MAX

public static final int EPI_MAPSETNAME_MAX
Max length of map set name

EPI_TERMID_MAX

public static final int EPI_TERMID_MAX
Max length of terminal id

EPI_TERM_INDEX_NONE

public static final int EPI_TERM_INDEX_NONE
termIndex not specified. This is an INVALID value

EPI_MIN_TERMINDEX

public static final int EPI_MIN_TERMINDEX
Minimum termIndex value

EPI_ERRLASTLINE

public static final int EPI_ERRLASTLINE
Terminal displays error messages on last row

EPI_ERRINTENSIFY

public static final int EPI_ERRINTENSIFY
Terminal displays error messages intensified

EPI_HILIGHT

public static final int EPI_HILIGHT
Terminal resource supports extended highlighting

EPI_COLOR

public static final int EPI_COLOR
Terminal resource supports color

EPI_PRINTER

public static final int EPI_PRINTER
Deprecated. This value will never be received. Left for backward compatability only

EPI_NORMAL

public static final int EPI_NORMAL
The function completed normally

EPI_ERR_NOT_INIT

public static final int EPI_ERR_NOT_INIT
The EPI environment has not been initialized

EPI_ERR_BAD_INDEX

public static final int EPI_ERR_BAD_INDEX
Invalid termIndex

EPI_ERR_FAILED

public static final int EPI_ERR_FAILED
The function failed for an unexpected reason

EPI_ERR_VERSION

public static final int EPI_ERR_VERSION
The CICS EPI cannot support the EPI version requested

EPI_ERR_IS_INIT

public static final int EPI_ERR_IS_INIT
The EPI is already initialized

EPI_ERR_NO_SYSTEMS

public static final int EPI_ERR_NO_SYSTEMS
No CICS Servers can be located

EPI_ERR_MORE_SYSTEMS

public static final int EPI_ERR_MORE_SYSTEMS
Insufficient space for Server list

EPI_ERR_MAX_TERMS

public static final int EPI_ERR_MAX_TERMS
Max number of terminals reached

EPI_ERR_SYSTEM

public static final int EPI_ERR_SYSTEM
The specified Server is unknown

EPI_ERR_TRAN_ACTIVE

public static final int EPI_ERR_TRAN_ACTIVE
There is a transaction running against the terminal resource, or there are unprocessed events

EPI_ERR_NO_DATA

public static final int EPI_ERR_NO_DATA
No reply data was provided

EPI_ERR_TTI_ACTIVE

public static final int EPI_ERR_TTI_ACTIVE
An EPI transaction is already active

EPI_ERR_ATI_ACTIVE

public static final int EPI_ERR_ATI_ACTIVE
An ATI transaction is already active

EPI_ERR_NO_CONVERSE

public static final int EPI_ERR_NO_CONVERSE
No reply expected by the terminal resource

EPI_ERR_ATI_STATE

public static final int EPI_ERR_ATI_STATE
Invalid atiState provided

EPI_ERR_NO_EVENT

public static final int EPI_ERR_NO_EVENT
There are no events outstanding

EPI_ERR_MORE_EVENTS

public static final int EPI_ERR_MORE_EVENTS
There are more events outstanding

EPI_ERR_MORE_DATA

public static final int EPI_ERR_MORE_DATA
getEvent supplied data array too small, data has been truncated

EPI_ERR_WAIT

public static final int EPI_ERR_WAIT
Invalid waitState

EPI_ERR_SERVER_DOWN

public static final int EPI_ERR_SERVER_DOWN
The CICS server is not available

EPI_ERR_SENSE_CODE

public static final int EPI_ERR_SENSE_CODE
An invalid sense code was provided

EPI_ERR_SECURITY

public static final int EPI_ERR_SECURITY
Server security error

EPI_ERR_IN_CALLBACK

public static final int EPI_ERR_IN_CALLBACK
On the CICS client, the call was made from a callback routine

EPI_ERR_NULL_PARM

public static final int EPI_ERR_NULL_PARM
termIndex was null (in CICS Client)

EPI_ERR_ADDTYPE_INVALID

public static final int EPI_ERR_ADDTYPE_INVALID
The Terminal Add type was invalid (in CICS Client)

EPI_ERR_SIGNONCAP_INVALID

public static final int EPI_ERR_SIGNONCAP_INVALID
The Terminal Signon Capability flag invalid (in CICS Client)

EPI_ERR_RESPONSE_TIMEOUT

public static final int EPI_ERR_RESPONSE_TIMEOUT
The Terminal Did not install within the given timeout

EPI_ERR_SIGNON_NOT_POSS

public static final int EPI_ERR_SIGNON_NOT_POSS
A request for a Signon Capable Terminal was not possible

EPI_ERR_TERMID_INVALID

public static final int EPI_ERR_TERMID_INVALID
The requested Terminal id was invalid

EPI_ERR_MODELID_INVALID

public static final int EPI_ERR_MODELID_INVALID
The Model id was invalid

EPI_ERR_NOT_3270_DEVICE

public static final int EPI_ERR_NOT_3270_DEVICE
Not a 3270 Device

EPI_ERR_ALREADY_INSTALLED

public static final int EPI_ERR_ALREADY_INSTALLED
Already Installed

EPI_ERR_USERID_INVALID

public static final int EPI_ERR_USERID_INVALID
The Userid supplied was Invalid

EPI_ERR_PASSWORD_INVALID

public static final int EPI_ERR_PASSWORD_INVALID
The Password was invalid

EPI_ERR_NULL_USERID

public static final int EPI_ERR_NULL_USERID
The Userid was NULL

EPI_ERR_NULL_PASSWORD

public static final int EPI_ERR_NULL_PASSWORD
The Password was NULL

EPI_ERR_CCSID_INVALID

public static final int EPI_ERR_CCSID_INVALID
The CCSid supplied was invalid

EPI_ERR_SERVER_BUSY

public static final int EPI_ERR_SERVER_BUSY
The CICS Server was too busy to handle the request

EPI_ERR_ABENDED

public static final int EPI_ERR_ABENDED
A Read Timeout occurred for the current Txn.

EPI_ERR_RESOURCE_SHORTAGE

public static final int EPI_ERR_RESOURCE_SHORTAGE
Resource Shortage, eg not enough SNA sessions

EPI_ERR_NO_CICS

public static final int EPI_ERR_NO_CICS
No CICS system Available

EPI_ERR_MAX_SYSTEMS

public static final int EPI_ERR_MAX_SYSTEMS
Reached limit on maxmimum number of systems

EPI_ERR_MAX_SESSIONS

public static final int EPI_ERR_MAX_SESSIONS
Not enough communication resources to satisfy request

EPI_NOEVENT

public static final int EPI_NOEVENT
No events returned for this terminal resource

EPI_EVENT_SEND

public static final int EPI_EVENT_SEND
A transaction has sent 3270 data to a terminal resource (no reply is expected)

EPI_EVENT_CONVERSE

public static final int EPI_EVENT_CONVERSE
A transaction is expecting an EPI_REPLY

EPI_EVENT_END_TRAN

public static final int EPI_EVENT_END_TRAN
A transaction has ended. If it was pseudoconversational then Transid contains the next transaction

EPI_EVENT_START_ATI

public static final int EPI_EVENT_START_ATI
An ATI transaction has been started against the terminal

EPI_EVENT_END_TERM

public static final int EPI_EVENT_END_TERM
This terminal resource no longer exists - check endReason value

EPI_EVENT_ADD_TERM

public static final int EPI_EVENT_ADD_TERM
An Add terminal event has been received.

EPI_END_SIGNOFF

public static final int EPI_END_SIGNOFF
The Terminal resource was signed off (for example because of delTerminal)

EPI_END_SHUTDOWN

public static final int EPI_END_SHUTDOWN
The CICS server is shutting down

EPI_END_OUTSERVICE

public static final int EPI_END_OUTSERVICE
The terminal resource is out of service

EPI_END_UNKNOWN

public static final int EPI_END_UNKNOWN
An unexpected error has occurred

EPI_END_FAILED

public static final int EPI_END_FAILED
An attempt to delete a terminal resource failed

EPI_ATI_ON

public static final int EPI_ATI_ON
Allow ATI requests and return the previous ATI state

EPI_ATI_HOLD

public static final int EPI_ATI_HOLD
Hold ATI requests and return the previous ATI state

EPI_ATI_QUERY

public static final int EPI_ATI_QUERY
Return the current ATI state

EPI_WAIT

public static final int EPI_WAIT
Wait for the next terminal event to occur

EPI_NOWAIT

public static final int EPI_NOWAIT
Return immediately (with Cics_Rc). Not currently recommended

EPI_SENSE_OPCHECK

public static final int EPI_SENSE_OPCHECK
Errors detected in 3270 datastream

EPI_SENSE_REJECT

public static final int EPI_SENSE_REJECT
Invalid 3270 commands received

EPI_ADD_SYNC

public static final int EPI_ADD_SYNC
Add Terminal Synchronously

EPI_ADD_ASYNC

public static final int EPI_ADD_ASYNC
Add Terminal Asynchronously

EPI_SIGNON_CAPABLE

public static final int EPI_SIGNON_CAPABLE
Signon Capable Terminal

EPI_SIGNON_INCAPABLE

public static final int EPI_SIGNON_INCAPABLE
Signon Incapable Terminal

EPI_SIGNON_UNKNOWN

public static final int EPI_SIGNON_UNKNOWN
Signon Capability unknown

EPI_TRAN_NO_ERROR

public static final int EPI_TRAN_NO_ERROR
No error occurred

EPI_TRAN_NOT_STARTED

public static final int EPI_TRAN_NOT_STARTED
Transaction failed to start

EPI_TRAN_STATE_UNKNOWN

public static final int EPI_TRAN_STATE_UNKNOWN
Transaction state is unknown

EPI_READTIMEOUT_EXPIRED

public static final int EPI_READTIMEOUT_EXPIRED
Transaction has timed out as no response given within readtimeout parameter

Call_Type

public int Call_Type
Type of EPI Call

Server

public java.lang.String Server
CICS Server to use (or which are using)

Cics_Rc

public int Cics_Rc
CICS return code

deviceType

public java.lang.String deviceType
CICS model terminal name - defined in CICS Server environment

signonCapability

public int signonCapability
Signon Capability of the terminal

addtype

public int addtype
Way to Add a terminal EPI_ADD_SYNC for Synchronous, EPI_ADD_ASYNC for ASynchronous

installTimeout

public int installTimeout
Terminal Install Timeout

readTimeout

public int readTimeout
Terminal Read Timeout

CCSid

public int CCSid
Terminal Code page

userid

public java.lang.String userid
Userid associated with the terminal

password

public java.lang.String password
Password associated with the terminal

atiState

public int atiState
Input and Output field for atiState() calls (Call_Type = EPI_ATI_STATE)

waitState

public int waitState
Input for getEvent() calls (Call_Type = EPI_GET_EVENT)

netName

public java.lang.String netName
Netname - platform dependent

numLines

public int numLines
Number of rows supported by the terminal resource

numColumns

public int numColumns
Number of columns supported by the terminal resource

maxData

public int maxData
Max data that will be sent to the terminal resource

errLastLine

public int errLastLine
1 = error messages displayed on last row; else 0

errIntensify

public int errIntensify
1 = error messages displayed intensified, else 0

errColor

public int errColor
3270 color attribute used for error messsages

errHilight

public int errHilight
3270 highlight attribute used for error messages

hilight

public int hilight
1 = terminal resource supports extended highlighting; else 0

color

public int color
1 = terminal resource supports color; else 0

printer

public int printer
Deprecated. This will always be 0, retained for backward compatability only

termID

public java.lang.String termID
Terminal ID

termIndex

public int termIndex
Index identifying a terminal resource

event

public int event
Type of event that has completed

endReason

public int endReason
Reason why the terminal resource was deleted

Transid

public java.lang.String Transid
Transaction to be run on the CICS Server

Abend_Code

public java.lang.String Abend_Code
Deprecated. The Abend code field is not used, and only remains here for backward compatability

data

public byte[] data
CICS 3270 data stream in byte array

size

public int size
Maximum size of data stream to be returned

mapName

public java.lang.String mapName
The Map name for the transaction (if any)

mapSetName

public java.lang.String mapSetName
The Map Set name for the transaction (if any)

endReturnCode

public int endReturnCode
The Return code for END_TRAN and ADD_TERM events

SystemList

public java.util.Vector SystemList
Vector of CICS servers and their descriptions: 1st element is Server, 2nd element is Desc. etc.

maxNumServers

public int maxNumServers
Max num of CICS Servers about which info is to be returned (input to listSystems() )

numServersKnown

public int numServersKnown
Num of CICS Servers which are defined (output from listSystems() flow)

numServersReturned

public int numServersReturned
Num of CICS Servers about which info has been returned (output from listSystems() flow)

cause

public int cause
Deprecated. This will always be 0.

value

public int value
Deprecated. This will always be 0.

msg

public java.lang.String msg
Deprecated. This will never contain any information

senseCode

public int senseCode
Send 3270 error - Open Systems only
Constructor Detail

EPIRequest

public EPIRequest()
Default constructor, which leaves all the values set to their defaults.

Since all the valid EPIRequest parameters are public data members you can set them by hand if required.


EPIRequest

public EPIRequest(int iCallType)
Call_Type constructor.

Parameters:
iCallType - Call Type

EPIRequest

public EPIRequest(int iCallType,
                  int itermIndex)
Call_Type and termIndex constructor.

This constructor will create an object that is suitable for EPI_INQUIRE_SYSTEM, EPI_DEL_TERMINAL and EPI_GET_SYS_ERROR.

Parameters:
iCallType - Call Type
itermIndex - Terminal Index
Method Detail

static void ()
The purpose of this static initializer is to get the appropriate ResourceBundle class. Client-side resource bundles (for CICS requests) have the naming format: CicsResourceBundle.java This class is the highest level resource bundle and the messages are in US English. If the language associated with the default locale is not US English then the specific resource bundle (if it exists) will have the format: CicsResourceBundle_fr.java (or CicsResourceBundle_fr_FR.java). The 'getBundle()' method of the ResourceBundle class looks for the most specific (appropriate) resource bundle first and if it does not find this works its way up to the least specific resource bundle i.e. CicsResourceBundle.java. So, messages will appear in US English if there are no appropriate resource bundles.

listSystems

public static EPIRequest listSystems(int iNumOfSys)
This method returns a new EPIRequest object which can be used to effect a CICS_EpiListSystems on the CICS Transaction Gateway. The returned object should be flowed to the Gateway as is.

Upon return for the flow call, the public data Vector EPIRequest.SystemsList will contain the returned system names and descriptions.

Upon return from the flow call, numServersKnown and numServersReturned will also have been updated.

There is no guarantee that a communications link exists between the CICS Transaction Gateway and any server in the list, or that any of the CICS servers are available.

Parameters:
iNumOfSys - Maximum number of systems to request information on

addTerminal

public static EPIRequest addTerminal(java.lang.String strServer,
                                     java.lang.String strNetName,
                                     java.lang.String strDeviceType)
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddTerminal on the CICS Transaction Gateway. The returned object should be flowed to the Gateway as is.

This method installs a new terminal resource, or reserves an existing one. It returns a termIndex which should be used to identify the terminal resource on other EPI calls.

If strServer is not supplied then, currently, the default server is selected.

If a strNetName is not supplied then one is returned in netName. If a strNetName is supplied but it does not match an existing terminal resource in the server, then the server installs a terminal resource using the strDeviceType and gives it the strNetName. (In this case if strDeviceType is null then an error is returned.)

If a strDeviceType is not supplied and a new terminal resource is installed, then the selected terminal type is not predictable. You are advised to provide a strDeviceType (the value of this will depend on your server setup).

After a terminal resource has been added, the default ATIState is EPI_ATI_HOLD i.e. ATI requests will be NOT be processed. EPIRequests to start a transaction (startTran method) are NOT ATI requests, but terminal requests. To enable ATI requests to be processed the atiState should be changed to EPI_ATI_ON. This can be done by setting the iATIState to EPI_ATI_ON using the atiState method.

NOTE: Callback routines are specified NOT on the addTerminal request, but on the getEvent request (using the getEventWithCallback method).

Parameters:
strServer - CICS server name to make request to
strNetName - CICS terminal resource name
strDeviceType - CICS terminal model name

addTerminal

public static EPIRequest addTerminal(java.lang.String strServer,
                                     java.lang.String strNetName,
                                     java.lang.String strDeviceType,
                                     java.lang.String strUserid,
                                     java.lang.String strPassword,
                                     int iInstallTimeout,
                                     int iReadTimeout,
                                     int iSignonCapability,
                                     int iCCSid)
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway. The returned object should be flowed to the Gateway as is.

This method installs a new terminal resource, or reserves an existing one. It returns a termIndex which should be used to identify the terminal resource on other EPI calls.

If strServer is not supplied then, currently, the default server is selected.

If a strNetName is not supplied then one is returned in netName. If a strNetName is supplied but it does not match an existing terminal resource in the server, then the server installs a terminal resource using the strDeviceType and gives it the strNetName. (In this case if strDeviceType is null then an error is returned.)

If a strDeviceType is not supplied and a new terminal resource is installed, then the selected terminal type is not predictable. You are advised to provide a strDeviceType (the value of this will depend on your server setup).

After a terminal resource has been added, the default ATIState is EPI_ATI_HOLD i.e. ATI requests will be NOT be processed. EPIRequests to start a transaction (startTran method) are NOT ATI requests, but terminal requests. To enable ATI requests to be processed the atiState should be changed to EPI_ATI_ON. This can be done by setting the iATIState to EPI_ATI_ON using the atiState method.

NOTE: Callback routines are specified NOT on the addTerminal request, but on the getEvent request (using the getEventWithCallback method).

Parameters:
strServer - CICS server name to make request to
strNetName - CICS terminal resource name
strDeviceType - CICS terminal model name
strUserid - Userid to associate with the terminal
strPassword - Password to assocaite with the terminal
iInstallTimeout - Terminal Install timeout (0-3600 secs, 0 = infinite)
iReadTimeout - Read Timeout (0-3600 secs, 0 = infinite)
iSignonCapability - Signon Capability EPI_SIGNON_CAPABLE or EPI_SIGNON_INCAPABLE

addTerminalAsync

public static EPIRequest addTerminalAsync(java.lang.String strServer,
                                          java.lang.String strNetName,
                                          java.lang.String strDeviceType,
                                          java.lang.String strUserid,
                                          java.lang.String strPassword,
                                          int iInstallTimeout,
                                          int iReadTimeout,
                                          int iSignonCapability,
                                          int iCCSid)
This method returns a new EPIRequest object which can be used to effect a CICS_EpiAddExTerminal on the CICS Transaction Gateway. The returned object should be flowed to the Gateway as is.

This method installs a new terminal resource, or reserves an existing one. It returns a termIndex which should be used to identify the terminal resource on other EPI calls.

If strServer is not supplied then, currently, the default server is selected.

If a strNetName is not supplied then one is returned in netName. If a strNetName is supplied but it does not match an existing terminal resource in the server, then the server installs a terminal resource using the strDeviceType and gives it the strNetName. (In this case if strDeviceType is null then an error is returned.)

If a strDeviceType is not supplied and a new terminal resource is installed, then the selected terminal type is not predictable. You are advised to provide a strDeviceType (the value of this will depend on your server setup).

After a terminal resource has been added, the default ATIState is EPI_ATI_HOLD i.e. ATI requests will be NOT be processed. EPIRequests to start a transaction (startTran method) are NOT ATI requests, but terminal requests. To enable ATI requests to be processed the atiState should be changed to EPI_ATI_ON. This can be done by setting the iATIState to EPI_ATI_ON using the atiState method.

NOTE: Callback routines are specified NOT on the addTerminal request, but on the getEvent request (using the getEventWithCallback method).

Parameters:
strServer - CICS server name to make request to
strNetName - CICS terminal resource name
strDeviceType - CICS terminal model name
strUserid - Userid to associate with the terminal
strPassword - Password to assocaite with the terminal
iInstallTimeout - Terminal Install timeout (0-3600 secs, 0 = infinite)
iReadTimeout - Read Timeout (0-3600 secs, 0 = infinite)
iSignonCapability - Signon Capability EPI_SIGNON_CAPABLE or EPI_SIGNON_INCAPABLE
iCCSid - Codepage

getCallType

public int getCallType()
Returns the Call_Type set in this object
Returns:
int The Call_Type

getCallTypeString

public java.lang.String getCallTypeString()
Returns the Call_Type set in this object, as a String.

The String returned is the name of the appropriate Java constant e.g. if the Call_Type is EPI_ADD_TERMINAL, then the String returned will be "EPI_ADD_TERMINAL". If the Call_Type is invalid then the String returned will be "EPI_UNKNOWN_CALL_TYPE".

Returns:
String The Call_Type as a String

getRc

public int getRc()
Gets the return code set in this object. If a Gateway error code is set this is returned. However if there is no Gateway error code, then any CICS return code is returned. If this method returns zero, it can be assumed that no errors have occurred.

Returns:
int The return code

getCicsRc

public int getCicsRc()
Gets the CICS return code set in this object, if there is one.

Returns:
int The return code

getCicsRcString

public java.lang.String getCicsRcString()
Gets the CICS return code set in this object and returns it as a String.

The String returned is the name of the appropriate Java constant e.g. if the Cics_Rc is EPI_NORMAL, then the String returned will be "EPI_NORMAL". If the Cics_Rc is unknown then the String returned will be "EPI_UNKNOWN_CICS_RC".

Returns:
The return code as a String

getEndReturnCode

public int getEndReturnCode()
Gets the Extra CICS return code from an END_TRAN or ADD_TERM event

Returns:
int The return code

getEndReturnCodeString

public java.lang.String getEndReturnCodeString()
Gets the Extra CICS return code from an END_TRAN or ADD_TERM Event and returns it as a String.

The String returned is the name of the appropriate Java constant e.g. if the Cics_Rc is EPI_NORMAL, then the String returned will be "EPI_NORMAL". If the Cics_Rc is unknown then the String returned will be "EPI_UNKNOWN_CICS_RC".

Returns:
The return code as a String

getEndReason

public int getEndReason()
returns the End Reason value which is set when an END_TERM event has been received

Returns:
int The End Reason

getEndReasonString

public java.lang.String getEndReasonString()
returns the End Reason value as a string, which is set when an END_TERM event has been received

The String returned is the name of the appropriate Java constant e.g. if the value is EPI_END_SIGNOFF then the String returned will be "EPI_END_SIGNOFF". If the End Reason value is unknown then the String returned will be "EPI_UNKNOWN_END_REASON".

Returns:
The end reason as a String

getEvent

public int getEvent()
Returns the event set in this object.

Returns:
int The event

getEventString

public java.lang.String getEventString()
Gets the event set in this object and returns it as a String.

The String returned is the name of the appropriate Java constant e.g. if the event is EPI_EVENT_SEND, then the String returned will be "EPI_EVENT_SEND". If the event is unknown then the String returned will be "EPI_NOEVENT".

Returns:
String The event as a String

getSignonString

public java.lang.String getSignonString()
Gets the Signon Capability set in this object and return it as a string

The String returned is the name of the appropriate Java constant e.g. if the signon capability is EPI_SIGNON_CAPABLE then the string returned will be "EPI_SIGNON_CAPABLE". If the value is not valid then the string returned will be "EPI_SIGNON_INVALID"

Returns:
String The signon capability as a string

getAddTypeString

public java.lang.String getAddTypeString()
Gets the add type for an extended Terminal Request for this ojbect and returns it as a string

The String returned is the name of the appropriate Java constant e.g. if the add type is EPI_ADD_SYNC, then the String returned will be "EPI_ADD_SYNC". If the type is unknown then the String returned will be "EPI_UNKNOWN_ADD_TYPE"

Returns:
String The add type as a string

setCallback

public void setCallback(Callbackable calBack)
Sets the Callbackable object associated with this object.

If null is passed to this method then it is assumed that no Callbackable object is required.

Parameters:
calBack - EPI Callbackable object.

isCallback

public boolean isCallback()
This method returns a boolean indicating whether there is a Callbackable object associated with this EPIRequest object.
Returns:
boolean indicating whether there is a Callbackable object

inquireSystem

public void inquireSystem()
Sets the Call_Type of this object to EPI_INQUIRE_STATE.

An EPI_INQUIRE_SYSTEM request takes a termIndex value and returns the Server on which the terminal resource (identified by the termIndex) is installed.

Upon return for the flow call, the EPIRequest object's Server value is updated.


inquireSystem

public void inquireSystem(int itermIndex)
Sets the Call_Type of this object to EPI_INQUIRE_STATE and also sets the termIndex associated with this object.

An EPI_INQUIRE_SYSTEM request takes a termIndex value and returns the Server on which the terminal resource (identified by the termIndex) is installed.

Upon return for the flow call, the EPIRequest object's Server value is updated.

Parameters:
itermIndex - Index of terminal whose Server is to be determined

atiState

public void atiState(int iATIState)
Sets the Call_Type of this object to EPI_ATI_STATE and also sets the atiState associated with this object.

This method allows the application to query and alter the way ATI requests are handled.

EPI_ATI_ON enables ATI requests and, also, returns the previous ATI in variable atiState.

EPI_ATI_HOLD enables ATI requests to be held and, also, returns the previous ATI state in the variable atiState.

EPI_ATI_QUERY returns the current ATI state.

Parameters:
iatiState - ATI state

atiState

public void atiState(int itermIndex,
                     int iATIState)
Sets the Call_Type of this object to EPI_ATI_STATE and also sets the termIndex and atiState associated with this object.

This method allows the application to query and alter the way ATI requests are handled.

EPI_ATI_ON enables ATI requests and, also, returns the previous ATI in variable atiState.

EPI_ATI_HOLD enables ATI requests to be held and, also, returns the previous ATI state in the variable atiState.

EPI_ATI_QUERY returns the current ATI state.

Parameters:
itermIndex - Terminal Index of terminal whose atiState is to be queried or set
iatiState - ATI state

startTran

public void startTran(java.lang.String strTransid,
                      byte[] abytdata,
                      int isize)
Sets the Call_Type of this object to EPI_START_TRAN and also sets the Transid, data and size associated with this object.

This method allows the application to start a new transaction from a terminal resource, or continue a pseudoconversational transaction.

Start a new transaction after EPI_ADD_TERMINAL has flowed. Or after EPI_GET_EVENT returns an event of EPI_EVENT_END_TRAN.

Continue a pseudoconversation after EPI_GET_EVENT returns an event of EPI_EVENT_END_TRAN and the Transid returned was NOT null. In this case, if the strTransid is not null, it must be the same as the Transid returned in the preceding EPI_EVENT_END_TRAN.

Parameters:
strTransid - Transid to be run, or null
abytdata - Byte array of 3270 data stream. CANNOT be null.
isize - size, in bytes, of data stream to be passed to transaction

startTran

public void startTran(int itermIndex,
                      java.lang.String strTransid,
                      byte[] abytdata,
                      int isize)
Sets the Call_Type of this object to EPI_START_TRAN and also sets the termIndex, Transid, data and size associated with this object.

This method allows the application to start a new transaction from a terminal resource, or continue a pseudoconversational transaction.

Start a new transaction after EPI_ADD_TERMINAL has flowed. Or after EPI_GET_EVENT returns an event of EPI_EVENT_END_TRAN.

Continue a pseudoconversation after EPI_GET_EVENT returns an event of EPI_EVENT_END_TRAN and the Transid returned was NOT null. In this case, if the strTransid is not null, it must be the same as the Transid returned in the preceding EPI_EVENT_END_TRAN.

Parameters:
itermIndex - Terminal Index of terminal that is to run transaction
strTransid - Transid to be run, or null
abytdata - Byte array of 3270 data stream. CANNOT be null.
isize - size, in bytes, of data stream to be passed to transaction

sendReply

public void sendReply(byte[] abytdata,
                      int isize)
Sets the Call_Type of this object to EPI_REPLY and also sets the data and size associated with this object.

This method allows the application to send a reply in response to a EPI_EVENT_CONVERSE.

Parameters:
abytdata - Byte array of 3270 data stream. CANNOT be null.
isize - size, in bytes, of data stream to be passed to transaction

sendReply

public void sendReply(int itermIndex,
                      byte[] abytdata,
                      int isize)
Sets the Call_Type of this object to EPI_REPLY and also sets the termIndex, data and size associated with this object.

This method allows the application to send a reply in response to a EPI_EVENT_CONVERSE.

Parameters:
itermIndex - Terminal Index of terminal that is to run transaction
abytdata - Byte array of 3270 data stream. CANNOT be null.
isize - size, in bytes, of data stream to be passed to transaction

getEvent

public void getEvent(int iwaitState,
                     int isize)
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the waitState and size associated with this object.

This method allows the application to obtain information about an event that has occurred for a terminal resource.

If the event is EPI_EVENT_SEND then data and size are returned.

If the event is EPI_EVENT_CONVERSE then data and size are returned. The application should then issue an EPI_REPLY.

If the event is EPI_EVENT_END_TRAN then Transid is returned if the previous transaction was pseudoconversational. Abend_Code is returned if the transaction abended.

If the event is EPI_EVENT_START_ATI then Transid is returned.

If the event is EPI_EVENT_END_TERM then endReason is returned. Abend_Code is returned if endReason is EPI_END_FAILED.

If the event is EPI_EVENT_ADD_TERM then the variables detail properties will be updated. You must ensure a large enough size for the eventdata though

NOTE: You must supply a termIndex value before flowing the the request.

NOTE: You MUST ensure that the size of the data array to be returned is sufficient to hold ALL the data that may be returned. If the data is truncated (EPI_ERR_MORE_DATA) then your application/applet may not receive the end of transaction indicator (EPI_EVENT_END_TRAN).

NOTE: You are strongly recommended to use getEvent() with iwaitState = EPI_WAIT or getEventWithCallback; NOT getEvent() with iwaitState = EPI_NOWAIT.

NOTE: After the getEvent has completed successfully the 'size' field contains the amount of data returned by CICS. The size of the 'data' array is the input 'size' value, not the output 'size' value.

Parameters:
iwaitState - What should happen if no event has been generated
isize - MAXIMUM size, in bytes, of the data to be returned

getEvent

public void getEvent(int itermIndex,
                     int iwaitState,
                     int isize)
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, waitState and size associated with this object.

This method allows the application to obtain information about an event that has occurred for a terminal resource.

If the event is EPI_EVENT_SEND then data and size are returned.

If the event is EPI_EVENT_CONVERSE then data and size are returned. The application should then issue an EPI_REPLY.

If the event is EPI_EVENT_END_TRAN then Transid is returned if the previous transaction was pseudoconversational. Abend_Code is returned if the transaction abended.

If the event is EPI_EVENT_START_ATI then Transid is returned.

If the event is EPI_EVENT_END_TERM then endReason is returned. Abend_Code is returned if endReason is EPI_END_FAILED.

If the event is EPI_EVENT_ADD_TERM then the variables detail properties will be updated. You must ensure a large enough size for the eventdata though

NOTE: You must supply a termIndex value before flowing the the request.

NOTE: You MUST ensure that the size of the data array to be returned is sufficient to hold ALL the data that may be returned. If the data is truncated (EPI_ERR_MORE_DATA) then your application/applet may not receive the end of transaction indicator (EPI_EVENT_END_TRAN).

NOTE: You are strongly recommended to use getEvent() with iwaitState = EPI_WAIT or getEventWithCallback; NOT getEvent() with iwaitState = EPI_NOWAIT.

NOTE: After the getEvent has completed successfully the 'size' field contains the amount of data returned by CICS. The size of the 'data' array is the input 'size' value, not the output 'size' value.

Parameters:
itermIndex - Terminal Index of terminal for which to obtain event
iwaitState - What should happen if no event has been generated
isize - MAXIMUM size, in bytes, of the data to be returned

getEventWithCallback

public void getEventWithCallback(int isize,
                                 Callbackable calBack)
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the size and Callbackable object associated with this object.

This method allows the application to obtain information about an event that has occurred for a terminal resource. The Callbackable object is invoked when an event occurs for the specified terminal resource.

If the event is EPI_EVENT_SEND then data and size are returned.

If the event is EPI_EVENT_CONVERSE then data and size are returned. The application should then issue an EPI_REPLY.

If the event is EPI_EVENT_END_TRAN then Transid is returned if the previous transaction was pseudoconversational. Abend_Code is returned if the transaction abended.

If the event is EPI_EVENT_START_ATI then Transid is returned.

If the event is EPI_EVENT_END_TERM then endReason is returned. Abend_Code is returned if endReason is EPI_END_FAILED.

If the event is EPI_EVENT_ADD_TERM then the variables detail properties will be updated. You must ensure a large enough size for the eventdata though

NOTE: You must supply a termIndex value before flowing the the request.

NOTE: You MUST ensure that the size of the data array to be returned is sufficient to hold ALL the data that may be returned. If the data is truncated (EPI_ERR_MORE_DATA) then your application/applet may not receive the end of transaction indicator (EPI_EVENT_END_TRAN).

NOTE: After the getEvent has completed successfully the 'size' field contains the amount of data returned by CICS. The size of the 'data' array is the input 'size' value, not the output 'size' value.

NOTE: If no Callbackable object is supplied a getEvent with EPI_WAIT will default.

Parameters:
isize - MAXIMUM size, in bytes, of the data to be returned
calBack - EPI Callbackable object

getEventWithCallback

public void getEventWithCallback(int itermIndex,
                                 int isize,
                                 Callbackable calBack)
Sets the Call_Type of this object to EPI_GET_EVENT and also sets the termIndex, size and Callbackable object associated with this object.

This method allows the application to obtain information about an event that has occurred for a terminal resource. The Callbackable object is invoked when an event occurs for the specified terminal resource.

If the event is EPI_EVENT_SEND then data and size are returned.

If the event is EPI_EVENT_CONVERSE then data and size are returned. The application should then issue an EPI_REPLY.

If the event is EPI_EVENT_END_TRAN then Transid is returned if the previous transaction was pseudoconversational. Abend_Code is returned if the transaction abended.

If the event is EPI_EVENT_START_ATI then Transid is returned.

If the event is EPI_EVENT_END_TERM then endReason is returned. Abend_Code is returned if endReason is EPI_END_FAILED.

If the event is EPI_EVENT_ADD_TERM then the variables detail properties will be updated. You must ensure a large enough size for the eventdata though

NOTE: You must supply a termIndex value before flowing the the request.

NOTE: You MUST ensure that the size of the data array to be returned is sufficient to hold ALL the data that may be returned. If the data is truncated (EPI_ERR_MORE_DATA) then your application/applet may not receive the end of transaction indicator (EPI_EVENT_END_TRAN).

NOTE: After the getEvent has completed successfully the 'size' field contains the amount of data returned by CICS. The size of the 'data' array is the input 'size' value, not the output 'size' value.

NOTE: If no Callbackable object is supplied a getEvent with EPI_WAIT will default.

Parameters:
itermIndex - Terminal Index of terminal for which to obtain event
isize - MAXIMUM size, in bytes, of the data to be returned
calBack - EPI Callbackable object

getSysError

public void getSysError()
Deprecated. This method does nothing. cause and value will always be 0.
Sets the Call_Type of this object to EPI_GET_SYS_ERROR.


getSysError

public void getSysError(int itermIndex)
Deprecated. This method does nothing. cause and value will always be 0.
Sets the Call_Type of this object to EPI_GET_SYS_ERROR.

Parameters:
itermIndex - Terminal Index of terminal with error

delTerminal

public void delTerminal()
Sets the Call_Type of this object to EPI_DEL_TERMINAL.

This method deletes a previously added terminal resource, identified by its termIndex.


delTerminal

public void delTerminal(int itermIndex)
Sets the Call_Type of this object to EPI_DEL_TERMINAL and also sets the termIndex associated with this object.

This method deletes a previously added terminal resource, identified by its termIndex.

Parameters:
itermIndex - Terminal Index of terminal to be deleted

purgeTerminal

public void purgeTerminal()
Sets the Call_Type of this object to EPI_PURGE_TERMINAL.

This method deletes a previously added terminal resource, identified by its termIndex.


purgeTerminal

public void purgeTerminal(int itermIndex)
Sets the Call_Type of this object to EPI_PURGE_TERMINAL and also sets the termIndex associated with this object.

This method deletes a previously added terminal resource, identified by its termIndex.

Parameters:
itermIndex - Terminal Index of terminal to be purged

alterSecurity

public void alterSecurity(java.lang.String strUserid,
                          java.lang.String strPassword)
Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object

This method defines a request which allows you to change the userid and password associated with the current terminal installed.

Parameters:
strUserid - New Userid to be assigned
strPassword - New Password to be assigned

alterSecurity

public void alterSecurity(java.lang.String strUserid,
                          java.lang.String strPassword,
                          int iTermIndex)
Sets the Call_Type of this object to EPI_SET_SECURITY and also sets the userid and password associated with this object

This method defines a request which allows you to change the userid and password associated with the current terminal installed.

Parameters:
strUserid - New Userid to be assigned
strPassword - New Password to be assigned
itermIndex - Terminal Index of terminal to be purged

© Copyright IBM Corp. 1994, 1999