All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.Session

java.lang.Object
   |
   +----com.ibm.eNetwork.beans.HOD.HODBean
           |
           +----com.ibm.eNetwork.beans.HOD.Session

public class Session
extends HODBean
implements SendKeyListener, PropertyChangeListener, SessionInterface
The Session Bean is used to establish a connection with a host. It defines the behavior and characteristics of the session with the host. The Session Bean can be constructed with a Properties object which contains some or all the configuration information for the session.

HOD-unique In Host On-Demand, configurable information includes, but is not limited to, the session type (3270, 5250, and VT), host, port, session ID, presentation space size (for example, 24 rows by 80 columns), and the host code page.

PComm-unique In Personal Communications, the configuration information for the session is contained in the Personal Communications Workstation Profile (.WS file). The .WS file name to be used for this session can be set in the host property of the Session.

Properties

The following table lists the properties of the Session Bean:

* - Properties with type "enum" are String types that accept a specific set of string values. The valid values for an enum property can be obtained by calling the list <property name> method. The set method for enum properties validates the value before any changes are accepted, and a PropertyVetoException is thrown if an incorrect value is given.

Note: All properties are bound and vetoable. A PropertyChangeEvent is fired to all PropertyChangeListeners after a property is changed. A vetoable PropertyChangeEvent is fired to all VetoableChangeListeners before a property is changed. VetoableChangeListeners can veto a property change by throwing a PropertyVetoException.

Property Name Type

Default

Access
autoConnect boolean true read/write
autoReconnect boolean true read/write
CICSGWCodePage enum* ECLSession.SESSION_CICS_CODE_PAGE_DEFAULT read/write
CICSServerName String read/write
codePage enum* ECLSession.SESSION_CODE_PAGE_US read/write
commReady boolean false read
commStarted boolean false read
commStatus enum* CONNECTION_INIT read
copyOnlyIfTrimmed boolean false read/write
deviceNameReady boolean false read
enptui boolean false read/write
graphicsCellSize String read/write
History boolean true read/write
historySize String ECLSession.SESSION_HISTORY_SIZE_DEFAULT read/write
host String read/write
hostGraphics boolean false read/write
LUMLicensing String HOD read/write
LUName String read/write
LUMPort int 80 read/write
LUMServer String read/write
numeralShape enum* NOMINAL read/write
numericFieldLock boolean false read/write
numericSwapEnabled boolean true read/write
pasteFieldWrap boolean false read/write
pasteLineWrap boolean false read/write
pasteStopAtProtectedLine boolean false read/write
pasteTabColumns int 1 read/write
pasteTabOptions enum* ECLSession.SESSION_PASTE_TAB_OPTIONS_SPACES_STR read/write
pasteTabSpaces int 1 read/write
pasteToTrimmedArea boolean false read/write
port int ECLSession.SESSION_3270_HOST_PORT_DEFAULT read/write
printDestination boolean true read/write
printFileName String read/write
printerName String /dev/lp0 or LPT1 read/write
screenSize enum* ECLSession.SESSION_PS_24X80_STR read/write
separateFiles boolean false read/write
serviceMgrHost String read/write
sessionID String read/write
sessionName String read/write
sessionType enum* ECLSession.SESSION_TYPE_3270_STR read/write
SLPAS400Name String ECLSession.SESSION_SLP_AS400_NAME_DEFAULT read/write
SLPEnabled boolean ECLSession.SESSION_SLP_ENABLED_DEFAULT read/write
SLPMaxWaitTime int ECLSession.SESSION_SLP_MAX_WAIT_TIME_DEFAULT read/write
SLPScope String ECLSession.SESSION_SLP_SCOPE_DEFAULT read/write
SLPThisScopeOnly boolean ECLSession.SESSION_SLP_THIS_SCOPE_ONLY read/write
SSL boolean false read/write
SSLCertificateHash String read/write
SSLCertificateHowOftenToPrompt String ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECT read/write
SSLCertificateName String read/write
SSLCertificatePassword String write
SSLCertificatePromptBeforeConnect boolean false read/write
SSLCertificatePrompted boolean false read/write
SSLCertificateProvided boolean false read/write
SSLCertificateRemembered boolean true read/write
SSLCertificateSource String ECLSession.SESSION_SSL_CERTIFICATE_IN_URL read/write
SSLCertificateURL String read/write
SSLServerAuthentication boolean false read/write
SSLTelnetNegotiated boolean false read/write
symmetricSwapEnabled boolean true read/write
textOrientation enum* LEFT_TO_RIGHT read/write
textType enum* VISUAL read/write
ThaiDisplayMode int THAI_MODE_5 read/write
TNEnhanced boolean true read/write
trimRectRemainAfterEdit boolean false read/write
trimRectSizingHandles boolean true read/write
VTAnswerBackMsg String read/write
VTAutowrap boolean false read/write
VTBackspace boolean false read/write
VTCursor boolean false read/write
VTKeypad boolean false read/write
VTLocalEcho boolean false read/write
VTNewLine boolean true read/write
VTReverseScreen boolean false read/write
VTTerminalType enum* ECLSession.SESSION_VT_TERMINAL_TYPE_DEFAULT read/write
workstationID String read/write
workstationIDReady boolean false read

Events Fired

Event Type Fired To Event Handler Method
PSEvent - Fired when something changes in the presentation space. Screen or any PSListener PSEvent(PSEvent)
OIAEvent - Fired when the state of the operator information area (OIA) changes. Screen or any OIAListener OIAEvent(OIAEvent)
CommEvent - Fired when the communications status changes. Any CommListener CommEvent(CommEvent)
GUIEvent - Fired when another Bean requests a GUI change with Screen. Screen GUIEvent(GUIEvent)
PropertyChangeEvent - Fired when a property of the Bean is changed. Any PropertyChangeListener propertyChange(PropertyChangeEvent)

Events Accepted

Event Type Fired From Event Handler Method
SendKeyEvent Screen, KeyPad, KeyRemap, or any other SendKeyEvent source sendKeys(SendKeyEvent)


Variable Index

 o AUTO_CONNECT
autoConnect property keyword
 o AUTO_RECONNECT
autoReconnect property keyword
 o BIDI_MODE
BIDIMode property keyword (VT bi-directional sessions only)
 o BIDI_MODE_OFF
 o BIDI_MODE_ON
BIDIMode property values (VT bi-directional sessions only)
 o CICS_GW_CODE_PAGE
CICSGWCodePage property keyword
 o CICS_SERVER_NAME
CICSServerName property keyword
 o CODE_PAGE
codePage property keyword
 o CONNECTION_ACTIVE
commStatus property value - active (connected to host)
 o CONNECTION_DEVICE_NAME_READY
commStatus property value - the device name is available from the host
 o CONNECTION_INACTIVE
commStatus property value - inactive (no connection to host)
 o CONNECTION_INIT
commStatus property value - initial state (no connection to host)
 o CONNECTION_PND_ACTIVE
commStatus property value - pending active
 o CONNECTION_PND_INACTIVE
commStatus property value - pending inactive
 o CONNECTION_READY
commStatus property value - host is ready for interaction
 o CONNECTION_WORKSTATION_ID_READY
commStatus property value - the workstation ID is available from the host
 o CONTEXTUAL
numeralShape property value - contextual (bi-directional sessions only)
 o CONTEXTUAL_DISP
 o COPY_ONLY_IF_TRIMMED
Copy Only If Trimmed property keyword
 o CURSOR_DIRECTION
cursorDirection property keyword (VT bi-directional sessions only)
 o CURSOR_LTR
cursorDirection property values (VT bi-directional sessions only)
 o CURSOR_RTL
 o ENPTUI
enptui property keyword
 o GRAPHICS_CELL_SIZE
graphicsCellSize property keyword
 o HISTORY
History property keyword
 o HISTORY_SIZE
History size property keyword
 o HOST
host property keyword
 o HOST_GRAPHICS
hostGraphics property keyword
 o LEFT_TO_RIGHT
textOrientation property value - left to right (bi-directional sessions only)
 o LOGICAL
textType property value - logical (bi-directional sessions only)
 o LOGICAL_DISP
 o LU_NAME
LUName property keyword
 o LUM_LICENSING
Lum licensing property keyword
 o LUM_PORT
Lum port property keyword
 o LUM_SERVER
LUM server property keyword
 o NATIONAL
numeralShape property value - national (bi-directional sessions only)
 o NATIONAL_DISP
 o NOMINAL
numeralShape property value - nominal (bi-directional sessions only)
 o NOMINAL_DISP
numeralShapeDisp property values (VT bi-directional sessions only)
 o NUM_FIELD_LOCK
numericFieldLock property keyword
 o NUM_SWAP_ENABLED
Numeric swapping value - (Arabic 3270 sessions only)
 o NUMERAL_SHAPE
numeralShape property keyword
 o NUMERAL_SHAPE_DISP
numeralShapeDisp property keyword (VT bi-directional sessions only)
 o PASTE_FIELD_WRAP
Paste Field Wrap property keyword
 o PASTE_LINE_WRAP
Paste word line wrap property keyword
 o PASTE_STOP_PRO_LINE
Paste Stop At Protected Line property keyword
 o PASTE_TAB_COLUMNS
Paste Tab Columns property keyword
 o PASTE_TAB_OPTIONS
Paste Tab Options property keyword
 o PASTE_TAB_SPACES
Paste Tab Spaces property keyword
 o PASTE_TO_TRIMMED_AREA
Paste To Trimmed area property keyword
 o PORT
port property keyword
 o PRINT_BUFFSIZE
printBufferSize property keyword
 o PRINT_DESTINATION
printDestination property keyword
 o PRINT_FILE_NAME
printFileName property keyword
 o PRINT_SEPARATE_FILES
separateFiles property keyword
 o PRINTER_NAME
printerName property keyword
 o RIGHT_TO_LEFT
textOrientation property value - right to left (bi-directional sessions only)
 o SCREEN_SIZE
screenSize property keyword
 o SERVICE_MGR_HOST
Service manager host property keyword
 o SESSION_ID
sessionID property keyword
 o SESSION_NAME
sessionName property keyword
 o SESSION_TYPE
sessionType property keyword
 o SLP_AS400_NAME
SLPAS400Name property keyword
 o SLP_ENABLED
SLPEnabled property keyword
 o SLP_MAX_WAIT_TIME
SLPMaxWaitTime Property keyword
 o SLP_SCOPE
SLPScope property keyword
 o SLP_THIS_SCOPE_ONLY
SLPThisScopeOnly property keyword
 o SSL
SSL property keyword
 o SSL_BROWSER_KEYRING_ADDED
SSLBrowserKeyringAdded property keyword
 o SSL_CERTIFICATE_HASH
SSLCertificateHash property keyword
 o SSL_CERTIFICATE_NAME
SSLCertificateName property keyword
 o SSL_CERTIFICATE_PASSWORD
SSLCertificatePassword property keyword
 o SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
SSLCertificatePromptBeforeConnect property keyword
 o SSL_CERTIFICATE_PROMPT_HOW_OFTEN
SSLCertificatePromptHowOften property keyword
 o SSL_CERTIFICATE_PROMPTED
SSLCertificatePrompted property keyword
 o SSL_CERTIFICATE_PROVIDED
SSLCertificateProvided property keyword
 o SSL_CERTIFICATE_REMEMBERED
SSLCertificateRemembered property keyword
 o SSL_CERTIFICATE_SOURCE
SSLCertificateSource property keyword
 o SSL_CERTIFICATE_URL
SSLCertificateURL property keyword
 o SSL_SERVER_AUTHENTICATION
SSLServerAuthentication property keyword
 o SSL_TELNET_NEGOTIATED
SSLTelnetNegotiated property keyword
 o SYM_SWAP_ENABLED
symmetric swapping value - (Arabic 3270 sessions only)
 o TEXT_ORIENTATION
textOrientation property keyword
 o TEXT_TYPE
textType property keyword
 o TEXT_TYPE_DISP
textTypeDisp property keyword (VT bi-directional sessions only)
 o THAI_DISPLAY_MODE
ThaiDisplayMode property keyword
 o THAI_MODE_1
Thai mode 1 property value - non composed mode (Thai session only)
 o THAI_MODE_2
Thai mode 2 property value - composed mode (Thai session only)
 o THAI_MODE_3
Thai mode 3 property value - composed mode with space alignment (Thai session only)
 o THAI_MODE_4
Thai mode 4 property value - composed mode with EOF alignment (Thai session only)
 o THAI_MODE_5
Thai mode 5 property value - composed mode with space and EOF alignment (Thai session only)
 o TN_ENHANCED
TNEnhanced property keyword
 o TRIM_RECT_REMAIN_AFTER
Trim Rectangle Remain After Edit
 o TRIM_RECT_SIZING_HANDLES
Trim Rectangle Sizing handles
 o VISUAL
textType property value - visual (bi-directional sessions only)
 o VISUAL_DISP
textTypeDisp property values (VT bi-directional sessions only)
 o VT_ANS_BACK_MSG
VTAnswerBackMsg property keyword
 o VT_AUTOWRAP
VTAutowrap property keyword
 o VT_BACKSPACE
VTBackspace property keyword
 o VT_CURSOR
VTCursor property keyword
 o VT_KEYPAD
VTKeypad property keyword
 o VT_LOCAL_ECHO
VTLocalEcho property keyword
 o VT_NEW_LINE
VTNewLine property keyword
 o VT_REVERSE_SCREEN
VTReverseScreen property keyword
 o VT_TERMINAL_TYPE
VTTerminalType property keyword
 o WORKSTATION_ID
workstationID property keyword

Constructor Index

 o Session()
Constructor which builds a Session Bean using the default property values.
 o Session(Properties)
Constructor which builds a Session Bean using the property values passed in the Property object.

Method Index

 o addCommListener(CommListener)
Adds a CommEvent listener
 o addGUIListener(GUIListener)
Adds a GUIEvent listener
 o addOIAListener(OIAListener)
Adds an OIAEvent listener
 o addPSListener(PSListener)
Adds a PSEvent listener
 o addTraceListener(TraceListener)
Adds a TraceEvent listener
 o defaults()
Returns a Properties object containing the default properties and their values for this Session Bean.
 o dispose()
Disposes of the Session and all of its resources.
 o getBIDIMode()
 o getCICSGWCodePage()
Returns the current value of the CICSGWCodepage property.
 o getCICSServerName()
Returns the current value of the CICSServerName property.
 o getCodePage()
Returns the current value of the codePage property.
 o getCommStatus()
Returns the status of communications with the host.
 o getCursorDirection()
 o getDeviceName()
If isDeviceNameReady() is true, returns the device name in use, otherwise returns null.
 o getECLSession()
Returns the ECLSession object associated with this Session.
 o getGraphicsCellSize()
Returns the current value of the graphicsCellSize property.
 o getHistorySize()
 o getHost()
Returns the current value of the host property.
 o getLUMLicensing()
Returns the License method type
 o getLUMPort()
Returns the LUM server port number
 o getLUMServer()
Returns the LUM server
 o getLUName()
Returns the current value of the LUName property.
 o getNumeralShape()
Returns the current value of the numeralShape property.
 o getNumeralShapeDisp()
 o getPasteTabColumns()
Returns the current value of the pasteTabColumns property.
 o getPasteTabOptions()
Returns the current setting of the pasteOptionsType property.
 o getPasteTabSpaces()
Returns the current value of the pasteTabSpaces property.
 o getPort()
Returns the current value of the port property.
 o getPrinterName()
Returns the current value of the printerName property.
 o getPrintFileName()
Returns the current value of the printFileName property.
 o getProperties()
Returns the current properties for Session.
 o getScreenSize()
Returns the current value of the screenSize property.
 o getSecurityInfoIntf(Frame)
 o getServiceMgrHost()
Returns the HOD server
 o getSession()
Needed for SessionInterface
 o getSessionID()
Returns the value of the sessionID property.
 o getSessionName()
Returns the value of the sessionName property.
 o getSessionType()
Returns the current setting of the sessionType property.
 o getSLPAS400Name()
Returns the current value of the SLPAS400Name property.
 o getSLPMaxWaitTime()
Returns the current value of the SLPMaxWaitTime property.
 o getSLPScope()
Returns the current value of the SLPScope property.
 o getSSLCertificateHash()
Returns the current value of the SSLCertificateHash property.
 o getSSLCertificateName()
Returns the current value of the SSLCertificateName property.
 o getSSLCertificatePromptHowOften()
Returns the current value of the SSLCertificatePromptHowOften property.
 o getSSLCertificateSource()
Returns the current value of the SSLCertificateSource property.
 o getSSLCertificateURL()
Returns the current value of the SSLCertificateURL property.
 o getTextOrientation()
Returns the current value of the textOrientation property.
 o getTextType()
Returns the current value of the textType property.
 o getTextTypeDisp()
 o getThaiDisplayMode()
Returns the current value of the ThaiDisplayMode property
 o getTraceName()
Returns a trace identifier for this bean
 o getVTAnswerBackMsg()
Returns the current value of the VTAnswerBackMsg property.
 o getVTTerminalType()
Returns the current value of the VTTerminalType property.
 o getWorkstationID()
Returns the current value of the workstation ID property.
 o isAutoConnect()
Returns the value of the autoConnect property.
 o isAutoReconnect()
Returns the current value of the autoReconnect property.
 o isCommReady()
Returns true if the host is ready for interaction, otherwise returns false.
 o isCommStarted()
Determines whether the connection with the host has been started.
 o isCopyOnlyIfTrimmed()
Returns the value of the copyOnlyIfTrimmed property.
 o isDeviceNameReady()
Returns true if the device name is ready, otherwise returns false.
 o isENPTUI()
Returns the value of the enptui property.
 o isHistory()
 o isHostGraphics()
Returns the value of the hostGraphics property.
 o isNumericFieldLock()
Returns the value of the Numeric Field Lock property.
 o isNumericSwapEnabled()
Returns the current value of the Numeric Swapping property.
 o isPasteFieldWrap()
Returns the value of the pasteFieldWrap property.
 o isPasteLineWrap()
Returns the value of the pasteLineWrap property.
 o isPasteStopAtProtectedLine()
Returns the value of the pasteStopAtProtectedLine property.
 o isPasteToTrimmedArea()
Returns the value of the pasteToTrimmedArea property.
 o isPrintDestination()
Returns the current value of the printDestination property.
 o isSeparateFiles()
Returns the current value of the separateFiles property.
 o isSLPEnabled()
Returns the current value of the SLPEnabled property.
 o isSLPThisScopeOnly()
Returns the current value of the SLPThisScopeOnly property.
 o isSSL()
Returns the value of the SSL property.
 o isSSLBrowserKeyringAdded()
Returns the current value of the SSLBrowserKeyringAdded property.
 o isSSLCertificatePromptBeforeConnect()
Returns the current value of the SSLCertificatePromptBeforeConnect property.
 o isSSLCertificatePrompted()
Returns the current value of the SSLCertificatePrompted property.
 o isSSLCertificateProvided()
Returns the current value of the SSLCertificateProvided property.
 o isSSLCertificateRemembered()
Returns the current value of the SSLCertificateRemembered property.
 o isSSLServerAuthentication()
Returns the current value of the SSLServerAuthentication property.
 o isSSLTelnetNegotiated()
Returns the current value of the SSLTelnetNegotiated property.
 o isSymmetricSwapEnabled()
Returns the current value of the Symmetric Swapping property.
 o isTNEnhanced()
Returns the current value of the TNEnhanced property.
 o isTrimRectRemainAfterEdit()
Returns the value of the trimRectRemainAfterEdit property.
 o isTrimRectSizingHandles()
Returns the value of the trimRectSizingHandles property.
 o isValidLUName(String)
Tests the given luName for correct syntax.
 o isValidSLPAS400Name(String)
Tests the given SLPAS400Name for correct syntax.
 o isValidSLPScope(String)
Tests the given SLPScope for correct syntax.
 o isValidWorkstationID(String)
Tests the given workstationID for correct syntax.
 o isVTAutowrap()
Returns the value of the VTAutowrap property.
 o isVTBackspace()
Returns the value of the VTBackspace property.
 o isVTCursor()
Returns the value of the VTCursor property.
 o isVTKeypad()
Returns the value of the VTKeypad property.
 o isVTLocalEcho()
Returns the value of the VTLocalEcho.
 o isVTNewLine()
Returns the current value of the VTNewLine property.
 o isVTReverseScreen()
Returns the value of the VTReverseScreen property.
 o isWorkstationIDReady()
Returns true if the workstation ID is ready, otherwise returns false.
 o listBIDIModes()
 o listCICSGWCodePages()
Returns the list of valid CICSGWCodePage values.
 o listCodePages()
Returns a list of the valid codePage values for the current session type.
 o listCodePages(String)
Returns a list of the valid codePage values for the given session type.
 o listCursorDirections()
 o listGraphicsCellSizes()
Returns a list of the valid graphicsCellSize values
 o listHistorySizes()
Returns a list of the valid History size values for the current session type.
 o listHistorySizes(String)
 o listLUMLicensing()
 o listNumeralShapes()
Returns the list of valid numeralShape values.
 o listNumeralShapesDisp()
 o listPasteTabOptions()
Returns a list of the valid pasteOptionsType values.
 o listScreenSizes()
Returns a list of the valid screenSize values for the current session type.
 o listScreenSizes(String)
Returns a list of the valid screenSize values for the specified session type.
 o listSessionTypes()
Returns a list of the valid sessionType values.
 o listTextOrientations()
Returns a list of the valid textOrientation values.
 o listTextTypes()
Returns the list of valid textType values.
 o listTextTypesDisp()
 o listThaiDisplayModes()
Returns the list of valid ThaiDisplayMode values.
 o listVTTerminalTypes()
Returns a list of the valid VTTerminalTypes.
 o removeCommListener(CommListener)
Removes a CommEvent listener
 o removeGUIListener(GUIListener)
Removes a GUIEvent listener
 o removeOIAListener(OIAListener)
Remove an OIAEvent listener
 o removePSListener(PSListener)
Removes a PSEvent listener
 o sendKeys(SendKeyEvent)
Handles SendKeyEvents sent to this Session Bean.
 o setAutoConnect(boolean)
Sets the autoConnect property.
 o setAutoReconnect(boolean)
Sets the autoReconnect property.
 o setBIDIMode(String)
 o setCICSGWCodePage(String)
Sets the CICSGWCodepage property.
 o setCICSServerName(String)
Sets the CICSServerName property.
 o setCodePage(String)
Sets the codePage property.
 o setCopyOnlyIfTrimmed(boolean)
Sets the copyOnlyIfTrimmed property.
 o setCursorDirection(String)
 o setENPTUI(boolean)
Sets the enptui property.
 o setGraphicsCellSize(String)
Sets the graphicsCellSize property.
 o setHistory(boolean)
Sets the History property.
 o setHistorySize(String)
Sets the History size property.
 o setHost(String)
Sets the name of host associated with this Session Bean.
 o setHostGraphics(boolean)
Sets the hostGraphics property.
 o setLUMLicensing(String)
Sets the license method to either LUM or HOD.
 o setLUMPort(int)
Sets the LUMPort property.
 o setLUMServer(String)
Sets the LUM server property.
 o setLUName(String)
Sets the LUName property.
 o setNumeralShape(String)
Sets the numeralShape property.
 o setNumeralShapeDisp(String)
 o setNumericFieldLock(boolean)
Sets the Numeric Field Lock property of Session.
 o setNumericSwapEnabled(boolean)
Sets the Numeric swapping property.
 o setPasteFieldWrap(boolean)
Sets the pasteFieldWrap property.
 o setPasteLineWrap(boolean)
Sets the pasteLineWrap property.
 o setPasteStopAtProtectedLine(boolean)
Sets the pasteStopAtProtectedLine property.
 o setPasteTabColumns(int)
Sets the pasteTabColumns to set the number of columns represented by a tab.
 o setPasteTabOptions(String)
Sets the pasteTabOptions property.
 o setPasteTabSpaces(int)
Sets the pasteTabSpaces to set the number of spaces represented by a tab.
 o setPasteToTrimmedArea(boolean)
Sets the pasteToTrimmedArea property.
 o setPort(int)
Sets the port that will be used to communicate with the host.
 o setPrintDestination(boolean)
Sets the printDestination property.
 o setPrinterName(String)
Sets the printerName property.
 o setPrintFileName(String)
Sets the printFileName property.
 o setScreenSize(String)
Sets the screenSize property.
 o setSeparateFiles(boolean)
Sets the separateFiles property.
 o setServiceMgrHost(String)
Sets the HOD server property.
 o setSessionID(String)
Sets the sessionID property.
 o setSessionName(String)
Sets the sessionName property.
 o setSessionType(String)
Sets the sessionType property.
 o setSLPAS400Name(String)
Sets the SLPAS400Name property.
 o setSLPEnabled(boolean)
Sets the SLPEnabled property.
 o setSLPMaxWaitTime(int)
Sets the SLPMaxWaitTime in milliseconds that will be used when waiting for service response.
 o setSLPScope(String)
Sets the SLPScope property.
 o setSLPThisScopeOnly(boolean)
Sets the SLPThisScopeOnly property.
 o setSSL(boolean)
Sets the SSL property of Session.
 o setSSLBrowserKeyringAdded(boolean)
Sets the SSLBrowserKeyringAdded property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateHash(String)
Sets the SSLCertificateHash property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateName(String)
Sets the SSLCertificateName property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificatePassword(String)
Sets the SSLCertificatePassword property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificatePromptBeforeConnect(boolean)
Sets the SSLCertificatePromptBeforeConnect property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificatePrompted(boolean)
Sets the SSLCertificatePrompted property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificatePromptHowOften(String)
Sets the SSLCertificatePromptHowOften property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateProvided(boolean)
Sets the SSLCertificateProvided property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateRemembered(boolean)
Sets the SSLCertificateRemembered property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateSource(String)
Sets the SSLCertificateSource property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLCertificateURL(String)
Sets the SSLCertificateURL property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLServerAuthentication(boolean)
Sets the SSLServerAuthentication property of Session

PComm-unique In Personal Communications, this property is ignored.

 o setSSLTelnetNegotiated(boolean)
Sets the SSLTelnetNegotiated property of Session.
 o setSymmetricSwapEnabled(boolean)
Sets the Symmetric swapping property.
 o setTextOrientation(String)
Sets the textOrientation property.
 o setTextType(String)
Sets the textType property.
 o setTextTypeDisp(String)
 o setThaiDisplayMode(int)
Set Thai display mode property.
 o setTNEnhanced(boolean)
Sets the TNEnhanced property.
 o setTrimRectRemainAfterEdit(boolean)
Sets the trimRectRemainAfterEdit property.
 o setTrimRectSizingHandles(boolean)
Sets the trimRectSizingHandles property.
 o setVTAnswerBackMsg(String)
Sets the VTAnswerBackMsg property.
 o setVTAutowrap(boolean)
Sets the VTAutowrap property.
 o setVTBackspace(boolean)
Sets the VTBackspace property.
 o setVTCursor(boolean)
Sets the VTCursor property.
 o setVTKeypad(boolean)
Sets the VTKeypad property.
 o setVTLocalEcho(boolean)
Sets the VTLocalEcho property.
 o setVTNewLine(boolean)
Sets the VTNewLine property.
 o setVTReverseScreen(boolean)
Sets the VTReverseScreen property.
 o setVTTerminalType(String)
Sets the VTTerminalType property.
 o setWorkstationID(String)
Sets the workstationID property.
 o startCommunication()
Starts communications with the host.
 o stopCommunication()
Stops communications with the host.

Variables

 o SESSION_TYPE
 public static final String SESSION_TYPE
sessionType property keyword

 o SESSION_NAME
 public static final String SESSION_NAME
sessionName property keyword

 o SESSION_ID
 public static final String SESSION_ID
sessionID property keyword

 o TN_ENHANCED
 public static final String TN_ENHANCED
TNEnhanced property keyword

 o LU_NAME
 public static final String LU_NAME
LUName property keyword

 o HOST
 public static final String HOST
host property keyword

 o PORT
 public static final String PORT
port property keyword

 o SCREEN_SIZE
 public static final String SCREEN_SIZE
screenSize property keyword

 o PRINT_BUFFSIZE
 public static final String PRINT_BUFFSIZE
printBufferSize property keyword

 o WORKSTATION_ID
 public static final String WORKSTATION_ID
workstationID property keyword

 o CODE_PAGE
 public static final String CODE_PAGE
codePage property keyword

 o HOST_GRAPHICS
 public static final String HOST_GRAPHICS
hostGraphics property keyword

 o GRAPHICS_CELL_SIZE
 public static final String GRAPHICS_CELL_SIZE
graphicsCellSize property keyword

 o ENPTUI
 public static final String ENPTUI
enptui property keyword

 o AUTO_CONNECT
 public static final String AUTO_CONNECT
autoConnect property keyword

 o AUTO_RECONNECT
 public static final String AUTO_RECONNECT
autoReconnect property keyword

 o SLP_ENABLED
 public static final String SLP_ENABLED
SLPEnabled property keyword

 o SLP_SCOPE
 public static final String SLP_SCOPE
SLPScope property keyword

 o SLP_AS400_NAME
 public static final String SLP_AS400_NAME
SLPAS400Name property keyword

 o SLP_THIS_SCOPE_ONLY
 public static final String SLP_THIS_SCOPE_ONLY
SLPThisScopeOnly property keyword

 o SLP_MAX_WAIT_TIME
 public static final String SLP_MAX_WAIT_TIME
SLPMaxWaitTime Property keyword

 o SSL
 public static final String SSL
SSL property keyword

 o SSL_TELNET_NEGOTIATED
 public static final String SSL_TELNET_NEGOTIATED
SSLTelnetNegotiated property keyword

 o SSL_SERVER_AUTHENTICATION
 public static final String SSL_SERVER_AUTHENTICATION
SSLServerAuthentication property keyword

 o SSL_BROWSER_KEYRING_ADDED
 public static final String SSL_BROWSER_KEYRING_ADDED
SSLBrowserKeyringAdded property keyword

 o SSL_CERTIFICATE_PROVIDED
 public static final String SSL_CERTIFICATE_PROVIDED
SSLCertificateProvided property keyword

 o SSL_CERTIFICATE_SOURCE
 public static final String SSL_CERTIFICATE_SOURCE
SSLCertificateSource property keyword

 o SSL_CERTIFICATE_URL
 public static final String SSL_CERTIFICATE_URL
SSLCertificateURL property keyword

 o SSL_CERTIFICATE_PASSWORD
 public static final String SSL_CERTIFICATE_PASSWORD
SSLCertificatePassword property keyword

 o SSL_CERTIFICATE_NAME
 public static final String SSL_CERTIFICATE_NAME
SSLCertificateName property keyword

 o SSL_CERTIFICATE_PROMPT_HOW_OFTEN
 public static final String SSL_CERTIFICATE_PROMPT_HOW_OFTEN
SSLCertificatePromptHowOften property keyword

 o SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
 public static final String SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
SSLCertificatePromptBeforeConnect property keyword

 o SSL_CERTIFICATE_HASH
 public static final String SSL_CERTIFICATE_HASH
SSLCertificateHash property keyword

 o SSL_CERTIFICATE_PROMPTED
 public static final String SSL_CERTIFICATE_PROMPTED
SSLCertificatePrompted property keyword

 o SSL_CERTIFICATE_REMEMBERED
 public static final String SSL_CERTIFICATE_REMEMBERED
SSLCertificateRemembered property keyword

 o CICS_SERVER_NAME
 public static final String CICS_SERVER_NAME
CICSServerName property keyword

 o CICS_GW_CODE_PAGE
 public static final String CICS_GW_CODE_PAGE
