|
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 |
public interface TerminalSession
This interface defines the behaviour of a terminal which is in session, ie: has an associated Session object. TerminalInterface extends this with functions that allow the Session object to be changed.
Field Summary | |
---|---|
static int |
client
Server expecting reply. |
static int |
discon
Terminal disconnected. |
static int |
error
An error has occurred. |
static int |
failed
Transaction failed to start/complete or timed out. |
static int |
idle
Terminal idle. |
static int |
server
Terminal waiting for server. |
static int |
start
Terminal starting. |
static int |
txnTimedOut
A Transaction has timed out through readtimeout property but the application has not been informed as yet of the exception. |
Method Summary | |
---|---|
EPISecurityAttrs |
changePassword(java.lang.String newPass)
Allows you to change the password for a given userid and current password with the External Security Manager |
void |
connect()
Connects the terminal to the server. |
void |
connect(int installTimeout)
Connects an Extended terminal to the server, within a given timeout. |
void |
disconnect()
Disconnects the terminal from the server. |
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 associated with the terminal. |
int |
getState()
Returns the state of the terminal. |
java.lang.String |
getTermid()
Returns the terminal id associated with the terminal. |
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. |
boolean |
queryATI()
Returns a boolean indicating whether the terminal ATI state is enabled or disabled. |
void |
send()
Sends the current screen to the server using the current Session. |
void |
send(java.lang.String transid,
java.lang.String data)
Starts a transaction on the server using the current Session. |
void |
setATI(boolean on)
Sets the terminal ATI state to be enabled or disabled. |
void |
setPassword(java.lang.String password)
Sets the password associated with the terminal. |
void |
setUserid(java.lang.String newUserid)
Sets the userid associated with the terminal. |
EPISecurityAttrs |
verifyPassword()
Verifies the userid and password with the External Security Manager |
Field Detail |
---|
static final int start
static final int idle
static final int client
static final int server
static final int discon
static final int error
static final int failed
static final int txnTimedOut
Method Detail |
---|
void connect() throws java.io.IOException, EPIException
java.io.IOException
- if an error occurs
EPIException
- if an error occursvoid connect(int installTimeout) throws java.io.IOException, EPIException
installTimeout
- Terminal Install timeout (0-3600 secs, 0 = infinite)
java.io.IOException
- if an error occurs
EPIException
- if an error occursvoid send(java.lang.String transid, java.lang.String data) throws java.io.IOException, EPIException
transid
- the transaction to startdata
- the data to pass to the transaction
java.io.IOException
- if an error occurs
EPIException
- if an error occursvoid send() throws java.io.IOException, EPIException
idle
or the screen is already set up to start the
next transaction.
java.io.IOException
- if an error occurs
EPIException
- if an error occursvoid disconnect() throws java.io.IOException, EPIException
java.io.IOException
- if an error occurs
EPIException
- if an error occursboolean queryATI() throws java.io.IOException, EPIException
java.io.IOException
- if an error occurs
EPIException
- if an error occursvoid setATI(boolean on) throws java.io.IOException, EPIException
on
- true to set ATI enabled, false otherwise
java.io.IOException
- if an error occurs
EPIException
- if an error occursScreen getScreen()
int getState()
EPISecurityAttrs verifyPassword() throws EPIGatewayException, EPISecurityException, java.io.IOException, TerminalException
java.io.IOException
- if an error occurs connecting to the gateway
EPISecurityException
- if an ESI call fails
EPIGatewayException
TerminalException
EPISecurityAttrs changePassword(java.lang.String newPass) throws EPIGatewayException, EPISecurityException, java.io.IOException, TerminalException
java.io.IOException
- if an error occurs connecting to the gateway
EPISecurityException
- if an ESI call fails
EPIGatewayException
TerminalException
java.lang.String getTermid()
void setUserid(java.lang.String newUserid)
Invoking this method automatically flags the terminal as an extended type of terminal supporting the terminal features
newUserid
- the userid.void setPassword(java.lang.String password)
Invoking this method automatically flags the terminal as an extended type of terminal supporting the terminal features
password
- the password.java.lang.String getUserid()
java.lang.String getPassword()
|
©Copyright IBM Corp. 1994, 2014 Legal |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |