se.entra.phantom.server

Class HostSession3270

java.lang.Object

se.entra.phantom.server.HostSession3270

All Implemented Interfaces:

HostSessionPeer, TelnetInterface

Direct Known Subclasses:

HostSession3270Printer

public class HostSession3270
extends Object
implements HostSessionPeer, TelnetInterface

The 3270 host session peer.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	address The host IP address to connect to.
DataStream3270	dataStream The 3270 data stream instance.
Display3270	display The 3270 display instance.
protected boolean	doTN3270E Flag indicating usage of TN3270E.
CodepageConverter	ebcdicConverter The codepage mapper.
int	graphicalCodepage The graphical code page, zero if not set.
HostSessionListener2	listener The host session listener.
protected String	peerData Stored additional PeerData.
protected int	port The host port (default is 23 for Mainframe) to connect to.
TelnetHost	telnet The telnet thread, doing the actual conversation.
protected Class<?>	telnetHostClass The telnet host class.

Fields inherited from interface se.entra.phantom.server.HostSessionPeer

STATE_CommunicationCheck, STATE_CommunicationsError, STATE_Error, STATE_FieldFullError, STATE_InsertMode, STATE_KeyboardShift, STATE_Lock, STATE_LULUOwned, STATE_MachineCheck, STATE_MessageWaiting, STATE_MinusError, STATE_MinusErrorXfStickman, STATE_NonNumericError, STATE_OnFieldOrProtected, STATE_OnlineNotOwned, STATE_ProgramCheck, STATE_ReceiveWait, STATE_Secure, STATE_Sending, STATE_SSCPLUOwned, STATE_SystemAvailable

Method Summary

Modifier and Type	Method and Description
boolean	connect() Connects the session to host.
protected void	createDataStream() Create the data stream.
boolean	disconnect() Disconnects the session from host.
void	displayHiddenText(boolean display) Informs the session that hidden text should be displayed as bright red on black background.
boolean	doesFieldHaveExtendedAttributes(HostField hostField) Checks if a host field has extended attributes or not.
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.
boolean	doNumericFieldOverride() Checks for 3270 numeric field override.
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 client connection data.
int	getClientHostFieldFlags(HostField hostField) Gets flags that are required for the client host fields for local editing, etc.
Point	getCursor() Gets the current host cursor position.
String	getDeviceName() Gets the device name of the session.
int	getHomeAddress() Gets the host address index on the screen.
String	getHostAddress() Returns the host destination address for the session.
int	getHostPort() Returns the Telnet port number.
HostSessionListener2	getHostSessionListener() Gets the host session listener.
String	getLastError(boolean doClear) Gets the last error message of the session.
int	getNewCharAttribute(HostField hostField) Gets the attribute to use for new characters in a field that contains extended attributes (always zero for non-3270).
int	getScreenLength() Gets the current screen length (width * height).
Dimension	getScreenSize() Gets the current screen size.
int	getSessionID() Gets the session ID (or index) of this session.
long	getSessionState() Gets the current session state.
void	hostAcceptedDataStream(String terminalType) The host accepted the options for the terminal type and went into BINARY mode.
void	initiate(HostSessionListener listener, String address, int port, String peerData) Deprecated. As of version 3.8, use method using HostSessionListener2.
void	initiate2(HostSessionListener2 listener, String address, int port, String peerData) Initiates an instance of the host session, but does not connect to the host.
void	initiateLocalCopy() Initiates a local copy of the current PS to the printer.
boolean	is3270() Checks if a session is 3270 or 5250.
boolean	isAutoReconnectSessionEnabled() Checks if the use of auto reconnect session is handled or not.
boolean	isFieldFormatted() Checks if this host screen is field formatted.
boolean	isHiddenTextDisplayed() Checks if hidden text is displayed.
boolean	isPrinter() Checks if this is a printer or not (always false).
boolean	isProcessingDataStream() Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.
void	onSessionFailure(Throwable t) Called when a session has had a failure.
void	processInboundDataStream(short[] inputBuf, int pos, int inputBufLen) Processes the inbound 3270 data stream.
void	refreshHostFields(HostFields fields) Refreshes the host fields of the current session.
boolean	sendCharacterString(String keys) Sends character keystrokes to host.
boolean	sendKey(int key) Sends character keystrokes to host.
void	sessionDisconnected(Throwable t) The session has been disconnected due to link failure or if the remote host disconnected due to e.g.
boolean	setCursor(int x, int y) Sets the host cursor position.
boolean	setHostField(HostField hostField, String data, int[] attrs) Sets a host field fully with text data and perhaps attributes (if these are non-null).
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	setTerminalType(String terminal) Sets the terminal type, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listener

