Bean3270API Overview - - Java to CICS Tn3270E Legacy Systems Integration

Bean3270API™ Description

Bean3270API is a 100% Java Application Programming Interface which performs Tn3270E emulation under program control, and is the underlying Tn3270E run-time engine for the Bean3270 product.

Will run on any operating system that has ported a Java VM and that supports the Java JDK 1.3 or higher. This includes any web server software that supports a Java or J2EE container (IPlanet, Sun One, WebSphere, Apache Tomcat, BEA Weblogic, etc.).

The host Tn3270 server must be able to connect via TCP/IP to the computer where the software using the Bean3270API is running. There are no other software/hardware requirements.

All low-level functions such as socket connection, data transfer and 3270 data stream handling are encapsulated by the software and exposed as high level method calls to the using programmer.

Most of the high level method calls deal with the contents of the screen and/or attribute buffer representing the current state of a connected terminal to the Tn3270 host. Other high level method calls provide control and/or status information.

Runs asynchronously using two threads of execution. One to handle the low-level socket I/O and 3270 data stream processing to the host Tn3270 server, and the other to interface with the using program.

Does not have a visual interface (Servlets/JSP or bean classes would not use one). However, Bean3270API does provide an interface object which can be implemented by the user to receive notification that the screen, cursor or system status information has changed and what changes should be reflected in the visual display. This permits developers to create an terminal emulation GUI should they desire to do so.

Below is a summary of the Bean3270API method calls and a brief description of their function.

closeConnection()	Closes TCP/IP socket connection to the host Tn3270 server.
connectionErrorMsg()	Returns any connection error message or an empty string if no error has occurred.
dumpScreen()	Produces an formatted text representation of the current screen buffer.
dumpScreenHTML()	Produces an HTML formatted text representation of the current screen buffer.
getCursorCol()	Retrieve the current cursor column value.
getCursorPosition()	Retrieve the current cursor position as a screen buffer offset value.
getCursorRow()	Retrieve the current cursor row value.
getDisplayAttribute(offset)	Retrieves the display attribute bits of the character at the screen buffer offset specified.
getDisplayAttribute(row, col)	Retrieves the display attribute bits of the character at the screen buffer row and column specified.
getDisplayCharacter(offset)	Retrieves the display character from the screen buffer at the offset specified.
getDisplayCharacter(row, col)	Retrieves the display character from the screen buffer at the row and column specified.
getStatus()	Retrieves the current processing status as a formatted string.
getString(offset, len)	Retrieves the screen buffer contents beginning at the offset specified for the length specified. Any attribute bytes in the contents will be converted to a space character.
getString(row, col, len)	Retrieves the screen buffer contents beginning at the row and column specified for the length specified. Any attribute bytes in the contents will be converted to a space character.
getSystemTimeout()	Retrieves the current system time out value.
getTrace3270()	Retrieves the current status of Tn3270 data stream trace logging.
insertString(str)	Inserts the supplied string at the current cursor location in the scren buffer.
isConnected()	Retrieves the current connection status to the host Tn3270 server.
isKbdLocked()	Retrieves the current keyboard status.
kbdReset()	Unlocks the keyboard.
keyChar(char c)	Inserts the specified character into the screen buffer at the current cursor location.
keyClear()	Clears the contents of the current screen buffer and sends an AID key to the host.
keyDelete()	Sets the character in the screen buffer at the current cursor location to a space.
keyDeleteAll()	Sets all unprotected input fields in the screen buffer to space characters.
keyDeleteEof()	Sets the characters in the screen buffer to spaces from the current cursor position to the end of the current field.
keyDown()	Moves cursor down one row in the screen buffer.
keyEnter()	Sends all modified data in the screen buffer to the host.
keyFM()	Insert a Field Mark at the current cursor position.
keyHome()	Move cursor to the first character of the first unprotected field on the screen.
keyLeft()	Move cursor left one column on the current row of the screen buffer.
keyPA(keyNo)	Send a PA key (1-3) to the host.
keyPF(keyNo)	Send a PF key(1-24) to the host.
keyRight()	Move cursor right one column on the current row of the screen buffer.
keyTab(n)	Move cursor 'n' tab stops to the right (if n > 0) or to the left (if n < 0) of the current cursor position in the screen buffer..
keyUp()	Move cursor up on row in the screen buffer.
onScreen(row, target)	Determines if the supplied target string appears on the specified row of the screen buffer.
onScreen(target)	Determines if the supplied target string appears anywhere in the screen buffer.
openConnection(host)	Opens connection to the host Tn3270 server at the IP address (or host name) specified. The default telnet port of 23 is used.
openConnection(host, port)	Opens connection to the host Tn3270 serve at the IP address (or host name) and port specified.
setCursorPosition(offset)	Sets cursor position to the buffer offset specified.
setCursorPosition(row, col)	Sets cursor position to the row and column specified.
setDisplayCB(CB)	Sets the user implemented Bean3270CB callback object to be used.
setInsertMode(state)	Sets the keyboard insert mode on (true) or off (false).
setSystemTimeout(time)	Sets the desired system timeout value
setTrace3270(state)	Sets the desired Tn3270 trace status to on (true) or off (false).
waitBufferUpdated(time)	Waits for a change in screen buffer contents up to the specified time in milliseconds.
waitChangeRow(row, time)	Waits for a change in screen buffer contents on a specified row up to the specified time in milliseconds.
waitClearScreen(time)	Waits for the screen buffer contents to change to all spaces up to the specified time in milliseconds.
waitCursor(offset, time)	Waits for the cursor to be set to the specified buffer offset for up to the specified time in milliseconds.
waitCursor(row, col, time)	Waits for cursor to be set to the specified row and column for up to the specified time in milliseconds.
waitCursorUpdated(time)	Waits for a change in cursor position up the specified time in milliseconds.
waitString(row, col, target, time)	Will wait for the target string to appear in the screenbuffer at the row and column specified for up to the specified time in milliseconds.
waitString(target, time)	Waits for the target string to appear in the screen buffer for up to the specified time in milliseconds.
waitString(offset, target, time)	Will wait for the target string to appear in the screen buffer at the specified offset for up to the specified time in milliseconds.
waitString(target[], time)	Waits for one or more target strings to appear anywhere in the screen buffer for up to a specified time in milliseconds.
waitStringRow(target, row, time)	Waits for a target string to appear on the specified row of the screen buffer for up to the specified time in milliseconds.
waitStringRow(target[], row, time)	Waits for one or more target strings to appear on the specified row of the screen buffer for up to the specified time in milliseconds.

Home