CICSGWCodePage property keyword

 o VT_TERMINAL_TYPE
 public static final String VT_TERMINAL_TYPE
VTTerminalType property keyword

 o VT_NEW_LINE
 public static final String VT_NEW_LINE
VTNewLine property keyword

 o VT_BACKSPACE
 public static final String VT_BACKSPACE
VTBackspace property keyword

 o VT_LOCAL_ECHO
 public static final String VT_LOCAL_ECHO
VTLocalEcho property keyword

 o VT_CURSOR
 public static final String VT_CURSOR
VTCursor property keyword

 o VT_KEYPAD
 public static final String VT_KEYPAD
VTKeypad property keyword

 o VT_AUTOWRAP
 public static final String VT_AUTOWRAP
VTAutowrap property keyword

 o VT_REVERSE_SCREEN
 public static final String VT_REVERSE_SCREEN
VTReverseScreen property keyword

 o VT_ANS_BACK_MSG
 public static final String VT_ANS_BACK_MSG
VTAnswerBackMsg property keyword

 o PRINT_DESTINATION
 public static final String PRINT_DESTINATION
printDestination property keyword

 o PRINT_FILE_NAME
 public static final String PRINT_FILE_NAME
printFileName property keyword

 o PRINT_SEPARATE_FILES
 public static final String PRINT_SEPARATE_FILES
separateFiles property keyword

 o PRINTER_NAME
 public static final String PRINTER_NAME
printerName property keyword

 o HISTORY
 public static final String HISTORY
History property keyword

 o HISTORY_SIZE
 public static final String HISTORY_SIZE
History size property keyword

 o NUM_FIELD_LOCK
 public static final String NUM_FIELD_LOCK
numericFieldLock property keyword

 o NUMERAL_SHAPE
 public static final String NUMERAL_SHAPE
numeralShape property keyword

 o TEXT_TYPE
 public static final String TEXT_TYPE
textType property keyword

 o TEXT_ORIENTATION
 public static final String TEXT_ORIENTATION
textOrientation property keyword

 o NOMINAL
 public static final String NOMINAL
numeralShape property value - nominal (bi-directional sessions only)

 o NATIONAL
 public static final String NATIONAL
numeralShape property value - national (bi-directional sessions only)

 o CONTEXTUAL
 public static final String CONTEXTUAL
numeralShape property value - contextual (bi-directional sessions only)

 o VISUAL
 public static final String VISUAL
textType property value - visual (bi-directional sessions only)

 o LOGICAL
 public static final String LOGICAL
textType property value - logical (bi-directional sessions only)

 o LEFT_TO_RIGHT
 public static final String LEFT_TO_RIGHT
textOrientation property value - left to right (bi-directional sessions only)

 o RIGHT_TO_LEFT
 public static final String RIGHT_TO_LEFT
textOrientation property value - right to left (bi-directional sessions only)

 o SYM_SWAP_ENABLED
 public static final String SYM_SWAP_ENABLED
symmetric swapping value - (Arabic 3270 sessions only)

 o NUM_SWAP_ENABLED
 public static final String NUM_SWAP_ENABLED
Numeric swapping value - (Arabic 3270 sessions only)

 o NUMERAL_SHAPE_DISP
 public static final String NUMERAL_SHAPE_DISP
numeralShapeDisp property keyword (VT bi-directional sessions only)

 o NOMINAL_DISP
 public static final String NOMINAL_DISP
numeralShapeDisp property values (VT bi-directional sessions only)

 o NATIONAL_DISP
 public static final String NATIONAL_DISP
 o CONTEXTUAL_DISP
 public static final String CONTEXTUAL_DISP
 o TEXT_TYPE_DISP
 public static final String TEXT_TYPE_DISP
textTypeDisp property keyword (VT bi-directional sessions only)

 o VISUAL_DISP
 public static final String VISUAL_DISP
textTypeDisp property values (VT bi-directional sessions only)

 o LOGICAL_DISP
 public static final String LOGICAL_DISP
 o BIDI_MODE
 public static final String BIDI_MODE
BIDIMode property keyword (VT bi-directional sessions only)

 o BIDI_MODE_ON
 public static final String BIDI_MODE_ON
BIDIMode property values (VT bi-directional sessions only)

 o BIDI_MODE_OFF
 public static final String BIDI_MODE_OFF
 o CURSOR_DIRECTION
 public static final String CURSOR_DIRECTION
cursorDirection property keyword (VT bi-directional sessions only)

 o CURSOR_LTR
 public static final String CURSOR_LTR
cursorDirection property values (VT bi-directional sessions only)

 o CURSOR_RTL
 public static final String CURSOR_RTL
 o THAI_DISPLAY_MODE
 public static final String THAI_DISPLAY_MODE
ThaiDisplayMode property keyword

 o THAI_MODE_1
 public static final String THAI_MODE_1
Thai mode 1 property value - non composed mode (Thai session only)

 o THAI_MODE_2
 public static final String THAI_MODE_2
Thai mode 2 property value - composed mode (Thai session only)

 o THAI_MODE_3
 public static final String THAI_MODE_3
Thai mode 3 property value - composed mode with space alignment (Thai session only)

 o THAI_MODE_4
 public static final String THAI_MODE_4
Thai mode 4 property value - composed mode with EOF alignment (Thai session only)

 o THAI_MODE_5
 public static final String THAI_MODE_5
Thai mode 5 property value - composed mode with space and EOF alignment (Thai session only)

 o CONNECTION_INIT
 public static final int CONNECTION_INIT
commStatus property value - initial state (no connection to host)

 o CONNECTION_PND_INACTIVE
 public static final int CONNECTION_PND_INACTIVE
commStatus property value - pending inactive

 o CONNECTION_INACTIVE
 public static final int CONNECTION_INACTIVE
commStatus property value - inactive (no connection to host)

 o CONNECTION_PND_ACTIVE
 public static final int CONNECTION_PND_ACTIVE
commStatus property value - pending active

 o CONNECTION_ACTIVE
 public static final int CONNECTION_ACTIVE
commStatus property value - active (connected to host)

 o CONNECTION_READY
 public static final int CONNECTION_READY
commStatus property value - host is ready for interaction

 o CONNECTION_DEVICE_NAME_READY
 public static final int CONNECTION_DEVICE_NAME_READY
commStatus property value - the device name is available from the host

 o CONNECTION_WORKSTATION_ID_READY
 public static final int CONNECTION_WORKSTATION_ID_READY
commStatus property value - the workstation ID is available from the host

 o SERVICE_MGR_HOST
 public static final String SERVICE_MGR_HOST
Service manager host property keyword

 o LUM_PORT
 public static final String LUM_PORT
Lum port property keyword

 o LUM_LICENSING
 public static final String LUM_LICENSING
Lum licensing property keyword

 o LUM_SERVER
 public static final String LUM_SERVER
LUM server property keyword

 o PASTE_FIELD_WRAP
 public static final String PASTE_FIELD_WRAP
Paste Field Wrap property keyword

 o PASTE_LINE_WRAP
 public static final String PASTE_LINE_WRAP
Paste word line wrap property keyword

 o PASTE_TO_TRIMMED_AREA
 public static final String PASTE_TO_TRIMMED_AREA
Paste To Trimmed area property keyword

 o PASTE_STOP_PRO_LINE
 public static final String PASTE_STOP_PRO_LINE
Paste Stop At Protected Line property keyword

 o PASTE_TAB_OPTIONS
 public static final String PASTE_TAB_OPTIONS
Paste Tab Options property keyword

 o PASTE_TAB_COLUMNS
 public static final String PASTE_TAB_COLUMNS
Paste Tab Columns property keyword

 o PASTE_TAB_SPACES
 public static final String PASTE_TAB_SPACES
Paste Tab Spaces property keyword

 o COPY_ONLY_IF_TRIMMED
 public static final String COPY_ONLY_IF_TRIMMED
Copy Only If Trimmed property keyword

 o TRIM_RECT_SIZING_HANDLES
 public static final String TRIM_RECT_SIZING_HANDLES
Trim Rectangle Sizing handles

 o TRIM_RECT_REMAIN_AFTER
 public static final String TRIM_RECT_REMAIN_AFTER
Trim Rectangle Remain After Edit

Constructors

 o Session
 public Session()
Constructor which builds a Session Bean using the default property values.

 o Session
 public Session(Properties newProperties) throws PropertyVetoException
Constructor which builds a Session Bean using the property values passed in the Property object. Any properties which are not specified in the Properties object are set to their default values.

Parameters:
newProperties - the new property settings for the Session bean.
Throws: PropertyVetoException
Fired if an incorrect property value is given.

Methods

 o getSession
 public Session getSession()
Needed for SessionInterface

 o dispose
 public void dispose()
Disposes of the Session and all of its resources. This method should be called when a Session instance is no longer needed.

Overrides:
dispose in class HODBean
 o startCommunication
 public void startCommunication()
Starts communications with the host.

 o stopCommunication
 public void stopCommunication()
Stops communications with the host.

 o isCommStarted
 public boolean isCommStarted()
Determines whether the connection with the host has been started. A return value of true means that the connection has been started, but the connection may not be ready for interaction.

See Also:
isCommReady, getCommStatus
 o getCommStatus
 public int getCommStatus()
Returns the status of communications with the host.

The possible values are
Constant Description
CONNECTION_INIT Initial state (no connection with host)
CONNECTION_PND_INACTIVE Stop communications in progress
CONNECTION_INACTIVE The connection is stopped
CONNECTION_PND_ACTIVE Start communications in progress
CONNECTION_ACTIVE Connection is established
CONNECTION_READY Negotiations started

See Also:
isCommReady, isCommStarted
 o isCommReady
 public boolean isCommReady()
Returns true if the host is ready for interaction, otherwise returns false.

See Also:
isCommReady, getCommStatus
 o isDeviceNameReady
 public boolean isDeviceNameReady()
Returns true if the device name is ready, otherwise returns false. This method is only valid for 3270 session.

PComm-unique In Personal Communications, this property is not supported.

 o getDeviceName
 public String getDeviceName()
If isDeviceNameReady() is true, returns the device name in use, otherwise returns null. This method is only valid for 3270 session.

 o isWorkstationIDReady
 public boolean isWorkstationIDReady()
Returns true if the workstation ID is ready, otherwise returns false. This method is only valid for 5250 session.

PComm-unique In Personal Communications, this property is not supported.

 o sendKeys
 public void sendKeys(SendKeyEvent evt)
Handles SendKeyEvents sent to this Session Bean. This method is necessary to implement the SendKeyListener interface.

See Also:
SendKeyListener, SendKeyEvent
 o addCommListener
 public void addCommListener(CommListener l)
Adds a CommEvent listener

Parameters:
l - an object that implements the CommListener interface
See Also:
CommListener, CommEvent
 o removeCommListener
 public void removeCommListener(CommListener l)
Removes a CommEvent listener

Parameters:
l - a previously registered CommListener object
See Also:
CommListener, CommEvent
 o addOIAListener
 public void addOIAListener(OIAListener l)
Adds an OIAEvent listener

Parameters:
l - an object that implements the OIAListener interface
See Also:
OIAListener, OIAEvent
 o removeOIAListener
 public void removeOIAListener(OIAListener l)
Remove an OIAEvent listener

Parameters:
l - a previously registered OIAListener object
See Also:
OIAListener, OIAEvent
 o addPSListener
 public void addPSListener(PSListener l)
Adds a PSEvent listener

Parameters:
l - an object that implements the PSListener interface
See Also:
PSListener, PSEvent
 o removePSListener
 public void removePSListener(PSListener l)
Removes a PSEvent listener

Parameters:
l - a previously registered PSListener object
See Also:
PSListener, PSEvent
 o addGUIListener
 public void addGUIListener(GUIListener l)
Adds a GUIEvent listener

Parameters:
l - an object that implements the GUIListener interface
See Also:
GUIListener, GUIEvent
 o removeGUIListener
 public void removeGUIListener(GUIListener l)
Removes a GUIEvent listener

Parameters:
l - a previously registered GUIListener object
See Also:
GUIListener, GUIEvent
 o addTraceListener
 public void addTraceListener(TraceListener l)
Adds a TraceEvent listener

Parameters:
l - an object that implements the TraceListener interface
Overrides:
addTraceListener in class HODBean
See Also:
TraceListener, TraceEvent
 o getProperties
 public Properties getProperties()
Returns the current properties for Session.

Overrides:
getProperties in class HODBean
 o setSessionType
 public synchronized void setSessionType(String type) throws PropertyVetoException
Sets the sessionType property. This indicates what type of host session will be established. The possible values are:
Constant Description
ECLSession.SESSION_TYPE_3270_STR 3270 session
ECLSession.SESSION_TYPE_5250_STR 5250 session
ECLSession.SESSION_TYPE_VT_STR VT session
ECLSession.SESSION_TYPE_CICS_STR CICS session

PComm-unique In Personal Communications, this property is ignored. The sessionType is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
type - the new sessionType
Throws: PropertyVetoException
Thrown if an invalid property value is given.
See Also:
getSessionType, listSessionTypes
 o getSessionType
 public String getSessionType()
Returns the current setting of the sessionType property.

See Also:
setSessionType, listSessionTypes
 o listSessionTypes
 public static Enumeration listSessionTypes()
Returns a list of the valid sessionType values.

See Also:
setSessionType, listSessionTypes
 o setSessionName
 public void setSessionName(String name) throws PropertyVetoException
Sets the sessionName property.

Parameters:
name - The new session name.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSessionName
 o getSessionName
 public String getSessionName()
Returns the value of the sessionName property.

See Also:
setSessionName
 o setSessionID
 public void setSessionID(String ID) throws PropertyVetoException
Sets the sessionID property.

PComm-unique In Personal Communications, this property can be used to connect to an existing Personal Communications session. Set the sessionID to the one character session ID of the Personal Communications session (for example, "A") to connect to that session.

Parameters:
ID - The new ID.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSessionID
 o getSessionID
 public String getSessionID()
Returns the value of the sessionID property.

See Also:
setSessionID
 o setHost
 public void setHost(String host) throws PropertyVetoException
Sets the name of host associated with this Session Bean. Communication between this Session Bean and the host will be started after a call to startCommunication.

PComm-unique In Personal Communications, the host property is the name of the Personal Communications Workstation Profile (.WS file) that contains the session configuration information. See the "IBM eNetwork Personal Communications Version 4.3 for Windows 95, Windows 98 and Windows NT Quick Beginnings", GC31-8679, for how to create a Personal Communications Workstation Profile.

Parameters:
host - The name of the host.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getHost
 o getHost
 public String getHost()
Returns the current value of the host property.

See Also:
setHost
 o setPort
 public void setPort(int port) throws PropertyVetoException
Sets the port that will be used to communicate with the host.

PComm-unique In Personal Communications, this property is ignored. The port is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
port - The port number.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPort
 o getPort
 public int getPort()
Returns the current value of the port property.

See Also:
setPort
 o setTNEnhanced
 public void setTNEnhanced(boolean enhanced) throws PropertyVetoException
Sets the TNEnhanced property. This method is only valid for 3270 session.

PComm-unique In Personal Communications, this property is ignored. Enhanced Telnet is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
enhanced - Enhanced session (TN3270E) parameters will be negotiated when true.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isTNEnhanced
 o isTNEnhanced
 public boolean isTNEnhanced()
Returns the current value of the TNEnhanced property. This method is only valid for 3270 session.

See Also:
setTNEnhanced
 o setSLPEnabled
 public void setSLPEnabled(boolean slp) throws PropertyVetoException
Sets the SLPEnabled property.

PComm-unique In Personal Communications, this property is ignored. The SLP Enabled is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
slp - Service Location Protocol will be used when true.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSLPEnabled
 o isSLPEnabled
 public boolean isSLPEnabled()
Returns the current value of the SLPEnabled property.

See Also:
setSLPEnabled
 o setSLPScope
 public void setSLPScope(String scope) throws PropertyVetoException
Sets the SLPScope property. This property is only valid when the SLPEnabled property is true.

PComm-unique In Personal Communications, this property is ignored. The SLP Scope is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
scope - The scope which will be used during SLP search for telnet services.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPScope, setSLPThisScopeOnly, setSLPEnabled
 o isValidSLPScope
 public static boolean isValidSLPScope(String scope)
Tests the given SLPScope for correct syntax. This method is called by setSLPScope. If this method returns false setSLPScope will throw a PropertyVetoException.

Parameters:
scope - The scope to be tested. Must be a string, 0 to 128 characters long and contain letters, numbers. Scope may not contain comma "," or colon ":" or forward slash "/".
See Also:
setSLPScope
 o getSLPScope
 public String getSLPScope()
Returns the current value of the SLPScope property.

See Also:
setSLPScope, setSLPThisScopeOnly, setSLPEnabled
 o setSLPThisScopeOnly
 public void setSLPThisScopeOnly(boolean thisScopeOnly) throws PropertyVetoException
Sets the SLPThisScopeOnly property. This property is only valid when the SLPEnabled property is true and there is a SLPScope provided.

PComm-unique In Personal Communications, this property is ignored. This SLP property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
SLPThisScopeOnly - Session will be established only to a server which supports the provided scope.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSLPThisScopeOnly, setSLPScope, setSLPEnabled
 o isSLPThisScopeOnly
 public boolean isSLPThisScopeOnly()
Returns the current value of the SLPThisScopeOnly property.

See Also:
setSLPThisScopeOnly, setSLPScope, setSLPEnabled
 o setSLPMaxWaitTime
 public void setSLPMaxWaitTime(int maxWaitTime) throws PropertyVetoException
Sets the SLPMaxWaitTime in milliseconds that will be used when waiting for service response. This property is only valid when the SLPEnabled property is true.

PComm-unique In Personal Communications, this property is ignored. This SLP property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
maxWaitTime - The maximum wait time for SLP directory agent and service agent responses.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPMaxWaitTime, setSLPEnabled
 o getSLPMaxWaitTime
 public int getSLPMaxWaitTime()
Returns the current value of the SLPMaxWaitTime property.

See Also:
setSLPMaxWaitTime, setSLPEnabled
 o setSLPAS400Name
 public void setSLPAS400Name(String as400Name) throws PropertyVetoException
Sets the SLPAS400Name property. This property is only valid when the SLPEnabled property is true.

PComm-unique In Personal Communications, this property is ignored. This SLP property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
as400name - The as400Name will be used during SLP negotiation. The session will connect to the indicated AS/400.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPAS400Name, setSLPEnabled
 o isValidSLPAS400Name
 public static boolean isValidSLPAS400Name(String as400Name)
Tests the given SLPAS400Name for correct syntax. This method is called by setSLPAS400Name. If this method returns false setSLPAS400Name will throw a PropertyVetoException.

Parameters:
as400name - The as400Name to be tested. Must be a string in the form, x.y, where x and y can each be 1 to 8 characters long and include uppercase letters, numbers, "$", "@" or "#" characters. Neither x nor y may begin with a number.
See Also:
setSLPAS400Name
 o getSLPAS400Name
 public String getSLPAS400Name()
Returns the current value of the SLPAS400Name property.

See Also:
setSLPAS400Name, setSLPEnabled
 o setLUName
 public void setLUName(String luName) throws PropertyVetoException
Sets the LUName property. This property is only valid when the TNEnhanced property is true. This method is only valid for 3270 session.

PComm-unique In Personal Communications, this property is ignored. LUName is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
luName - The LU name which will be used during enhanced negotiation. Maximum length of LU name is 17 characters.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getLUName, setTNEnhanced
 o isValidLUName
 public static boolean isValidLUName(String luName)
Tests the given luName for correct syntax. This method is called by setLUName. If this method returns false setLUName will throw a PropertyVetoException.

Parameters:
luName - The LU name to be tested. Must be a string, 0 to 17 characters in length.
See Also:
setLUName
 o getLUName
 public String getLUName()
Returns the current value of the LUName property. This method is only valid for 3270 session.

See Also:
setLUName, setTNEnhanced
 o setScreenSize
 public void setScreenSize(String screenSize) throws PropertyVetoException
Sets the screenSize property. The supported screen size changes based on the sessionType property. The valid values are:

3270
Constant Description
ECLSession.SESSION_PS_24X80_STR 24 rows by 80 columns
ECLSession.SESSION_PS_32X80_STR 32 rows by 80 columns
ECLSession.SESSION_PS_43X80_STR 43 rows by 80 columns
ECLSession.SESSION_PS_27X132_STR 27 rows by 132 columns

5250
Constant Description
ECLSession.SESSION_PS_24X80_STR 24 rows by 80 columns
ECLSession.SESSION_PS_27X132_STR 27 rows by 132 columns

VT
Constant Description
ECLSession.SESSION_PS_24X80_STR 24 rows by 80 columns
ECLSession.SESSION_PS_24X132_STR 24 rows by 132 columns
ECLSession.SESSION_PS_36X80_STR 36 rows by 80 columns
ECLSession.SESSION_PS_36X132_STR 36 rows by 132 columns
ECLSession.SESSION_PS_48X80_STR 48 rows by 80 columns
ECLSession.SESSION_PS_48X132_STR 48 rows by 132 columns
ECLSession.SESSION_PS_72X80_STR 72 rows by 80 columns
ECLSession.SESSION_PS_72X132_STR 72 rows by 132 columns
ECLSession.SESSION_PS_144X80_STR 144 rows by 80 columns
ECLSession.SESSION_PS_144X132_STR 144 rows by 132 columns

CICS
Constant Description
ECLSession.SESSION_PS_24X80_STR 24 rows by 80 columns

PComm-unique In Personal Communications, this property is ignored. The screenSize is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
size - The new size.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getScreenSize, listScreenSizes, listScreenSizes
 o getScreenSize
 public String getScreenSize()
Returns the current value of the screenSize property.

See Also:
setScreenSize, listScreenSizes, listScreenSizes
 o listScreenSizes
 public Enumeration listScreenSizes()
Returns a list of the valid screenSize values for the current session type.

See Also:
setScreenSize, getScreenSize
 o listScreenSizes
 public static Enumeration listScreenSizes(String sessionType)
Returns a list of the valid screenSize values for the specified session type.

See Also:
setScreenSize, getScreenSize
 o setCodePage
 public void setCodePage(String codePage) throws PropertyVetoException
Sets the codePage property.

PComm-unique In Personal Communications, this property is ignored. The codepage is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
codePage - The new codepage.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getCodePage, listCodePages, listCodePages
 o getCodePage
 public String getCodePage()
Returns the current value of the codePage property.

See Also:
setCodePage, listCodePages, listCodePages
 o listCodePages
 public Enumeration listCodePages()
Returns a list of the valid codePage values for the current session type.

See Also:
setCodePage, getCodePage
 o listCodePages
 public static Enumeration listCodePages(String sessionType)
Returns a list of the valid codePage values for the given session type.

Parameters:
sessionType - The session type for which to generate the list.
See Also:
setCodePage, getCodePage
 o setHostGraphics
 public void setHostGraphics(boolean hostGraphics) throws PropertyVetoException
Sets the hostGraphics property. This indicates whether to enable the host graphics functionality. This property can only be enabled for 3270 sessions.

Parameters:
hostGraphics - The new value for the hostGraphics property
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHostGraphics
 o isHostGraphics
 public boolean isHostGraphics()
Returns the value of the hostGraphics property.

See Also:
setHostGraphics
 o setGraphicsCellSize
 public void setGraphicsCellSize(String cellSize) throws PropertyVetoException
Sets the graphicsCellSize property.

Parameters:
cellSize - The new cell size
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getGraphicsCellSize, listGraphicsCellSizes
 o getGraphicsCellSize
 public String getGraphicsCellSize()
Returns the current value of the graphicsCellSize property.

See Also:
setGraphicsCellSize, listGraphicsCellSizes
 o listGraphicsCellSizes
 public static Enumeration listGraphicsCellSizes()
Returns a list of the valid graphicsCellSize values

See Also:
setGraphicsCellSize, getGraphicsCellSize
 o setENPTUI
 public void setENPTUI(boolean enptui) throws PropertyVetoException
Sets the enptui property. This indicates whether to enable the ENPTUI functionality. This property can only be enabled for 5250 sessions.

PComm-unique In Personal Communications, this property is ignored. ENPTUI is always enabled in Personal Communications.

Parameters:
enptui - The new value for the enptui property
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isENPTUI
 o isENPTUI
 public boolean isENPTUI()
Returns the value of the enptui property.

See Also:
setENPTUI
 o setAutoConnect
 public void setAutoConnect(boolean autoConnect) throws PropertyVetoException
Sets the autoConnect property. This indicates whether to automatically connect to the host when the host property is set.

Parameters:
autoConnect - The new value for the autoConnect property
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isAutoConnect
 o isAutoConnect
 public boolean isAutoConnect()
Returns the value of the autoConnect property.

See Also:
setAutoConnect
 o setAutoReconnect
 public void setAutoReconnect(boolean autoReconnect) throws PropertyVetoException
Sets the autoReconnect property. This indicates whether to automatically connect to the host after the host connection has been dropped.

PComm-unique In Personal Communications, this property is ignored. AutoReconnect is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
autoReconnect - The new value for the autoReconnect property
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isAutoReconnect
 o isAutoReconnect
 public boolean isAutoReconnect()
Returns the current value of the autoReconnect property.

See Also:
setAutoReconnect
 o setSSL
 public void setSSL(boolean ssl) throws PropertyVetoException
Sets the SSL property of Session. This indicates whether to use the Secure Socket Layer (SSL) feature.

PComm-unique In Personal Communications, this property is ignored. SSL is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
SSL - When true, SSL encryption will be enabled.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSL, ssl
 o isSSL
 public boolean isSSL()
Returns the value of the SSL property.

See Also:
setSSL, ssl
 o setSSLTelnetNegotiated
 public void setSSLTelnetNegotiated(boolean TNnegotiated) throws PropertyVetoException
Sets the SSLTelnetNegotiated property of Session. This property should only be set to true if connecting to a Telnet server which supports IETF Internet-Draft "TLS-based Telnet Security." This Internet-Draft defines the protocol for doing the SSL Handshake over a Telnet connection. The SSL property should also be set to true.

PComm-unique In Personal Communications, this property is ignored.

Parameters:
TNnegotiated - Determines if SSL will be negotiated on the Telnet connection.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLTelnetNegotiated, setSSL, sslTelnetNegotiated
 o isSSLTelnetNegotiated
 public boolean isSSLTelnetNegotiated()
Returns the current value of the SSLTelnetNegotiated property.

See Also:
setSSLTelnetNegotiated, setSSL, sslTelnetNegotiated
 o setSSLServerAuthentication
 public void setSSLServerAuthentication(boolean authentication) throws PropertyVetoException
Sets the SSLServerAuthentication property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
authentication - Whether or not SSL server authentication will be enabled.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLServerAuthentication, setSSL, sslServerAuthentication
 o isSSLServerAuthentication
 public boolean isSSLServerAuthentication()
Returns the current value of the SSLServerAuthentication property.

See Also:
setSSLServerAuthentication, setSSL, sslServerAuthentication
 o setSSLBrowserKeyringAdded
 public void setSSLBrowserKeyringAdded(boolean addKeyring) throws PropertyVetoException
Sets the SSLBrowserKeyringAdded property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
addKeyring - Whether or not the browser keyring will be added to the HOD client keyring
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLBrowserKeyringAdded, setSSL, sslBrowserKeyringAdded
 o isSSLBrowserKeyringAdded
 public boolean isSSLBrowserKeyringAdded()
Returns the current value of the SSLBrowserKeyringAdded property.

See Also:
setSSLBrowserKeyringAdded, setSSL, sslBrowserKeyringAdded
 o setSSLCertificateProvided
 public void setSSLCertificateProvided(boolean hasCert) throws PropertyVetoException
Sets the SSLCertificateProvided property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
certificateprovided - Whether or not client has a certificate.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificateProvided, setSSL, sslCertificateProvided
 o isSSLCertificateProvided
 public boolean isSSLCertificateProvided()
Returns the current value of the SSLCertificateProvided property.

See Also:
setSSLCertificateProvided, setSSL, sslCertificateProvided
 o setSSLCertificateSource
 public void setSSLCertificateSource(String src) throws PropertyVetoException
Sets the SSLCertificateSource property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
src - where the certificate is stored (ECLSession.SESSION_SSL_CERTIFICATE_IN_URL or ECLSession.SESSION_SSL_CERTIFICATE_IN_CSP)
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateSource, setSSL, sslCertificateSource
 o getSSLCertificateSource
 public String getSSLCertificateSource()
Returns the current value of the SSLCertificateSource property.

See Also:
setSSLCertificateSource, setSSL, sslCertificateSource
 o setSSLCertificateURL
 public void setSSLCertificateURL(String url) throws PropertyVetoException
Sets the SSLCertificateURL property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
url - URL of client certificate
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateURL, setSSL, sslCertificateURL
 o getSSLCertificateURL
 public String getSSLCertificateURL()
Returns the current value of the SSLCertificateURL property.

See Also:
setSSLCertificateURL, setSSL, sslCertificateURL
 o setSSLCertificatePassword
 public void setSSLCertificatePassword(String password) throws PropertyVetoException
Sets the SSLCertificatePassword property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
password - password of client certificate
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
setSSL, sslCertificatePassword
 o setSSLCertificateName
 public void setSSLCertificateName(String name) throws PropertyVetoException
Sets the SSLCertificateName property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
name - name of the certificate, or "" for any trusted by the server
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateName, setSSL, sslCertificateName
 o getSSLCertificateName
 public String getSSLCertificateName()
Returns the current value of the SSLCertificateName property.

See Also:
setSSLCertificateName, setSSL, sslCertificateName
 o setSSLCertificatePromptHowOften
 public void setSSLCertificatePromptHowOften(String howOften) throws PropertyVetoException
Sets the SSLCertificatePromptHowOften property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
howOften - how often to prompt (ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_EACH_CONNECTION or ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECTION or ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE)
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificatePromptHowOften, setSSL, sslCertificatePromptHowOften
 o getSSLCertificatePromptHowOften
 public String getSSLCertificatePromptHowOften()
Returns the current value of the SSLCertificatePromptHowOften property.

See Also:
setSSLCertificatePromptHowOften, setSSL, sslCertificateName
 o setSSLCertificatePromptBeforeConnect
 public void setSSLCertificatePromptBeforeConnect(boolean before) throws PropertyVetoException
Sets the SSLCertificatePromptBeforeConnect property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
before - Whether the client should be prompted before connecting to the server
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificatePromptBeforeConnect, setSSL, sslCertificateRemembered
 o isSSLCertificatePromptBeforeConnect
 public boolean isSSLCertificatePromptBeforeConnect()
Returns the current value of the SSLCertificatePromptBeforeConnect property.

See Also:
setSSLCertificatePromptBeforeConnect, setSSL, sslCertificateRemembered
 o setSSLCertificateHash
 public void setSSLCertificateHash(String hash) throws PropertyVetoException
Sets the SSLCertificateHash property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
hash - hash of the certificate
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateHash, setSSL, sslCertificateHash
 o getSSLCertificateHash
 public String getSSLCertificateHash()
Returns the current value of the SSLCertificateHash property.

See Also:
setSSLCertificateHash, setSSL, sslCertificateHash
 o setSSLCertificatePrompted
 public void setSSLCertificatePrompted(boolean prompted) throws PropertyVetoException
Sets the SSLCertificatePrompted property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
prompted - Whether or not the user has been prompted for this connection
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificatePrompted, setSSL, sslCertificatePrompted
 o isSSLCertificatePrompted
 public boolean isSSLCertificatePrompted()
Returns the current value of the SSLCertificatePrompted property.

See Also:
setSSLCertificatePrompted, setSSL, sslCertificatePrompted
 o setSSLCertificateRemembered
 public void setSSLCertificateRemembered(boolean remembered) throws PropertyVetoException
Sets the SSLCertificateRemembered property of Session

PComm-unique In Personal Communications, this property is ignored. This SSL property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
remembered - true sets SSLCertificatePromptHowOften to FIRST_CONNECT false sets SSLCertificatrePromptHowOften to EACH_CONNECT
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificateRemembered, setSSL, sslCertificateRemembered
 o isSSLCertificateRemembered
 public boolean isSSLCertificateRemembered()
Returns the current value of the SSLCertificateRemembered property.

See Also:
setSSLCertificateRemembered, setSSL, sslCertificateRemembered
 o setCICSServerName
 public void setCICSServerName(String server) throws PropertyVetoException
Sets the CICSServerName property.

PComm-unique In Personal Communications, this property is ignored. The CICS properties are controlled by the settings in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
server - The new CICS server.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getCICSServerName
 o getCICSServerName
 public String getCICSServerName()
Returns the current value of the CICSServerName property.

See Also:
setCICSServerName
 o setCICSGWCodePage
 public void setCICSGWCodePage(String codePage) throws PropertyVetoException
Sets the CICSGWCodepage property.

PComm-unique In Personal Communications, this property is ignored. The CICS properties are controlled by the settings in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
codePage - The new CICS gateway codepage.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getCICSGWCodePage, listCICSGWCodePages
 o getCICSGWCodePage
 public String getCICSGWCodePage()
Returns the current value of the CICSGWCodepage property.

See Also:
setCICSGWCodePage, listCICSGWCodePages
 o listCICSGWCodePages
 public static Enumeration listCICSGWCodePages()
Returns the list of valid CICSGWCodePage values.

See Also:
setCICSGWCodePage, getCICSGWCodePage
 o setNumericFieldLock
 public void setNumericFieldLock(boolean lock) throws PropertyVetoException
Sets the Numeric Field Lock property of Session. When true, only characters 0 through 9, -, +, period, and comma are allowed in fields defined by a host application as numeric. This property is valid for 3270 and CICS sessions only.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
lock - Whether or not Numeric Field Lock will be enabled.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isNumericFieldLock
 o isNumericFieldLock
 public boolean isNumericFieldLock()
Returns the value of the Numeric Field Lock property.

See Also:
setNumericFieldLock
 o setVTTerminalType
 public void setVTTerminalType(String terminalType) throws PropertyVetoException
Sets the VTTerminalType property. This property applies only to VT sessions. The valid values are:
Constant Description
ECLSession.SESSION_VT_TERMINAL_TYPE_VT52 VT52
ECLSession.SESSION_VT_TERMINAL_TYPE_VT100 VT100
ECLSession.SESSION_VT_TERMINAL_TYPE_VT420_7 VT420 Model 7
ECLSession.SESSION_VT_TERMINAL_TYPE_VT420_8 VT420 Model 8

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
terminalType - The VT terminal type.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getVTTerminalType, listVTTerminalTypes
 o getVTTerminalType
 public String getVTTerminalType()
Returns the current value of the VTTerminalType property.

See Also:
setVTTerminalType, listVTTerminalTypes
 o listVTTerminalTypes
 public static Enumeration listVTTerminalTypes()
Returns a list of the valid VTTerminalTypes.

See Also:
setVTTerminalType, getVTTerminalType
 o setVTAnswerBackMsg
 public void setVTAnswerBackMsg(String ansbackmsg) throws PropertyVetoException
Sets the VTAnswerBackMsg property. This property only applies to VT sessions.

Parameters:
ansbackmsg - A string which is returned to the remote VT server in response to an ENQ command (0x05) This sting can be null or a user defined value.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getVTAnswerBackMsg
 o getVTAnswerBackMsg
 public String getVTAnswerBackMsg()
Returns the current value of the VTAnswerBackMsg property. This property only applies to VT sessions.

See Also:
setVTAnswerBackMsg
 o setVTNewLine
 public void setVTNewLine(boolean CROnly) throws PropertyVetoException
Sets the VTNewLine property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
CROnly - true causes carriage return to be interpreted as CR only, false causes it to be interpreted as a CR and LF.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTNewLine
 o isVTNewLine
 public boolean isVTNewLine()
Returns the current value of the VTNewLine property.

See Also:
setVTNewLine
 o setVTBackspace
 public void setVTBackspace(boolean backspace) throws PropertyVetoException
Sets the VTBackspace property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
backspace - true causes normal backspace behavior, false causes it to delete the character under the cursor.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTBackspace
 o setHistory
 public void setHistory(boolean history) throws PropertyVetoException
Sets the History property. This property currently only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
history - true causes history log to be kept, false will not keep history log information.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHistory
 o isHistory
 public boolean isHistory()
 o setHistorySize
 public void setHistorySize(String size) throws PropertyVetoException
Sets the History size property. This property currently only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
history - is determines the size of the internal planes used to store history log information.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHistory
 o getHistorySize
 public String getHistorySize()
 o listHistorySizes
 public Enumeration listHistorySizes()
Returns a list of the valid History size values for the current session type.

See Also:
setHistorySize, getHistorySize
 o listHistorySizes
 public Enumeration listHistorySizes(String sessionType)
 o setPrintDestination
 public void setPrintDestination(boolean printer) throws PropertyVetoException
Sets the printDestination property. This property only applies to HOD VT sessions.

Parameters:
printer - true causes print job to be sent to a printer device.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPrintDestination
 o isPrintDestination
 public boolean isPrintDestination()
Returns the current value of the printDestination property.

See Also:
setPrintDestination
 o setSeparateFiles
 public void setSeparateFiles(boolean separate) throws PropertyVetoException
Sets the separateFiles property. This property only applies to HOD VT sessions.

Parameters:
true - causes print jobs to be saved in separate files.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSeparateFiles
 o isSeparateFiles
 public boolean isSeparateFiles()
Returns the current value of the separateFiles property.

See Also:
setSeparateFiles
 o setPrintFileName
 public void setPrintFileName(String fileName) throws PropertyVetoException
Sets the printFileName property. This property only applies to HOD VT sessions.

Parameters:
fileName - is the name to be assigned to the print file.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPrintFileName
 o getPrintFileName
 public String getPrintFileName()
Returns the current value of the printFileName property.

See Also:
setPrintFileName
 o setPrinterName
 public void setPrinterName(String printerName) throws PropertyVetoException
Sets the printerName property. This property only applies to HOD VT sessions.

Parameters:
printerName - is the name of the destination printer device.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPrinterName
 o getPrinterName
 public String getPrinterName()
Returns the current value of the printerName property.

See Also:
setPrinterName
 o setWorkstationID
 public void setWorkstationID(String workstationID) throws PropertyVetoException
Sets the workstationID property.

PComm-unique In Personal Communications, this property is ignored. WorkstationID is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
workstation - ID The workstation ID that is used during enhanced negotiation for 5250.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getWorkstationID
 o isValidWorkstationID
 public static boolean isValidWorkstationID(String workstationID)
Tests the given workstationID for correct syntax. This method is called by setWorkstationID. If this method returns false, setWorkstationID throws a PropertyVetoException.

Parameters:
workstation - ID The workstation ID to be tested. Must be a string, 0 to 10 characters long and contain letters, numbers, or ".", "_", "$", "@" or "#" characters. Must not start with a number, "." or "_".
See Also:
setWorkstationID
 o getWorkstationID
 public String getWorkstationID()
Returns the current value of the workstation ID property. This method is only valid for 5250 session.

See Also:
setWorkstationID
 o isVTBackspace
 public boolean isVTBackspace()
Returns the value of the VTBackspace property.

Returns:
the current setting of the VTBackspace property
See Also:
setVTBackspace
 o setVTLocalEcho
 public void setVTLocalEcho(boolean localEcho) throws PropertyVetoException
Sets the VTLocalEcho property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
localEcho - true causes local echo to be on, false causes it to be off.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTLocalEcho
 o isVTLocalEcho
 public boolean isVTLocalEcho()
Returns the value of the VTLocalEcho.

Returns:
the current setting of the VTLocalEcho property
See Also:
setVTNewLine
 o setVTCursor
 public void setVTCursor(boolean application) throws PropertyVetoException
Sets the VTCursor property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
application - true results in application-controlled cursor behavior, false results in normal cursor behavior.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTCursor
 o isVTCursor
 public boolean isVTCursor()
Returns the value of the VTCursor property.

Returns:
the current setting of the VTCursor property
See Also:
setVTCursor
 o setVTKeypad
 public void setVTKeypad(boolean application) throws PropertyVetoException
Sets the VTKeypad property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
application - true causes application keypad control, false causes normal keypad behavior.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTKeypad
 o isVTKeypad
 public boolean isVTKeypad()
Returns the value of the VTKeypad property.

Returns:
the current setting of the VTKeypad property
See Also:
setVTKeypad
 o setVTAutowrap
 public void setVTAutowrap(boolean autowrap) throws PropertyVetoException
Sets the VTAutowrap property. This property only applies to VT sessions.

PComm-unique In Personal Communications, this property is ignored. This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
autowrap - true enables autowrap, false disables it.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTAutowrap
 o isVTAutowrap
 public boolean isVTAutowrap()
Returns the value of the VTAutowrap property.

Returns:
the current setting of the VTAutowrap property
See Also:
setVTAutowrap
 o setVTReverseScreen
 public void setVTReverseScreen(boolean reverse) throws PropertyVetoException
Sets the VTReverseScreen property. This property only applies to VT sessions.

PComm-unique This VT property is controlled by the setting in the Personal Communications Workstation Profile (.WS file) used for this Session.

Parameters:
reverse - true sets reverse video, false sets normal video.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTReverseScreen
 o isVTReverseScreen
 public boolean isVTReverseScreen()
Returns the value of the VTReverseScreen property.

Returns:
the current setting of the VTReverseScreen property
See Also:
setVTReverseScreen
 o setPasteFieldWrap
 public void setPasteFieldWrap(boolean pasteFieldWrap) throws PropertyVetoException
Sets the pasteFieldWrap property. This property does not apply to VT sessions.

Parameters:
pasteFieldWrap - true sets wrap on field, false sets normal wrap
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteFieldWrap
 o isPasteFieldWrap
 public boolean isPasteFieldWrap()
Returns the value of the pasteFieldWrap property.

Returns:
the current setting of the pasteFieldWrap property
See Also:
setPasteFieldWrap
 o setPasteLineWrap
 public void setPasteLineWrap(boolean pasteLineWrap) throws PropertyVetoException
Sets the pasteLineWrap property.

Parameters:
pasteLineWrap - true sets wrap on field, false sets normal wrap
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteLineWrap
 o isPasteLineWrap
 public boolean isPasteLineWrap()
Returns the value of the pasteLineWrap property.