public HostSessionListener2 listener

The host session listener.

display

public Display3270 display

The 3270 display instance.

telnet

public TelnetHost telnet

The telnet thread, doing the actual conversation.

dataStream

public DataStream3270 dataStream

The 3270 data stream instance.

ebcdicConverter

public CodepageConverter ebcdicConverter

The codepage mapper.

graphicalCodepage

public int graphicalCodepage

The graphical code page, zero if not set.

address

protected String address

The host IP address to connect to.

port

protected int port

The host port (default is 23 for Mainframe) to connect to.

peerData

protected String peerData

Stored additional PeerData.

telnetHostClass

protected Class<?> telnetHostClass

The telnet host class.

doTN3270E

protected boolean doTN3270E

Flag indicating usage of TN3270E.

Method Detail

initiate

@Deprecated
public void initiate(HostSessionListener listener,
                                  String address,
                                  int port,
                                  String peerData)
                           throws InternalError

Deprecated. As of version 3.8, use method using HostSessionListener2.

Initiates an instance of the host session, but does not connect to the host.

Specified by:

initiate in interface HostSessionPeer

Throws:

InternalError - Always with message "Deprecated and unsupported method".

See Also:

initiate2(HostSessionListener2, String, int, String)

initiate2

public void initiate2(HostSessionListener2 listener,
                      String address,
                      int port,
                      String peerData)
               throws IOException

Initiates an instance of the host session, but does not connect to the host.

Specified by:

initiate2 in interface HostSessionPeer

Throws:

IOException - if an I/O error occurs.

is3270

public boolean is3270()

Checks if a session is 3270 or 5250.

Specified by:

is3270 in interface HostSessionPeer

Returns:

true is always 3270.

isProcessingDataStream

public boolean isProcessingDataStream()

Checks if the session is currently processing data stream commands to update the screen/cursor, state, etc.

Specified by:

isProcessingDataStream in interface HostSessionPeer

getSessionID

public int getSessionID()

Gets the session ID (or index) of this session.

Specified by:

getSessionID in interface TelnetInterface

getClientConnectionData

public ClientConnectionData getClientConnectionData()

Gets the client connection data.

Specified by:

getClientConnectionData in interface TelnetInterface

setTerminalType

public void setTerminalType(String terminal)
                     throws IOException

Sets the terminal type, e.g. 3279-3 or 3278-2.

Throws:

IOException - if an I/O error occurs.

createDataStream

protected void createDataStream()

Create the data stream.

connect

public boolean connect()

Connects the session to host.

Specified by:

connect in interface HostSessionPeer

disconnect

public boolean disconnect()

Disconnects the session from host.

Specified by:

disconnect in interface HostSessionPeer

sendCharacterString

public boolean sendCharacterString(String keys)

Sends character keystrokes to host.

Specified by:

sendCharacterString in interface HostSessionPeer

sendKey

public boolean sendKey(int key)

Sends character keystrokes to host.

Specified by:

sendKey in interface HostSessionPeer

See Also:

HostSendKeys

setHostString

public boolean setHostString(int x,
                             int y,
                             int offset,
                             int length,
                             String string)

Sets a string to a host field.

Specified by:

setHostString in interface HostSessionPeer

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.

Specified by:

setHostStringAsKeys in interface HostSessionPeer

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.

Specified by:

doesHostNeedFieldExit in interface HostSessionPeer

Returns:

false=field doesn't require field exit, true=field requires field exit.

setCursor

public boolean setCursor(int x,
                         int y)

Sets the host cursor position.

Specified by:

setCursor in interface HostSessionPeer

getLastError

public String getLastError(boolean doClear)

Gets the last error message of the session.

Specified by:

getLastError in interface HostSessionPeer

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.

Specified by:

setLastError in interface HostSessionPeer

getCursor

public Point getCursor()

Gets the current host cursor position.

Specified by:

getCursor in interface HostSessionPeer

getScreenSize

public Dimension getScreenSize()

Gets the current screen size.

Specified by:

getScreenSize in interface HostSessionPeer

getScreenLength

public int getScreenLength()

Gets the current screen length (width * height).

Specified by:

getScreenLength in interface HostSessionPeer

displayHiddenText

public void displayHiddenText(boolean display)

Informs the session that hidden text should be displayed as bright red on black background.

Specified by:

displayHiddenText in interface HostSessionPeer

isHiddenTextDisplayed

