RW3270 (FreeHost3270 modules suite 0.2-CURRENT API)

java.lang.Object
- net.sf.freehost3270.client.RW3270

```
public class RW3270
extends Object
```
This class represents a 3270 session to client implementations, and is the main API for creating 3270 applications.

Since:

0.1

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`AID_NO`
`static short`	`AID_READ_PARTITION`
`static short`	`AID_SF`
`static short`	`AID_TRIGGER`
`static short`	`CLEAR`
`static short`	`CLEAR_PARTITION`
`static short`	`ENTER`
`static short`	`PA1`
`static short`	`PA2`
`static short`	`PA3`
`static short`	`PF1`
`static short`	`PF10`
`static short`	`PF11`
`static short`	`PF12`
`static short`	`PF13`
`static short`	`PF14`
`static short`	`PF15`
`static short`	`PF16`
`static short`	`PF17`
`static short`	`PF18`
`static short`	`PF19`
`static short`	`PF2`
`static short`	`PF20`
`static short`	`PF21`
`static short`	`PF22`
`static short`	`PF23`
`static short`	`PF24`
`static short`	`PF3`
`static short`	`PF4`
`static short`	`PF5`
`static short`	`PF6`
`static short`	`PF7`
`static short`	`PF8`
`static short`	`PF9`
`static short`	`SYSREQ`

Constructor Summary

Constructors
Constructor and Description

RW3270(int modelNumber, RWTnAction client)
Constructor.

RW3270(RWTnAction client)
Default constructor.

Constructors
Constructor and Description
`RW3270(int modelNumber, RWTnAction client)` Constructor.
`RW3270(RWTnAction client)` Default constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`backspace()` Deletes the current character (by setting it to ' ') and decrements the cursor position by one.
`void`	`backTab()` This method sets the cursor position to the first character position of the last unprotected field.
`void`	`clear()` Executes the tn3270 clear command
`void`	`connect(String host, int port)` This method implements connections directly to a host, bypassing the SessionServer.
`void`	`connect(String host, int port, String host3270, int port3270, boolean encryption)` This method attempts to connect this 3270 object to the specified SessionServer and 3270 Host.
`boolean`	`contains(String search)` Searches the current data buffer (screen) for the specified string.
`void`	`delete()` Deletes the current character (by setting it to ' ').
`void`	`disconnect()` Disconnects this RW3270 object from the current Session.
`void`	`down()` Moves the cursor position 'down' one row from it's current position.
`void`	`enter()` Presses the 'enter' key on the terminal.
`short`	`getAID()` DOCUMENT ME!
`RW3270Char`	`getChar()` This method returns the RW3270Char object at the current cursor position
`RW3270Char`	`getChar(int i)` This method is useful for retrieving the RW3270 character object at a particular position on the screen.
`int`	`getCols()` DOCUMENT ME!
`int`	`getCursorPosition()` DOCUMENT ME!
`RW3270Char[]`	`getDataBuffer()` Returns an array of RW3270Char objects representing the data buffer.
`char[]`	`getDisplay()` Gets the current screen's display characters.
`RW3270Field`	`getField()` This method returns the RW3270Field object that the current cursor position is in.
`RW3270Field`	`getField(int i)` This method returns the RW3270Field object at the specified buffer address
`Vector`	`getFields()` Returns a vector of fields representing the current 3270 screen.
`short`	`getNextUnprotectedField(int pos)` Returns the first character position of the next unprotected field from the current cursor position.
`protected short`	`getPreviousUnprotectedField(int pos)` This method returns the first character position of the previous field from the current cursor position.
`int`	`getRows()` DOCUMENT ME!
`protected RWTelnet`	`getTelnet()`
`void`	`home()` This method moves the cursor to the first character of the first unprotected field in the data buffer.
`boolean`	`isKeyboardLocked()` This method is designed to let implementations check to see if the 'keyboard' is currently locked.
`void`	`keyFieldMark()`
`void`	`keyNewLine()`
`void`	`left()` Moves the cursor position one character to the left, wrapping when necessary.
`protected void`	`lockKeyboard()`
`void`	`PA(int key)` Presses the specified PA Key, as specified in the constants for this class.
`void`	`PF(int key)` Presses the specified PF Key, as specified in the constants for this class.
`void`	`reset()`
`protected void`	`resumeParentThread()`
`void`	`right()` Moves the cursor position one character to the right, wrapping when necessary.
`void`	`run()`
`void`	`setCursorPosition(short newCursorPos)` This method sets the cursor position.
`void`	`setEncryption(boolean encryption)` Sets the encryption setting for the 3270 session...
`void`	`setSessionData(String key, String value)` Sets session data on the session server
`void`	`sysreq()` Executes the sysreq command
`void`	`tab()` Advances the cursor position to the first character position of the next unprotected field.
`String`	`toString()` Returns a string representation of the current 3270 screen state.
`void`	`type(char key)` Inserts the specified ASCII character at the current cursor position if the current field is unprotected, and advances the cursor position by one.
`protected void`	`unlockKeyboard()`
`void`	`up()` Moves the cursor position 'up' one row from it's current position.
`boolean`	`waitFor(String search, int timeout)` Blocks until the specified string is found in the data buffer (screen) or until the specified timeout is reached.
`void`	`waitForNewData()` Blocks the currently executing thread until new data arrives from the host.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AID_NO
```
public static final short AID_NO
```
    See Also:
    Constant Field Values
  - AID_SF
```
public static final short AID_SF
```
    See Also:
    Constant Field Values
  - AID_READ_PARTITION
```
public static final short AID_READ_PARTITION
```
    See Also:
    Constant Field Values
  - AID_TRIGGER
```
public static final short AID_TRIGGER
```
    See Also:
    Constant Field Values
  - SYSREQ
```
public static final short SYSREQ
```
    See Also:
    Constant Field Values
  - PF1
```
public static final short PF1
```
    See Also:
    Constant Field Values
  - PF2
```
public static final short PF2
```
    See Also:
    Constant Field Values
  - PF3
```
public static final short PF3
```
    See Also:
    Constant Field Values
  - PF4
```
public static final short PF4
```
    See Also:
    Constant Field Values
  - PF5
```
public static final short PF5
```
    See Also:
    Constant Field Values
  - PF6
```
public static final short PF6
```
    See Also:
    Constant Field Values
  - PF7
```
public static final short PF7
```
    See Also:
    Constant Field Values
  - PF8
```
public static final short PF8
```
    See Also:
    Constant Field Values
  - PF9
```
public static final short PF9
```
    See Also:
    Constant Field Values
  - PF10
```
public static final short PF10
```
    See Also:
    Constant Field Values
  - PF11
```
public static final short PF11
```
    See Also:
    Constant Field Values
  - PF12
```
public static final short PF12
```
    See Also:
    Constant Field Values
  - PF13
```
public static final short PF13
```
    See Also:
    Constant Field Values
  - PF14
```
public static final short PF14
```
    See Also:
    Constant Field Values
  - PF15
```
public static final short PF15
```
    See Also:
    Constant Field Values
  - PF16
```
public static final short PF16
```
    See Also:
    Constant Field Values
  - PF17
```
public static final short PF17
```
    See Also:
    Constant Field Values
  - PF18
```
public static final short PF18
```
    See Also:
    Constant Field Values
  - PF19
```
public static final short PF19
```
    See Also:
    Constant Field Values
  - PF20
```
public static final short PF20
```
    See Also:
    Constant Field Values
  - PF21
```
public static final short PF21
```
    See Also:
    Constant Field Values
  - PF22
```
public static final short PF22
```
    See Also:
    Constant Field Values
  - PF23
```
public static final short PF23
```
    See Also:
    Constant Field Values
  - PF24
```
public static final short PF24
```
    See Also:
    Constant Field Values
  - PA1
```
public static final short PA1
```
    See Also:
    Constant Field Values
  - PA2
```
public static final short PA2
```
    See Also:
    Constant Field Values
  - PA3
```
public static final short PA3
```
    See Also:
    Constant Field Values
  - CLEAR
```
public static final short CLEAR
```
    See Also:
    Constant Field Values
  - CLEAR_PARTITION
```
public static final short CLEAR_PARTITION
```
    See Also:
    Constant Field Values
  - ENTER
```
public static final short ENTER
```
    See Also:
    Constant Field Values
- Constructor Detail
  - RW3270
```
public RW3270(RWTnAction client)
```
    Default constructor. Assumes Tn3270 model 2 (80 x 24)
    
    Parameters:
    client - RWTnAction interface used for communicating with the client implementation
  - RW3270
```
public RW3270(int modelNumber,
      RWTnAction client)
```
    Constructor. Sets the model type of the new 3270 object.
    - 2: 24x80
    - 3: 32x80
    - 4: 43x80
    - 5: 27x132
    Parameters:
    modelNumber - the 3270 model number.
    client - RWTnAction interface used for communicating with the client implementation.
- Method Detail
  - PA
```
public void PA(int key)
```
    Presses the specified PA Key, as specified in the constants for this class. For example to press PA1, call rw.PA(RW3270.PA1);
    
    Parameters:
    key - - the key to be pressed, as specified in the constants for this class.
  - PF
```
public void PF(int key)
```
    Presses the specified PF Key, as specified in the constants for this class. For example to press PF1, call rw.PF(RW3270.PF1);
    
    Parameters:
    key - - the key to be pressed, as specified in the constants for this class.
  - backTab
```
public void backTab()
```
    This method sets the cursor position to the first character position of the last unprotected field.
  - backspace
```
public void backspace()
               throws IsProtectedException
```
    Deletes the current character (by setting it to ' ') and decrements the cursor position by one.
    
    Throws:
    
    IsProtectedException - if the current field is protected.
  - clear
```
public void clear()
```
    Executes the tn3270 clear command
  - connect
```
public void connect(String host,
           int port,
           String host3270,
           int port3270,
           boolean encryption)
```
    This method attempts to connect this 3270 object to the specified SessionServer and 3270 Host.
    IMPORTANT: this setting must match the SessionServer's encryption setting in order to communicate successfully. the current encryption setting of the SessionServer can be obtained by calling >SessionServer<.getEncryption()
    
    Parameters:
    host - the hostname or ip address of the SessionServer
    port - the SessionServer's port
    host3270 - the hostname or ip address of the 3270 host. (If using SessionServer)
    port3270 - the port of the 3270 host
    encryption - true if encryption should be used, false otherwise.
  - connect
```
public void connect(String host,
           int port)
             throws IOException,
                    UnknownHostException
```
    This method implements connections directly to a host, bypassing the SessionServer.
    
    Parameters:
    host - The hostname of the TN3270 host to connect to
    port - The port on which to connect to the TN3270 host
    
    Throws:
    
    IOException - DOCUMENT ME!
    
    UnknownHostException - DOCUMENT ME!
  - contains
```
public boolean contains(String search)
```
    Searches the current data buffer (screen) for the specified string.
    
    Parameters:
    search - The string to search the data buffer for.
    
    Returns:
    true if the string was found, false otherwise.
  - delete
```
public void delete()
            throws IsProtectedException
```
    Deletes the current character (by setting it to ' ').
    
    Throws:
    
    IsProtectedException - if the current field is protected.
  - disconnect
```
public void disconnect()
```
    Disconnects this RW3270 object from the current Session.
  - down
```
public void down()
```
    Moves the cursor position 'down' one row from it's current position.
    For example, in an 80-column screen, calling the down() mehtod will increase the cursor position by 80. This method will 'wrap' from the last row to the first row
  - enter
```
public void enter()
```
    Presses the 'enter' key on the terminal.
    This sets the AID to ENTER, and fires off a Read Modified command on the current buffer.
  - getAID
```
public short getAID()
```
    DOCUMENT ME!
    
    Returns:
    The current AID, or 0x00 for none.
  - getChar
```
public RW3270Char getChar(int i)
```
    This method is useful for retrieving the RW3270 character object at a particular position on the screen.
    
    Parameters:
    i - Screen position of the requested RW3270Char object
    
    Returns:
    RW3270Char object
  - getChar
```
public RW3270Char getChar()
```
    This method returns the RW3270Char object at the current cursor position
    
    Returns:
    RW3270Char Object.
  - getCols
```
public int getCols()
```
    DOCUMENT ME!
    
    Returns:
    The number of cols in the current screen (Set by TN3270 model number)
  - getCursorPosition
```
public int getCursorPosition()
```
    DOCUMENT ME!
    
    Returns:
    The current cursor position
  - getDataBuffer
```
public RW3270Char[] getDataBuffer()
```
    Returns an array of RW3270Char objects representing the data buffer.
    
    Returns:
    the RW3270Char array
  - getDisplay
```
public char[] getDisplay()
```
    Gets the current screen's display characters. This method is useful for getting the characters necessary for display in the client implementation. It automatically suppresses hidden (password, etc.) fields and null characters.
    
    Returns:
    The current 3270 screen as an array of characters.
  - getField
```
public RW3270Field getField()
```
    This method returns the RW3270Field object that the current cursor position is in.
    
    Returns:
    RW3270Field object.
  - getField
```
public RW3270Field getField(int i)
```
    This method returns the RW3270Field object at the specified buffer address
    
    Parameters:
    i - Screen position of the requested RW3270Field Object.
    
    Returns:
    RW3270Field object
  - getFields
```
public Vector getFields()
```
    Returns a vector of fields representing the current 3270 screen.
    
    Returns:
    the field Vector
  - getNextUnprotectedField
```
public short getNextUnprotectedField(int pos)
```
    Returns the first character position of the next unprotected field from the current cursor position.
    
    Parameters:
    pos - DOCUMENT ME!
    
    Returns:
    The next unprotected field's address, starting from the current cursor position.
  - getRows
```
public int getRows()
```
    DOCUMENT ME!
    
    Returns:
    The number of rows in the current screen (Set by TN3270 model number)
  - home
```
public void home()
```
    This method moves the cursor to the first character of the first unprotected field in the data buffer.
  - isKeyboardLocked
```
public boolean isKeyboardLocked()
```
    This method is designed to let implementations check to see if the 'keyboard' is currently locked.
    
    Returns:
    true if the screen is not currently accepting input, false if it is.
  - keyFieldMark
```
public void keyFieldMark()
```
  - keyNewLine
```
public void keyNewLine()
```
  - left
```
public void left()
```
    Moves the cursor position one character to the left, wrapping when necessary. Returns without moving the cursor if the terminal is currently locked.
  - reset
```
public void reset()
```
  - right
```
public void right()
```
    Moves the cursor position one character to the right, wrapping when necessary.
    Returns without moving the cursor if the terminal is currently locked.
  - run
```
public void run()
```
  - setCursorPosition
```
public void setCursorPosition(short newCursorPos)
```
    This method sets the cursor position.
    
    Parameters:
    newCursorPos - The new cursor position
  - setEncryption
```
public void setEncryption(boolean encryption)
```
    Sets the encryption setting for the 3270 session...
    
    Parameters:
    encryption - will turn encryption on, false will turn encryption off
  - setSessionData
```
public void setSessionData(String key,
                  String value)
```
    Sets session data on the session server
    
    Parameters:
    key - DOCUMENT ME!
    value - DOCUMENT ME!
  - sysreq
```
public void sysreq()
```
    Executes the sysreq command
  - tab
```
public void tab()
```
    Advances the cursor position to the first character position of the next unprotected field.
  - toString
```
public String toString()
```
    Returns a string representation of the current 3270 screen state.
    The returned string is a unique description of the terminal screen contents.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    DOCUMENT ME!
    Since:
    
    0.2
  - type
```
public void type(char key)
          throws IsProtectedException
```
    Inserts the specified ASCII character at the current cursor position if the current field is unprotected, and advances the cursor position by one. This is useful for implementations that accept keyboard input directly. For implementations that don't require character-by-character input, use RW3270Field.setData(String data) instead.
    
    Parameters:
    key - keyboard/ASCII character corresponding to the key pressed.
    
    Throws:
    
    IsProtectedException - if the current field is protected.
    See Also:
    RW3270Field
  - up
```
public void up()
```
    Moves the cursor position 'up' one row from it's current position.
    For example, in an 80-column screen, calling the up() mehtod will decrease the cursor position by 80. This method will 'wrap' from the first row to the last row
  - waitFor
```
public boolean waitFor(String search,
              int timeout)
```
    Blocks until the specified string is found in the data buffer (screen) or until the specified timeout is reached.
    This method is extrememly useful when the host may be sending several screens in response to your request, and you want to block until you reach the response you're waiting for. For example:
```
 ...
 // Create a RW3270 object
        RW3270 rw = new RW3270(this);
 // Connect to the SessionServer and specify a host
 rw.connect("3.3.88.3", 6870, "hollis.harvard.edu", 23, true);
 // This will block for 30 seconds or until the string
 // H A R V A R D is found.  it also returns a boolean to
 // let us check the results
 boolean t = rw.waitFor("H A R V A R D", 30);
 // Now we'll execute two different blocks of code depending
 // on whether our string was found:
 if(t) {
   out.print("Got it:");
   out.print(new String(rw.getDisplay()));
 } else {
   out.print("Didn't get it:>");
   out.print(new String(rw.getDisplay()));
 }
 
```
    Parameters:
    search - the string to wait for.
    timeout - number of seconds to wait for the search string.
    
    Returns:
    true if the string was found, false if the timeout was reached without finding it.
  - waitForNewData
```
public void waitForNewData()
```
    Blocks the currently executing thread until new data arrives from the host.
    This method is useful when using stateless client implementations (i.e. HTTP) or when you're scripting through several 3270 screens.
    
    For example:
```
 ...
 //Set the value of a field and press enter
 RW3270Field.setData("My Data");
 RW3270.enter();
 //Wait for the new screen
 RW3270.waitForNewData();
 myClient.paintScreen()....
 
```
    IMPORTANT: This method only blocks until the 3270 engine has received a response from the host and processed it. In the case where the host has sent an EraseAllUnprotected or other Non-Data type command, this method will return normally, even though the DataBuffer (screen) may be empty. Client implementations need to handle any host-specific anomalies such as screen clears, etc.
  - getPreviousUnprotectedField
```
protected short getPreviousUnprotectedField(int pos)
```
    This method returns the first character position of the previous field from the current cursor position.
    
    Parameters:
    pos - DOCUMENT ME!
    
    Returns:
    The previous unprotected field's address, starting from the current cursor position
  - getTelnet
```
protected RWTelnet getTelnet()
```
  - lockKeyboard
```
protected void lockKeyboard()
```
  - resumeParentThread
```
protected void resumeParentThread()
```
  - unlockKeyboard
```
protected void unlockKeyboard()
```

Class RW3270

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AID_NO

AID_SF

AID_READ_PARTITION

AID_TRIGGER

SYSREQ

PF1

PF2

PF3

PF4

PF5

PF6

PF7

PF8

PF9

PF10

PF11

PF12

PF13

PF14

PF15

PF16

PF17

PF18

PF19

PF20

PF21

PF22

PF23

PF24

PA1

PA2

PA3

CLEAR

CLEAR_PARTITION

ENTER

Constructor Detail

RW3270

RW3270

Method Detail

PA

PF

backTab

backspace

clear

connect

connect

contains

delete

disconnect

down

enter

getAID

getChar

getChar

getCols

getCursorPosition

getDataBuffer

getDisplay

getField

getField

getFields

getNextUnprotectedField

getRows

home

isKeyboardLocked

keyFieldMark

keyNewLine

left

reset

right

run

setCursorPosition

setEncryption

setSessionData