Returns:
the current setting of the pasteLineWrap property
See Also:
setPasteLineWrap
 o setPasteToTrimmedArea
 public void setPasteToTrimmedArea(boolean pasteToTrimmedArea) throws PropertyVetoException
Sets the pasteToTrimmedArea property. This property does not apply to VT sessions.

Parameters:
pasteToTrimmedArea - true sets paste to paste into trimmed area if defined, false sets normal paste
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteToTrimmedArea
 o isPasteToTrimmedArea
 public boolean isPasteToTrimmedArea()
Returns the value of the pasteToTrimmedArea property.

Returns:
the current setting of the pasteToTrimmedArea property
See Also:
setPasteToTrimmedArea
 o setPasteStopAtProtectedLine
 public void setPasteStopAtProtectedLine(boolean pasteStopAtProtectedLine) throws PropertyVetoException
Sets the pasteStopAtProtectedLine property. This property does not apply to VT sessions.

Parameters:
pasteStopAtProtectedLine - true sets stop on paste onto protected line, false sets normal paste
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteStopAtProtectedLine
 o isPasteStopAtProtectedLine
 public boolean isPasteStopAtProtectedLine()
Returns the value of the pasteStopAtProtectedLine property.

Returns:
the current setting of the pasteStopAtProtectedLine property
See Also:
setPasteStopAtProtectedLine
 o setPasteTabOptions
 public void setPasteTabOptions(String pasteTabOptions) throws PropertyVetoException
Sets the pasteTabOptions property.

Parameters:
ns - Can be one of the following string constants: ECLSession.SESSION_PASTE_TAB_OPTIONS_COLUMNS_STR ECLSession.SESSION_PASTE_TAB_OPTIONS_SPACES_STR ECLSession.SESSION_PASTE_TAB_OPTIONS_FIELDWRAP_STR
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getPasteTabOptions, listPasteTabOptions
 o getPasteTabOptions
 public String getPasteTabOptions()
Returns the current setting of the pasteOptionsType property.

See Also:
setPasteTabOptions, listPasteTabOptions
 o listPasteTabOptions
 public static Enumeration listPasteTabOptions()
Returns a list of the valid pasteOptionsType values.

See Also:
setPasteTabOptions, getPasteTabOptions
 o setPasteTabColumns
 public void setPasteTabColumns(int pasteTabColumns) throws PropertyVetoException
Sets the pasteTabColumns to set the number of columns represented by a tab. If this option is active, when tab is encountered, the input skips to the column that is a multiple of this setting

Parameters:
pasteTabColumns - the size of the tab in columns
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPasteTabColumns
 o getPasteTabColumns
 public int getPasteTabColumns()
Returns the current value of the pasteTabColumns property.

See Also:
setPasteTabColumns
 o setPasteTabSpaces
 public void setPasteTabSpaces(int pasteTabSpaces) throws PropertyVetoException
Sets the pasteTabSpaces to set the number of spaces represented by a tab. If this option is active, when tab is encountered, the input skips the number of spaces specified in this setting

Parameters:
pasteTabSpaces - The number of spaces to advance for a tab
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPasteTabSpaces
 o getPasteTabSpaces
 public int getPasteTabSpaces()
Returns the current value of the pasteTabSpaces property.

See Also:
setPasteTabSpaces
 o setTrimRectSizingHandles
 public void setTrimRectSizingHandles(boolean trimRectSizingHandles) throws PropertyVetoException
Sets the trimRectSizingHandles property.

Parameters:
trimRectSizingHandles - true sets trim rec sizeable, false sets unsizeable
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isTrimRectSizingHandles
 o isTrimRectSizingHandles
 public boolean isTrimRectSizingHandles()
Returns the value of the trimRectSizingHandles property.

Returns:
the current setting of the trimRectSizingHandles property
See Also:
setTrimRectSizingHandles
 o setTrimRectRemainAfterEdit
 public void setTrimRectRemainAfterEdit(boolean trimRectRemainAfterEdit) throws PropertyVetoException
Sets the trimRectRemainAfterEdit property.

Parameters:
trimRectRemainAfterEdit - true sets trim rec remain after cut/copy/paste, false does not remain
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isTrimRectRemainAfterEdit
 o isTrimRectRemainAfterEdit
 public boolean isTrimRectRemainAfterEdit()
Returns the value of the trimRectRemainAfterEdit property.

Returns:
the current setting of the trimRectRemainAfterEdit property
See Also:
setTrimRectRemainAfterEdit
 o setCopyOnlyIfTrimmed
 public void setCopyOnlyIfTrimmed(boolean copyOnlyIfTrimmed) throws PropertyVetoException
Sets the copyOnlyIfTrimmed property.

Parameters:
copyOnlyIfTrimmed - true sets copy error when no trim, false copy entire screen when no trim
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isCopyOnlyIfTrimmed
 o isCopyOnlyIfTrimmed
 public boolean isCopyOnlyIfTrimmed()
Returns the value of the copyOnlyIfTrimmed property.

Returns:
the current setting of the copyOnlyIfTrimmed property
See Also:
setCopyOnlyIfTrimmed
 o getECLSession
 public ECLSession getECLSession()
Returns the ECLSession object associated with this Session. This is useful if you'd like to use the Host Access Class Library (HACL) API to interact with the host.

 o defaults
 public static Properties defaults()
Returns a Properties object containing the default properties and their values for this Session Bean.

 o setNumeralShape
 public void setNumeralShape(String ns) throws PropertyVetoException
Sets the numeralShape property. This property applies to bi-directional Sessions only.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
ns - Can be one of the following string constants: Session.NOMINAL, Session.NATIONAL, or Session.CONTEXTUAL.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
 o getNumeralShape
 public String getNumeralShape()
Returns the current value of the numeralShape property.

See Also:
setNumeralShape
 o listNumeralShapes
 public static Enumeration listNumeralShapes()
Returns the list of valid numeralShape values.

See Also:
setNumeralShape
 o setTextType
 public void setTextType(String tt) throws PropertyVetoException
Sets the textType property. This property applies to bi-directional Sessions only.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
tt - Can be one of the following string constants: Session.VISUAL or Session.LOGICAL.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
 o getTextType
 public String getTextType()
Returns the current value of the textType property.

See Also:
setTextType
 o listTextTypes
 public static Enumeration listTextTypes()
Returns the list of valid textType values.

See Also:
setTextType
 o setTextOrientation
 public void setTextOrientation(String to) throws PropertyVetoException
Sets the textOrientation property. This property applies to bi-directional Sessions only.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
to - Can be one of the following string constants: Session.LEFT_TO_RIGHT or Session.RIGHT_TO_LEFT.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
 o getTextOrientation
 public String getTextOrientation()
Returns the current value of the textOrientation property.

See Also:
setTextOrientation
 o listTextOrientations
 public static Enumeration listTextOrientations()
Returns a list of the valid textOrientation values.

See Also:
setTextOrientation
 o setThaiDisplayMode
 public void setThaiDisplayMode(int mode) throws PropertyVetoException
Set Thai display mode property. This property applies to Thai Session only.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
mode - Thai display mode.
Throws: PropertyVetoException
Thrown if a VetoableChangeListener vetoes the new value
See Also:
getThaiDisplayMode
 o getThaiDisplayMode
 public int getThaiDisplayMode()
Returns the current value of the ThaiDisplayMode property

See Also:
setThaiDisplayMode
 o listThaiDisplayModes
 public static Enumeration listThaiDisplayModes()
Returns the list of valid ThaiDisplayMode values.

See Also:
setThaiDisplayMode
 o getTraceName
 public String getTraceName()
Returns a trace identifier for this bean

Overrides:
getTraceName in class HODBean
 o setBIDIMode
 public void setBIDIMode(String to) throws PropertyVetoException
 o getBIDIMode
 public String getBIDIMode()
 o setTextTypeDisp
 public void setTextTypeDisp(String to) throws PropertyVetoException
 o getTextTypeDisp
 public String getTextTypeDisp()
 o setCursorDirection
 public void setCursorDirection(String to) throws PropertyVetoException
 o getCursorDirection
 public String getCursorDirection()
 o setNumeralShapeDisp
 public void setNumeralShapeDisp(String to) throws PropertyVetoException
 o getNumeralShapeDisp
 public String getNumeralShapeDisp()
 o listTextTypesDisp
 public static Enumeration listTextTypesDisp()
 o listCursorDirections
 public static Enumeration listCursorDirections()
 o listBIDIModes
 public static Enumeration listBIDIModes()
 o listNumeralShapesDisp
 public static Enumeration listNumeralShapesDisp()
 o setLUMPort
 public void setLUMPort(int PortNumber) throws PropertyVetoException
Sets the LUMPort property.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
PortNumber - Port number for the LUM server
 o getLUMPort
 public int getLUMPort()
Returns the LUM server port number

 o setServiceMgrHost
 public void setServiceMgrHost(String ServerMgrHost) throws PropertyVetoException
Sets the HOD server property.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
ServerMgrHost - name for the HOD server
 o getServiceMgrHost
 public String getServiceMgrHost()
Returns the HOD server

 o setLUMLicensing
 public void setLUMLicensing(String servertype) throws PropertyVetoException
Sets the license method to either LUM or HOD.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
servertype - Set types for the LUM or HOD Licensing
 o getLUMLicensing
 public String getLUMLicensing()
Returns the License method type

 o listLUMLicensing
 public static Enumeration listLUMLicensing()
 o setLUMServer
 public void setLUMServer(String LUMServer) throws PropertyVetoException
Sets the LUM server property.

PComm-unique In Personal Communications, this property is not supported.

Parameters:
LumServer - name for the LUM server
 o getLUMServer
 public String getLUMServer()
Returns the LUM server

 o setSymmetricSwapEnabled
 public void setSymmetricSwapEnabled(boolean value) throws PropertyVetoException
Sets the Symmetric swapping property. This property applies (Arabic 3270 sessions only)

PComm-unique In Personal Communications, this property is not supported.

 o isSymmetricSwapEnabled
 public boolean isSymmetricSwapEnabled()
Returns the current value of the Symmetric Swapping property.

See Also:
setSymmetricSwapEnabled
 o setNumericSwapEnabled
 public void setNumericSwapEnabled(boolean value) throws PropertyVetoException
Sets the Numeric swapping property. This property applies (Arabic 3270 sessions only)

PComm-unique In Personal Communications, this property is not supported.

 o isNumericSwapEnabled
 public boolean isNumericSwapEnabled()
Returns the current value of the Numeric Swapping property.

See Also:
setNumericSwapEnabled
 o getSecurityInfoIntf
 public Object getSecurityInfoIntf(Frame frame)

All Packages  Class Hierarchy  This Package  Previous  Next  Index