public boolean isHiddenTextDisplayed()

Checks if hidden text is displayed.

Specified by:

isHiddenTextDisplayed in interface HostSessionPeer

getSessionState

public long getSessionState()

Gets the current session state.

Specified by:

getSessionState in interface HostSessionPeer

getCharactersAndAttributes

public void getCharactersAndAttributes(char[] chars,
                                       int[] attrbs,
                                       int beginPos,
                                       int endPos)

Gets the characters and attributes between two positions, including the end position.

Specified by:

getCharactersAndAttributes in interface HostSessionPeer

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.

Specified by:

getCharactersAndAttributes in interface HostSessionPeer

hostAcceptedDataStream

public void hostAcceptedDataStream(String terminalType)
                            throws IOException

The host accepted the options for the terminal type and went into BINARY mode. This means that 3270/5250 data stream will follow. Inform the host session listener of a connect change.

Specified by:

hostAcceptedDataStream in interface TelnetInterface

Throws:

IOException - if an I/O error occurs.

processInboundDataStream

public void processInboundDataStream(short[] inputBuf,
                                     int pos,
                                     int inputBufLen)
                              throws IOException

Processes the inbound 3270 data stream.

Specified by:

processInboundDataStream in interface TelnetInterface

Throws:

IOException - if an I/O error occurs.

initiateLocalCopy

public void initiateLocalCopy()

Initiates a local copy of the current PS to the printer.

sessionDisconnected

public void sessionDisconnected(Throwable t)

The session has been disconnected due to link failure or if the remote host disconnected due to e.g. a time-out.

Specified by:

sessionDisconnected in interface TelnetInterface

getHostAddress

public String getHostAddress()

Returns the host destination address for the session.

Specified by:

getHostAddress in interface TelnetInterface

getHostPort

public int getHostPort()

Returns the Telnet port number.

Specified by:

getHostPort in interface TelnetInterface

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.

Specified by:

refreshHostFields in interface HostSessionPeer

onSessionFailure

public void onSessionFailure(Throwable t)

Called when a session has had a failure.

doNumericFieldOverride

public boolean doNumericFieldOverride()

Checks for 3270 numeric field override.

getDeviceName

public String getDeviceName()

Gets the device name of the session.

Specified by:

getDeviceName in interface HostSessionPeer

Returns:

null if no device name exists.

isPrinter

public boolean isPrinter()

Checks if this is a printer or not (always false).

Specified by:

isPrinter in interface HostSessionPeer

setInsertMode

public boolean setInsertMode(boolean on)

Sets the insert mode.

Specified by:

setInsertMode in interface HostSessionPeer

Returns:

true for success, false for failure.

doesFieldHaveExtendedAttributes

public boolean doesFieldHaveExtendedAttributes(HostField hostField)

Checks if a host field has extended attributes or not. 5250 never has, but 3270 could have, e.g. special highlighting.

Specified by:

doesFieldHaveExtendedAttributes in interface HostSessionPeer

getNewCharAttribute

public int getNewCharAttribute(HostField hostField)

Gets the attribute to use for new characters in a field that contains extended attributes (always zero for non-3270).

Specified by:

getNewCharAttribute in interface HostSessionPeer

getClientHostFieldFlags

public int getClientHostFieldFlags(HostField hostField)

Gets flags that are required for the client host fields for local editing, etc.

Specified by:

getClientHostFieldFlags in interface HostSessionPeer

getHostSessionListener

public HostSessionListener2 getHostSessionListener()

Gets the host session listener.

Specified by:

getHostSessionListener in interface HostSessionPeer

isAutoReconnectSessionEnabled

public boolean isAutoReconnectSessionEnabled()

Checks if the use of auto reconnect session is handled or not.

Specified by:

isAutoReconnectSessionEnabled in interface HostSessionPeer

getHomeAddress

public int getHomeAddress()

Gets the host address index on the screen.

Specified by:

getHomeAddress in interface HostSessionPeer

Returns:

-1 if none is available.

setHostField

public boolean setHostField(HostField hostField,
                            String data,
                            int[] attrs)

Sets a host field fully with text data and perhaps attributes (if these are non-null).

Specified by:

setHostField in interface HostSessionPeer

Returns:

true for success, false for failure.

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".

Specified by:

getAllowedCharacters in interface HostSessionPeer

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.

Specified by:

isFieldFormatted in interface HostSessionPeer

getAssociated3270Printer

public HostSession3270Printer getAssociated3270Printer()

Gets the 3270 printer session "associated" with this terminal session, null if no printer is associated.