|
CICS® Transaction Gateway Programming Reference v1.1.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ctg.epi.EPITerminal
public class EPITerminal
A Java bean that represents a connection to a CICS 3270 terminal.
Field Summary |
---|
Fields inherited from interface com.ibm.ctg.epi.Session |
---|
async, sync |
Fields inherited from interface com.ibm.ctg.epi.TerminalSession |
---|
client, discon, error, failed, idle, server, start, txnTimedOut |
Constructor Summary | |
---|---|
EPITerminal()
Constructs an EPITerminal with a default URL of the current host and port 2006. |
Method Summary | |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent evt)
Reacts to an action event by starting a transaction - the action command associated with the event is assumed to be the transaction name. |
void |
addTerminalEventListener(TerminalEventListener h)
Adds a TerminalEventListener to the list of screen handlers. |
EPISecurityAttrs |
changePassword(java.lang.String newPass)
Allows modification of the password for a given userid and current password with the External Security Manager |
void |
connect()
Connects to the CICS server. |
void |
connect(int installTimeout)
Connects to the CICS server. |
void |
disconnect()
Disconnects from the CICS server. |
java.lang.String |
getGatewayClientSecurity()
Returns the name of the client security class that the CICS Transaction Gateway will use. |
java.lang.String |
getGatewayServerSecurity()
Returns the name of the server security class that the CICS Transaction Gateway will use. |
java.lang.String |
getGatewayURL()
Returns the URL of the CICS Transaction Gateway that the terminal will connect to. |
java.lang.String |
getPassword()
Returns the password associated with the terminal, or null if the password is null or the terminal is a basic terminal. |
Screen |
getScreen()
Returns the Screen object associated with this terminal. |
int |
getState()
Returns the terminal state. |
int |
getSyncType()
Returns the type of synchronization the terminal is using. |
java.lang.String |
getTermid()
Returns the terminal id associated with the terminal. |
TerminalInterface |
getTerminal()
Returns the terminal that will be used to connect to CICS.. |
long |
getTimeout()
Returns the terminal timeout. |
java.lang.String |
getTransaction()
Returns the transaction that will be started if startTran is called. |
java.lang.String |
getTransactionData()
Returns the parameters that will be passed when startTran is called. |
java.lang.String |
getUserid()
Returns the userid associated with the terminal, or null if the userid is null or the terminal is a basic terminal. |
void |
handleException(TerminalInterface term,
java.lang.Exception e)
Handles an exception received from the Terminal class is in the right state. |
void |
handleReply(TerminalInterface term)
Handles a reply from CICS by sending handleScreen events to all listeners if the terminal is in the right state. |
boolean |
isATI()
Returns true if ATI is currently enabled for this terminal. |
boolean |
isConnected()
Returns true if the terminal is connected to CICS. |
boolean |
queryATI()
Determines whether ATI is currently enabled for this terminal. |
void |
removeTerminalEventListener(TerminalEventListener h)
Removes a TerminalEventListener from the list of screen handlers. |
void |
send()
Sends the current screen to CICS. |
void |
send(java.lang.String tran,
java.lang.String data)
Starts a new transaction. |
void |
setATI(boolean on)
Sets the Terminal ATI state. |
void |
setGatewayClientSecurity(java.lang.String classname)
Sets the client security class that the CICS Transaction Gateway will use (If the terminal is connected, this change does not affect it). |
void |
setGatewayServerSecurity(java.lang.String classname)
Sets the server security class that the CICS Transaction Gateway will use (If the terminal is connected, this change has no effect). |
void |
setGatewayURL(java.lang.String url)
Set the URL of the CICS Transaction Gateway to connect to (If already connected, this change has no effect). |
void |
setPassword(java.lang.String password)
Sets the password associated with the terminal. |
void |
setTerminal(TerminalInterface t)
Sets the terminal that will be used to connect to CICS (Disconnect and reconnect for this change to take effect). |
void |
setTimeout(long t)
Sets the terminal timeout. |
void |
setTransaction(java.lang.String t)
Sets the transaction to be started when startTran is called. |
void |
setTransactionData(java.lang.String d)
Sets the parameters to pass when startTran is called. |
void |
setUserid(java.lang.String newUserid)
Sets the userid associated with the terminal. |
void |
startTran()
Starts a transaction on the terminal, using the current transaction ID and data. |
void |
terminate()
Waits for the terminal to finish disconnecting and then closes the connection to the CICS Transaction Gateway. |
EPISecurityAttrs |
verifyPassword()
Verifies the userid and password with the External Security Manager |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EPITerminal()
Method Detail |
---|
public void terminate()
public void connect()
connect
in interface TerminalSession
public void connect(int installTimeout)
connect
in interface TerminalSession
installTimeout
- timeout for the connect requestpublic void disconnect()
disconnect
in interface TerminalSession
public void setTransaction(java.lang.String t)
t
- the transaction ID.public java.lang.String getTransaction()
public void setTransactionData(java.lang.String d)
d
- the parameterspublic java.lang.String getTransactionData()
public void setTerminal(TerminalInterface t)
t
- the terminal to usepublic TerminalInterface getTerminal()
public void setGatewayURL(java.lang.String url)
url
- the URL of the gatewaypublic java.lang.String getGatewayURL()
public void setGatewayClientSecurity(java.lang.String classname)
classname
- the name of the security classpublic java.lang.String getGatewayClientSecurity()
public void setGatewayServerSecurity(java.lang.String classname)
classname
- the name of the security classpublic java.lang.String getGatewayServerSecurity()
public void setTimeout(long t)
t
- the timeout in millisecondspublic long getTimeout()
public boolean isConnected()
public void startTran()
public Screen getScreen()
Screen
object associated with this terminal.
getScreen
in interface TerminalSession
public void send()
send
in interface TerminalSession
public void send(java.lang.String tran, java.lang.String data)
send
in interface TerminalSession
tran
- a transaction IDdata
- parameters to pass to the transactionpublic boolean queryATI()
queryATI
in interface TerminalSession
public void setATI(boolean on)
setATI
in interface TerminalSession
on
- true to set ATI enabledpublic boolean isATI()
public EPISecurityAttrs verifyPassword() throws EPIGatewayException, EPISecurityException, java.io.IOException, TerminalException
verifyPassword
in interface TerminalSession
java.io.IOException
- if an error occurs connecting to the gateway
EPISecurityException
- if an ESI call fails
EPIGatewayException
TerminalException
public EPISecurityAttrs changePassword(java.lang.String newPass) throws EPIGatewayException, EPISecurityException, java.io.IOException, TerminalException
changePassword
in interface TerminalSession
java.io.IOException
- if an error occurs connecting to the gateway
EPISecurityException
- if an ESI call fails
EPIGatewayException
TerminalException
public java.lang.String getTermid()
getTermid
in interface TerminalSession
public void setUserid(java.lang.String newUserid)
Invoking this method automatically flags the terminal as an extended type of terminal supporting the terminal features
setUserid
in interface TerminalSession
newUserid
- the userid.public void setPassword(java.lang.String password)
Invoking this method automatically flags the terminal as an extended type of terminal supporting the terminal features
setPassword
in interface TerminalSession
password
- the password.public java.lang.String getUserid()
getUserid
in interface TerminalSession
public java.lang.String getPassword()
getPassword
in interface TerminalSession
public void actionPerformed(java.awt.event.ActionEvent evt)
actionPerformed
in interface java.awt.event.ActionListener
evt
- the action eventpublic void addTerminalEventListener(TerminalEventListener h)
TerminalEventListener
to the list of screen handlers.
When an event occurs, such as the arrival of a screen of data from CICS,
all the event listeners are notified.
h
- the event listenerpublic void removeTerminalEventListener(TerminalEventListener h)
TerminalEventListener
from the list of screen handlers.
h
- the event listenerpublic int getSyncType()
getSyncType
in interface Session
public void handleException(TerminalInterface term, java.lang.Exception e)
term
- the terminal object where the state has changedpublic void handleReply(TerminalInterface term)
handleReply
in interface Session
term
- the terminal object where the state has changedpublic int getState()
getState
in interface TerminalSession
|
©Copyright IBM Corp. 1994, 2014 Legal |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |