HostSession (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.server.HostSession

All Implemented Interfaces:

HostSessionListener, HostSessionListener2
```
public class HostSession
extends Object
implements HostSessionListener2
```
The 3270 or 5250 (or EE) host session.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_AUTO_RECONNECT_ATTEMPTS` The default attempts count for auto reconnect session (default = 20).
`static int`	`DEFAULT_AUTO_RECONNECT_INTERVAL` The default interval used for auto reconnect session (in seconds, default = 3).
`static int`	`DEFAULT_KEEP_ALIVE_INTERVAL` The default interval used for Keep Alive (in seconds, default = 30).
`static int`	`DEFAULT_RECONNECT_TIMEOUT` The default timeout value for reconnecting a session in seconds (default = 30).

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearTypeAhead()` Clears the type-ahead buffer.
`boolean`	`connect()` Connects the session.
`boolean`	`disconnect()` Disconnects the session.
`void`	`displayHiddenText(boolean display)` Informs the session that hidden text should be displayed as bright red on black background.
`boolean`	`doesHostNeedFieldExit(int x, int y, int offset, int length, String string)` For 5250 only: checks if a field has the attributes that requires this particular string to enter the data followed by a "Field Exit" or "Field Minus" key.
`String`	`getAllowedCharacters()` Gets the string of characters that can be input by the user using the configured host code page for this session.
`HostSession3270Printer`	`getAssociated3270Printer()` Gets the 3270 printer session "associated" with this terminal session, null if no printer is associated.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos)` Gets the characters and attributes between two positions, including the end position.
`void`	`getCharactersAndAttributes(char[] chars, int[] attrbs, int beginPos, int endPos, char fieldOrNullChar)` Gets the characters and attributes between two positions, including the end position.
`ClientConnectionData`	`getClientConnectionData()` Gets the current client session data.
`ClientSession`	`getClientSession()` Gets the client session.
`Point`	`getCursor()` Gets the current host cursor position.
`String`	`getDeviceName()` Gets the device name of the session.
`int`	`getHostScreenLength()` Gets the current screen length (width * height).
`Dimension`	`getHostScreenSize()` Gets the host screen size.
`int`	`getIndex()` Gets the session index.
`ClientSession`	`getJavaClient()` Check if listener is client session and has a java client.
`String`	`getLastError(boolean doClear)` Gets the last error message of the session.
`String`	`getLastFailure()` Gets the last error state (failure, null for none).
`Object`	`getLockObject()` Gets the lock object for thread synchronization.
`boolean`	`getLogonState()` Get the logon state for the session.
`HostSessionPeer`	`getPeer()` Gets the peer.
`HostScreen`	`getScreen()` Gets the current host screen instance.
`String`	`getSessionID()` Gets the String representation of this session "A" to "Z".
`long`	`getSessionState()` Gets the host session state.
`String`	`getStringType()` Gets the type of session as a string (3270, 5250, EE, EE-3270 or EE-5250).
`int`	`getType()` Gets the type of session (0=3270, 1=5250, 2=EE).
`boolean`	`hasError()` Checks if there is an error state.
`boolean`	`hasFullDuplexClient()` Checks if the session has a full duplex Client (Java or JavaScript).
`boolean`	`hasJavaClient()` Checks if the session has a Java Client (used by printer sessions -- a printer session is not started for non-Java Clients).
`boolean`	`inInsertMode()` Checks if the keyboard is in insert mode or not.
`boolean`	`is3270()` Checks the session type against 3270.
`boolean`	`isConnected()` Checks for session currently connected.
`boolean`	`isConnecting()` Flag for session is processing a connect request.
`boolean`	`isCurrent()` Checks if this session is the current one.
`boolean`	`isFieldFormatted()` Checks if this host screen is field formatted.
`boolean`	`isHiddenTextDisplayed()` Checks if hidden text is displayed.
`boolean`	`isKeyboardInputAllowed()` Checks if the host session is locked for keyboard input.
`boolean`	`isLocked()` Checks if the host session is locked.
`boolean`	`isPrinter()` Checks if this is a printer or not.
`boolean`	`isProcessingDataStream()` Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.
`boolean`	`isReconnecting()` Check if the session is current being reconnected (e.g.
`boolean`	`isTypeAheadEnabled()` Checks if type-ahead is enabled for this session.
`boolean`	`isUser3270BoxDrawingEnabled()` Checks if 3270 box drawing is enabled.
`boolean`	`isUserPCInsertModeEnabled()` Checks if PC Insert mode is enabled.
`boolean`	`isUserSmartInsertModeEnabled()` Checks if Smart Insert mode is enabled.
`void`	`onConnectChange(HostSessionPeer peer, boolean connected)` Notifies the session of a connect state change.
`void`	`onCursorPositionChange(HostSessionPeer peer, int x, int y)` Notifies the session that the cursor position has changed.
`void`	`onFieldChange(HostSessionPeer peer)` Notifies the session that fields have changed.
`void`	`onHostDataStreamProcessing(HostSessionPeer peer, boolean isEntering)` Called when entering or exiting data stream processing.
`void`	`onHostError(HostSessionPeer peer, String text)` Notifies the session of an error condition.
`void`	`onHostPrintPage(HostSessionPeer peer)` Called when a host printer needs printing of a new page.
`void`	`onScreenChange(HostSessionPeer peer, int beginPos, int endPos)` Notifies the session of a screen change.
`void`	`onScreenSizeChange(HostSessionPeer peer, int cx, int cy)` Notifies the session that the screen size has changed.
`void`	`onSessionFailure(HostSessionPeer peer, String description)` Deprecated. as of NetPhantom Version 3.8
`void`	`onSessionFailure(HostSessionPeer peer, Throwable exception)` Called when a session has had a failure.
`void`	`onStateChange(HostSessionPeer peer)` Notifies the session of a state change (such as insert mode, lock state, error state).
`boolean`	`printSession()` Print terminal session.
`void`	`refreshHostFields(HostFields fields)` Refreshes the host fields of the current session.
`void`	`replaceManager(HostSessionManager manager)` Replaces the host session manager for this session.
`boolean`	`sendCharacterString(String keys)` Sends character keystrokes to host.
`boolean`	`sendCharacterString(String keys, boolean allowTypeAhead)` Sends character keystrokes to host without allowing type-ahead.
`boolean`	`sendKey(int key)` Sends keystrokes to host without allowing type-ahead.
`boolean`	`sendKey(int key, boolean allowTypeAhead)` Sends keystrokes to host.
`boolean`	`sendString(String keys)` Sends character keystrokes to host.
`boolean`	`sendString(String keys, boolean allowTypeAhead)` Sends character keystrokes to host.
`void`	`setAsCurrent(boolean current)` Sets or removes this session as the current one.
`boolean`	`setCursor(int x, int y)` Sets the host cursor position.
`boolean`	`setHostString(int x, int y, int offset, int length, String string)` Sets a string to a host field.
`boolean`	`setHostStringAsKeys(int x, int y, int offset, int length, String string)` Sets a string to a host field just as if the user typed the characters.
`boolean`	`setInsertMode(boolean on)` Sets the insert mode.
`void`	`setLastError(String errMsg)` Sets the last error message of the session.
`void`	`setLogonState(boolean state)` Set the logon state for the session.
`void`	`soundAlarm(HostSessionPeer peer)` Sound alarm on the client.

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

- Field Detail
  - DEFAULT_KEEP_ALIVE_INTERVAL
```
public static final int DEFAULT_KEEP_ALIVE_INTERVAL
```
    The default interval used for Keep Alive (in seconds, default = 30).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AUTO_RECONNECT_INTERVAL
```
public static final int DEFAULT_AUTO_RECONNECT_INTERVAL
```
    The default interval used for auto reconnect session (in seconds, default = 3).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_AUTO_RECONNECT_ATTEMPTS
```
public static final int DEFAULT_AUTO_RECONNECT_ATTEMPTS
```
    The default attempts count for auto reconnect session (default = 20).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RECONNECT_TIMEOUT
```
public static final int DEFAULT_RECONNECT_TIMEOUT
```
    The default timeout value for reconnecting a session in seconds (default = 30).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getType
```
public int getType()
```
    Gets the type of session (0=3270, 1=5250, 2=EE).
  - getStringType
```
public String getStringType()
```
    Gets the type of session as a string (3270, 5250, EE, EE-3270 or EE-5250).
  - is3270
```
public boolean is3270()
```
    Checks the session type against 3270. If no session type is available, 3270 is assumed.
  - isConnected
```
public boolean isConnected()
```
    Checks for session currently connected.
  - isConnecting
```
public boolean isConnecting()
```
    Flag for session is processing a connect request.
  - isReconnecting
```
public boolean isReconnecting()
```
    Check if the session is current being reconnected (e.g. to avoid logging of host sessions being established, disconnected).
    
    Specified by:
    
    isReconnecting in interface HostSessionListener2
  - isCurrent
```
public boolean isCurrent()
```
    Checks if this session is the current one.
  - connect
```
public boolean connect()
```
    Connects the session.
  - disconnect
```
public boolean disconnect()
```
    Disconnects the session.
  - getLastFailure
```
public String getLastFailure()
```
    Gets the last error state (failure, null for none).
  - sendString
```
public boolean sendString(String keys)
```
    Sends character keystrokes to host.
  - sendString
```
public boolean sendString(String keys,
                          boolean allowTypeAhead)
```
    Sends character keystrokes to host.
  - sendCharacterString
```
public boolean sendCharacterString(String keys)
```
    Sends character keystrokes to host.
  - sendCharacterString
```
public boolean sendCharacterString(String keys,
                                   boolean allowTypeAhead)
```
    Sends character keystrokes to host without allowing type-ahead.
  - isTypeAheadEnabled
```
public boolean isTypeAheadEnabled()
```
    Checks if type-ahead is enabled for this session.
  - sendKey
```
public boolean sendKey(int key)
```
    Sends keystrokes to host without allowing type-ahead.
    
    See Also:
    
    HostSendKeys
  - sendKey
```
public boolean sendKey(int key,
                       boolean allowTypeAhead)
```
    Sends keystrokes to host.
    
    See Also:
    
    HostSendKeys
  - printSession
```
public boolean printSession()
```
    Print terminal session.
    
    Returns:
    
    false if this is not a Java client session, true otherwise.
  - doesHostNeedFieldExit
```
public boolean doesHostNeedFieldExit(int x,
                                     int y,
                                     int offset,
                                     int length,
                                     String string)
```
    For 5250 only: checks if a field has the attributes that requires this particular string to enter the data followed by a "Field Exit" or "Field Minus" key. For 3270 it's always false.
  - setHostString
```
public boolean setHostString(int x,
                             int y,
                             int offset,
                             int length,
                             String string)
```
    Sets a string to a host field.
  - setHostStringAsKeys
```
public boolean setHostStringAsKeys(int x,
                                   int y,
                                   int offset,
                                   int length,
                                   String string)
```
    Sets a string to a host field just as if the user typed the characters. The host field is first cleared with (3270) Clear EOF or (5250) Field Exit or Field Minus (for negative numbers in a numeric field). The string is then entered as a set of keystrokes, followed by a potential Field Exit or Field Minus (for negative numbers in a numeric field), but only for 5250.
  - setCursor
```
public boolean setCursor(int x,
                         int y)
```
    Sets the host cursor position.
  - getCursor
```
public Point getCursor()
```
    Gets the current host cursor position.
  - displayHiddenText
```
public void displayHiddenText(boolean display)
```
    Informs the session that hidden text should be displayed as bright red on black background.
  - isHiddenTextDisplayed
```
public boolean isHiddenTextDisplayed()
```
    Checks if hidden text is displayed.
  - getCharactersAndAttributes
```
public void getCharactersAndAttributes(char[] chars,
                                       int[] attrbs,
                                       int beginPos,
                                       int endPos)
```
    Gets the characters and attributes between two positions, including the end position.
  - getCharactersAndAttributes
```
public void getCharactersAndAttributes(char[] chars,
                                       int[] attrbs,
                                       int beginPos,
                                       int endPos,
                                       char fieldOrNullChar)
```
    Gets the characters and attributes between two positions, including the end position. The character "fieldOrNullChar" is the character that will be used instead of field attributes and null characters.
  - setAsCurrent
```
public void setAsCurrent(boolean current)
```
    Sets or removes this session as the current one.
  - onScreenChange
```
public void onScreenChange(HostSessionPeer peer,
                           int beginPos,
                           int endPos)
```
    Notifies the session of a screen change.
    
    Specified by:
    
    onScreenChange in interface HostSessionListener
  - onFieldChange
```
public void onFieldChange(HostSessionPeer peer)
```
    Notifies the session that fields have changed.
    
    Specified by:
    
    onFieldChange in interface HostSessionListener
  - onScreenSizeChange
```
public void onScreenSizeChange(HostSessionPeer peer,
                               int cx,
                               int cy)
```
    Notifies the session that the screen size has changed.
    
    Specified by:
    
    onScreenSizeChange in interface HostSessionListener
  - onCursorPositionChange
```
public void onCursorPositionChange(HostSessionPeer peer,
                                   int x,
                                   int y)
```
    Notifies the session that the cursor position has changed.
    
    Specified by:
    
    onCursorPositionChange in interface HostSessionListener
  - onConnectChange
```
public void onConnectChange(HostSessionPeer peer,
                            boolean connected)
```
    Notifies the session of a connect state change.
    
    Specified by:
    
    onConnectChange in interface HostSessionListener
  - onHostError
```
public void onHostError(HostSessionPeer peer,
                        String text)
```
    Notifies the session of an error condition.
    
    Specified by:
    
    onHostError in interface HostSessionListener
  - onStateChange
```
public void onStateChange(HostSessionPeer peer)
```
    Notifies the session of a state change (such as insert mode, lock state, error state).
    
    Specified by:
    
    onStateChange in interface HostSessionListener
  - getScreen
```
public HostScreen getScreen()
```
    Gets the current host screen instance.
  - getHostScreenSize
```
public Dimension getHostScreenSize()
```
    Gets the host screen size.
  - getHostScreenLength
```
public int getHostScreenLength()
```
    Gets the current screen length (width * height).
  - getSessionState
```
public long getSessionState()
```
    Gets the host session state.
  - isLocked
```
public boolean isLocked()
```
    Checks if the host session is locked.
  - isKeyboardInputAllowed
```
public boolean isKeyboardInputAllowed()
```
    Checks if the host session is locked for keyboard input. Keyboard input is allowed for 5250 sessions when in System Request mode or the Attention key is sent.
  - hasError
```
public boolean hasError()
```
    Checks if there is an error state.
  - inInsertMode
```
public boolean inInsertMode()
```
    Checks if the keyboard is in insert mode or not.
  - refreshHostFields
```
public void refreshHostFields(HostFields fields)
```
    Refreshes the host fields of the current session. The host session will add all available host fields sorted left to right, top to bottom.
  - getClientConnectionData
```
public ClientConnectionData getClientConnectionData()
```
    Gets the current client session data.
    
    Specified by:
    
    getClientConnectionData in interface HostSessionListener
  - getIndex
```
public int getIndex()
```
    Gets the session index.
    
    Specified by:
    
    getIndex in interface HostSessionListener
  - getSessionID
```
public String getSessionID()
```
    Gets the String representation of this session "A" to "Z".
  - getLogonState
```
public boolean getLogonState()
```
    Get the logon state for the session.
  - setLogonState
```
public void setLogonState(boolean state)
```
    Set the logon state for the session.
  - soundAlarm
```
public void soundAlarm(HostSessionPeer peer)
```
    Sound alarm on the client.
    
    Specified by:
    
    soundAlarm in interface HostSessionListener
  - onSessionFailure
```
@Deprecated
public void onSessionFailure(HostSessionPeer peer,
                                          String description)
```
    Deprecated. as of NetPhantom Version 3.8
    
    Called when a session has had a failure.
    
    Specified by:
    
    onSessionFailure in interface HostSessionListener
  - onSessionFailure
```
public void onSessionFailure(HostSessionPeer peer,
                             Throwable exception)
```
    Called when a session has had a failure.
    
    Specified by:
    
    onSessionFailure in interface HostSessionListener2
  - getLastError
```
public String getLastError(boolean doClear)
```
    Gets the last error message of the session.
    
    Returns:
    
    null if the session doesn't support it (3270 doesn't).
  - setLastError
```
public void setLastError(String errMsg)
```
    Sets the last error message of the session.
  - getLockObject
```
public Object getLockObject()
```
    Gets the lock object for thread synchronization.
    
    Specified by:
    
    getLockObject in interface HostSessionListener
  - getDeviceName
```
public String getDeviceName()
```
    Gets the device name of the session.
    
    Returns:
    
    null if no device name exists.
  - isPrinter
```
public boolean isPrinter()
```
    Checks if this is a printer or not.
  - onHostPrintPage
```
public void onHostPrintPage(HostSessionPeer peer)
```
    Called when a host printer needs printing of a new page.
    
    Specified by:
    
    onHostPrintPage in interface HostSessionListener
  - getPeer
```
public HostSessionPeer getPeer()
```
    Gets the peer.
    Note that manipulation of the peer directly needs synchronization of that object.
  - hasFullDuplexClient
```
public boolean hasFullDuplexClient()
```
    Checks if the session has a full duplex Client (Java or JavaScript).
    
    Specified by:
    
    hasFullDuplexClient in interface HostSessionListener
  - hasJavaClient
```
public boolean hasJavaClient()
```
    Checks if the session has a Java Client (used by printer sessions -- a printer session is not started for non-Java Clients).
    
    Specified by:
    
    hasJavaClient in interface HostSessionListener
  - getJavaClient
```
public ClientSession getJavaClient()
```
    Check if listener is client session and has a java client.
    
    Returns:
    
    client session or null for none.
  - getClientSession
```
public ClientSession getClientSession()
```
    Gets the client session.
    
    Returns:
    
    client session or null for none.
  - clearTypeAhead
```
public void clearTypeAhead()
```
    Clears the type-ahead buffer.
  - setInsertMode
```
public boolean setInsertMode(boolean on)
```
    Sets the insert mode.
    
    Returns:
    
    true for success, false for failure.
  - replaceManager
```
public void replaceManager(HostSessionManager manager)
```
    Replaces the host session manager for this session.
  - isProcessingDataStream
```
public boolean isProcessingDataStream()
```
    Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.
  - onHostDataStreamProcessing
```
public void onHostDataStreamProcessing(HostSessionPeer peer,
                                       boolean isEntering)
```
    Called when entering or exiting data stream processing.
    
    Specified by:
    
    onHostDataStreamProcessing in interface HostSessionListener
  - isUser3270BoxDrawingEnabled
```
public boolean isUser3270BoxDrawingEnabled()
```
    Checks if 3270 box drawing is enabled.
    
    Specified by:
    
    isUser3270BoxDrawingEnabled in interface HostSessionListener
  - isUserSmartInsertModeEnabled
```
public boolean isUserSmartInsertModeEnabled()
```
    Checks if Smart Insert mode is enabled.
    
    Specified by:
    
    isUserSmartInsertModeEnabled in interface HostSessionListener
  - isUserPCInsertModeEnabled
```
public boolean isUserPCInsertModeEnabled()
```
    Checks if PC Insert mode is enabled.
    
    Specified by:
    
    isUserPCInsertModeEnabled in interface HostSessionListener
  - getAllowedCharacters
```
public String getAllowedCharacters()
```
    Gets the string of characters that can be input by the user using the configured host code page for this session.
    If the return string is empty, for the EE package for example, all characters are "inputable".
  - isFieldFormatted
```
public boolean isFieldFormatted()
```
    Checks if this host screen is field formatted. This method is not like the one in HostScreen, this one checks directly to see if any fields are present.
  - getAssociated3270Printer
```
public HostSession3270Printer getAssociated3270Printer()
```
    Gets the 3270 printer session "associated" with this terminal session, null if no printer is associated.

Class HostSession

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_KEEP_ALIVE_INTERVAL

DEFAULT_AUTO_RECONNECT_INTERVAL

DEFAULT_AUTO_RECONNECT_ATTEMPTS

DEFAULT_RECONNECT_TIMEOUT

Method Detail

getType

getStringType

is3270

isConnected

isConnecting

isReconnecting

isCurrent

connect

disconnect

getLastFailure

sendString

sendString

sendCharacterString

sendCharacterString

isTypeAheadEnabled

sendKey

sendKey

printSession

doesHostNeedFieldExit

setHostString

setHostStringAsKeys

setCursor

getCursor

displayHiddenText

isHiddenTextDisplayed

getCharactersAndAttributes

getCharactersAndAttributes

setAsCurrent

onScreenChange

onFieldChange

onScreenSizeChange

onCursorPositionChange

onConnectChange

onHostError

onStateChange

getScreen

getHostScreenSize

getHostScreenLength

getSessionState

isLocked

isKeyboardInputAllowed

hasError

inInsertMode

refreshHostFields

getClientConnectionData

getIndex

getSessionID

getLogonState

setLogonState

soundAlarm

onSessionFailure

onSessionFailure

getLastError

setLastError

getLockObject

getDeviceName

isPrinter

onHostPrintPage

getPeer

hasFullDuplexClient

hasJavaClient

getJavaClient

getClientSession

clearTypeAhead

setInsertMode

replaceManager

isProcessingDataStream

onHostDataStreamProcessing

isUser3270BoxDrawingEnabled

isUserSmartInsertModeEnabled