se.entra.phantom.server

Class HostSession3270Printer

java.lang.Object

se.entra.phantom.server.HostSession3270

se.entra.phantom.server.HostSession3270Printer

All Implemented Interfaces:

HostSessionPeer, TelnetInterface

public class HostSession3270Printer
extends HostSession3270

The 3270 host session printer peer.

Field Summary

Fields inherited from class se.entra.phantom.server.HostSession3270

address, dataStream, display, doTN3270E, ebcdicConverter, graphicalCodepage, listener, peerData, port, telnet, telnetHostClass

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
protected void	createDataStream() Create the data stream.
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.
Point	getCursor() Gets the current host cursor position.
HostPrinterSettings	getHostPrinterSettings() Gets a copy of the host printer settings for this session.
int	getSessionID() Gets the session ID (or index) of this session, always -1 for printer sessions.
void	initiate2(HostSessionListener2 listener, String address, int port) 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	isFieldFormatted() Checks if this host screen is field formatted.
boolean	isPrinter() Checks if this is a printer or not (always true).
void	printPage(Transaction trans) Prints a page to a transaction.
void	processInboundSCSDataStream(short[] inputBuf, int inputBufLen) Processes the inbound SCS data stream.
void	processPrintEOJ() Processes an end of job for the current printer session.
boolean	sendCharacterString(String keys) Sends character keystrokes to host.
boolean	sendKey(int key) Sends character keystrokes to host.
boolean	setCursor(int x, int y) Sets the host cursor position.
void	setHostPrinterSettings(HostPrinterSettings newSettings) Sets new host printer settings for this session.
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.
void	setTerminalType(String terminal) Sets the terminal type.

Methods inherited from class se.entra.phantom.server.HostSession3270

connect, disconnect, displayHiddenText, doesFieldHaveExtendedAttributes, doNumericFieldOverride, getAllowedCharacters, getAssociated3270Printer, getCharactersAndAttributes, getCharactersAndAttributes, getClientConnectionData, getClientHostFieldFlags, getDeviceName, getHomeAddress, getHostAddress, getHostPort, getHostSessionListener, getLastError, getNewCharAttribute, getScreenLength, getScreenSize, getSessionState, hostAcceptedDataStream, initiate, initiate2, is3270, isAutoReconnectSessionEnabled, isHiddenTextDisplayed, isProcessingDataStream, onSessionFailure, processInboundDataStream, refreshHostFields, sessionDisconnected, setHostField, setInsertMode, setLastError

Methods inherited from class java.lang.Object

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

Method Detail

initiate2

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

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

Throws:

IOException - if an I/O error occurs.

createDataStream

protected void createDataStream()

Create the data stream.

Overrides:

createDataStream in class HostSession3270

initiateLocalCopy

public void initiateLocalCopy()

Initiates a local copy of the current PS to the printer. This is not valid for a printer session (only for displays).

Overrides:

initiateLocalCopy in class HostSession3270

getSessionID

public int getSessionID()

Gets the session ID (or index) of this session, always -1 for printer sessions.

Specified by:

getSessionID in interface TelnetInterface

Overrides:

getSessionID in class HostSession3270

setTerminalType

public void setTerminalType(String terminal)
                     throws IOException

Sets the terminal type. For printer, 3287-1 is always used, no matter what parameter is passed in.

Overrides:

setTerminalType in class HostSession3270

Throws:

IOException - if an I/O error occurs.

sendCharacterString

public boolean sendCharacterString(String keys)

Sends character keystrokes to host.

Specified by:

sendCharacterString in interface HostSessionPeer

Overrides:

sendCharacterString in class HostSession3270

Returns:

false for failure (always).

sendKey

public boolean sendKey(int key)

Sends character keystrokes to host.

Specified by:

sendKey in interface HostSessionPeer

Overrides:

sendKey in class HostSession3270

Returns:

false for failure (always).

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

Overrides:

setHostString in class HostSession3270

Returns:

false for failure (always).

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

Overrides:

setHostStringAsKeys in class HostSession3270

Returns:

false for failure (always).

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

Overrides:

doesHostNeedFieldExit in class HostSession3270

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

Overrides:

setCursor in class HostSession3270

Returns:

false for failure (always).

getCursor

public Point getCursor()

Gets the current host cursor position.

Specified by:

getCursor in interface HostSessionPeer

Overrides:

getCursor in class HostSession3270

Returns:

null for failure (always).

isPrinter

public boolean isPrinter()

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

Specified by:

isPrinter in interface HostSessionPeer

Overrides:

isPrinter in class HostSession3270

printPage

public void printPage(Transaction trans)

Prints a page to a transaction.

processInboundSCSDataStream

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

Processes the inbound SCS data stream.

Throws:

IOException

processPrintEOJ

public void processPrintEOJ()
                     throws IOException

Processes an end of job for the current printer session.

Throws:

IOException - if an I/O error occurs.

getHostPrinterSettings

public HostPrinterSettings getHostPrinterSettings()

Gets a copy of the host printer settings for this session.

setHostPrinterSettings

public void setHostPrinterSettings(HostPrinterSettings newSettings)

Sets new host printer settings for this session. The settings parameter is copied and any reference to the object is not used.

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

Overrides:

isFieldFormatted in class HostSession3270

Returns:

false a 3270 printer doesn't have fields.