com.ibm.eNetwork.beans.HOD
Class Session

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.HODBean
        |
        +--com.ibm.eNetwork.beans.HOD.Session
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, java.io.Externalizable, com.ibm.eNetwork.HOD.common.HODConstants, java.beans.PropertyChangeListener, SendKeyListener, java.io.Serializable, com.ibm.eNetwork.beans.HOD.SessionInterface, TraceProducer
Direct Known Subclasses:
HostPrintSession

public class Session
extends HODBean
implements SendKeyListener, java.beans.PropertyChangeListener, com.ibm.eNetwork.beans.HOD.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
BIDIMode enum* BIDIMODE_ON 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
copyAltSignLocation boolean false read/write
cursorDirection enum* ECLSession.CURSOR_LTR read/write
cursorMovementState boolean true read/write
deviceNameReady boolean false read
enptui boolean false read/write
graphicsCellSize String ECLSession.SESSION_PS_CELL_AUTO_STR 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
Lamalef enum* LAMALEF_OFF 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
numeralShapeDisp enum* NOMINAL_DISP read/write
numericFieldLock boolean false read/write
InsertOffOnAIDKEY boolean false read/write
numericSwapEnabled boolean true read/write
pasteFieldWrap boolean false read/write
pasteLineWrap boolean false read/write
pasteWordBreak 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
RoundTrip enum* ROUNDTRIP_ON 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
showTextAttributesEnabled boolean true 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
SmartOrdering enum* SMART_ORDERING_OFF read/write
SSL boolean false read/write
SecurityProtocol String TLS read/write
SSLBrowserKeyringAdded boolean false read/write
SSLCertificateHash String read/write
SSLCertificatePromptHowOften 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
textTypeDisp enum* VISUAL_DISP 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
VT ID String ECLSession.SESSION_VT_ID_DEFAULT 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
VTPrintConvert boolean false read/write
VTPDTName String 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)

See Also:
Serialized Form

Field Summary
static java.lang.String AUTO_CONNECT
          autoConnect property keyword
static java.lang.String AUTO_RECONNECT
          autoReconnect property keyword
static java.lang.String BIDI_MODE
          BIDIMode property keyword (VT bi-directional sessions only)
static java.lang.String BIDI_MODE_OFF
           
static java.lang.String BIDI_MODE_ON
          BIDIMode property values (VT bi-directional sessions only)
static java.lang.String CICS_GW_CODE_PAGE
          CICSGWCodePage property keyword
static java.lang.String CICS_SERVER_NAME
          CICSServerName property keyword
static java.lang.String CODE_PAGE
          codePage property keyword
static int CONNECTION_ACTIVE
          commStatus property value - active (connected to host)
static int CONNECTION_DEVICE_NAME_READY
          commStatus property value - the device name is available from the host
static int CONNECTION_INACTIVE
          commStatus property value - inactive (no connection to host)
static int CONNECTION_INIT
          commStatus property value - initial state (no connection to host)
static int CONNECTION_PND_ACTIVE
          commStatus property value - pending active
static int CONNECTION_PND_INACTIVE
          commStatus property value - pending inactive
static int CONNECTION_READY
          commStatus property value - host is ready for interaction
static int CONNECTION_WORKSTATION_ID_READY
          commStatus property value - the workstation ID is available from the host
static java.lang.String CONTEXTUAL
          numeralShape property value - contextual (bi-directional sessions only)
static java.lang.String CONTEXTUAL_DISP
           
static java.lang.String COPY_ALT_SIGN_LOCATION
          Copy, force leading sign char '+' '-' property keyword
static java.lang.String COPY_ONLY_IF_TRIMMED
          Copy Only If Trimmed property keyword
static java.lang.String CURSOR_DIRECTION
          cursorDirection property keyword (VT bi-directional sessions only)
static java.lang.String CURSOR_LTR
          cursorDirection property values (VT bi-directional sessions only)
static java.lang.String CURSOR_MOVEMENT_STATE
          CursorMovementState property keyword
static java.lang.String CURSOR_RTL
           
static java.lang.String ENPTUI
          enptui property keyword
static java.lang.String GRAPHICS_CELL_SIZE
          graphicsCellSize property keyword
static java.lang.String HISTORY
          History property keyword
static java.lang.String HISTORY_SIZE
          History size property keyword
static java.lang.String HOST
          host property keyword
static java.lang.String HOST_GRAPHICS
          hostGraphics property keyword
static java.lang.String INSERT_OFF_ON_AIDKEY
          InsertOffOnAIDKEY property keyword
static java.lang.String LAMALEF
          lamalef property keyword
static java.lang.String LAMALEF_OFF
           
static java.lang.String LAMALEF_ON
          lamalef property values (5250 session only)
static java.lang.String LEFT_TO_RIGHT
          textOrientation property value - left to right (bi-directional sessions only)
static java.lang.String LOGICAL
          textType property value - logical (bi-directional sessions only)
static java.lang.String LOGICAL_DISP
           
static java.lang.String LU_NAME
          LUName property keyword
static java.lang.String LUM_LICENSING
          Lum licensing property keyword
static java.lang.String LUM_PORT
          Lum port property keyword
static java.lang.String LUM_SERVER
          LUM server property keyword
static java.lang.String NATIONAL
          numeralShape property value - national (bi-directional sessions only)
static java.lang.String NATIONAL_DISP
           
static java.lang.String NOMINAL
          numeralShape property value - nominal (bi-directional sessions only)
static java.lang.String NOMINAL_DISP
          numeralShapeDisp property values (VT bi-directional sessions only)
static java.lang.String NUM_FIELD_LOCK
          numericFieldLock property keyword
static java.lang.String NUM_SWAP_ENABLED
          Numeric swapping value - (Arabic 3270 sessions only)
static java.lang.String NUMERAL_SHAPE
          numeralShape property keyword
static java.lang.String NUMERAL_SHAPE_DISP
          numeralShapeDisp property keyword (VT bi-directional sessions only)
static java.lang.String PASTE_FIELD_WRAP
          Paste Field Wrap property keyword
static java.lang.String PASTE_LINE_WRAP
          Paste word line wrap property keyword
static java.lang.String PASTE_STOP_PRO_LINE
          Paste Stop At Protected Line property keyword
static java.lang.String PASTE_TAB_COLUMNS
          Paste Tab Columns property keyword
static java.lang.String PASTE_TAB_OPTIONS
          Paste Tab Options property keyword
static java.lang.String PASTE_TAB_SPACES
          Paste Tab Spaces property keyword
static java.lang.String PASTE_TO_TRIMMED_AREA
          Paste To Trimmed area property keyword
static java.lang.String PASTE_WORD_BREAK
          Paste Don't Split Words property keyword
static java.lang.String PORT
          port property keyword
static java.lang.String PRINT_BUFFSIZE
          printBufferSize property keyword
static java.lang.String PRINT_DESTINATION
          printDestination property keyword
static java.lang.String PRINT_FILE_NAME
          printFileName property keyword
static java.lang.String PRINT_SEPARATE_FILES
          separateFiles property keyword
static java.lang.String PRINTER_NAME
          printerName property keyword
static java.lang.String PROXY_AUTHEN_CLEAR_TEXT
           
static java.lang.String PROXY_AUTHEN_METHOD
           
static java.lang.String PROXY_AUTHEN_NONE
           
static java.lang.String PROXY_BROWSER_DEFAULT
           
static java.lang.String PROXY_HTTP
           
static java.lang.String PROXY_SOCKS_PASSWORD
           
static java.lang.String PROXY_SOCKS_USERSID
           
static java.lang.String PROXY_SOCKS_V4
           
static java.lang.String PROXY_SOCKS_V5
           
static java.lang.String PROXY_SOCKS_V5_THEN_V4
           
static java.lang.String PROXY_SRV_HOST_NAME
           
static java.lang.String PROXY_SRV_HOST_PORT
           
static java.lang.String PROXY_TYPE
           
static java.lang.String RIGHT_TO_LEFT
          textOrientation property value - right to left (bi-directional sessions only)
static java.lang.String ROUNDTRIP
          roundTrip property keyword
static java.lang.String ROUNDTRIP_OFF
          roundTrip property value - roindtrip off (bi-directional sessions only)
static java.lang.String ROUNDTRIP_ON
          roundTrip property value - roindtrip on (bi-directional sessions only)
static java.lang.String SCREEN_SIZE
          screenSize property keyword
static java.lang.String SECURITY_PROTOCOL
          SecurityProtocol property keyword
static java.lang.String SERVICE_MGR_HOST
          Service manager host property keyword
static java.lang.String SESSION_ID
          sessionID property keyword
static java.lang.String SESSION_NAME
          sessionName property keyword
static java.lang.String SESSION_TYPE
          sessionType property keyword
static java.lang.String SHOW_TEXT_ATTRIBUTES_ENABLED
          ShowTextAttributes property value (VT logical bi-directional sessions only)
static java.lang.String SLP_AS400_NAME
          SLPAS400Name property keyword
static java.lang.String SLP_ENABLED
          SLPEnabled property keyword
static java.lang.String SLP_MAX_WAIT_TIME
          SLPMaxWaitTime Property keyword
static java.lang.String SLP_SCOPE
          SLPScope property keyword
static java.lang.String SLP_THIS_SCOPE_ONLY
          SLPThisScopeOnly property keyword
static java.lang.String SMART_ORDERING
          smartOrdering property keyword (VT logical bi-directional sessions only)
static java.lang.String SMART_ORDERING_OFF
           
static java.lang.String SMART_ORDERING_ON
          smartOrdering property values (VT logical bi-directional sessions only)
static java.lang.String SSL
          SSL property keyword
static java.lang.String SSL_BROWSER_KEYRING_ADDED
          SSLBrowserKeyringAdded property keyword
static java.lang.String SSL_CERTIFICATE_HASH
          SSLCertificateHash property keyword
static java.lang.String SSL_CERTIFICATE_NAME
          SSLCertificateName property keyword
static java.lang.String SSL_CERTIFICATE_PASSWORD
          SSLCertificatePassword property keyword
static java.lang.String SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
          SSLCertificatePromptBeforeConnect property keyword
static java.lang.String SSL_CERTIFICATE_PROMPT_HOW_OFTEN
          SSLCertificatePromptHowOften property keyword
static java.lang.String SSL_CERTIFICATE_PROMPTED
          SSLCertificatePrompted property keyword
static java.lang.String SSL_CERTIFICATE_PROVIDED
          SSLCertificateProvided property keyword
static java.lang.String SSL_CERTIFICATE_REMEMBERED
          SSLCertificateRemembered property keyword
static java.lang.String SSL_CERTIFICATE_SOURCE
          SSLCertificateSource property keyword
static java.lang.String SSL_CERTIFICATE_URL
          SSLCertificateURL property keyword
static java.lang.String SSL_IGNORE_WELLKNOWNTRUSTEDCA_CLASS
          ignoreWellKnownTrustedCAs property keyword
static java.lang.String SSL_SERVER_AUTHENTICATION
          SSLServerAuthentication property keyword
static java.lang.String SSL_TELNET_NEGOTIATED
          SSLTelnetNegotiated property keyword
static java.lang.String SYM_SWAP_ENABLED
          symmetric swapping value - (Arabic 3270 sessions only)
static java.lang.String TEXT_ORIENTATION
          textOrientation property keyword
static java.lang.String TEXT_TYPE
          textType property keyword
static java.lang.String TEXT_TYPE_DISP
          textTypeDisp property keyword (VT bi-directional sessions only)
static java.lang.String THAI_DISPLAY_MODE
          ThaiDisplayMode property keyword
static java.lang.String THAI_MODE_1
          Thai mode 1 property value - non composed mode (Thai session only)
static java.lang.String THAI_MODE_2
          Thai mode 2 property value - composed mode (Thai session only)
static java.lang.String THAI_MODE_3
          Thai mode 3 property value - composed mode with space alignment (Thai session only)
static java.lang.String THAI_MODE_4
          Thai mode 4 property value - composed mode with EOF alignment (Thai session only)
static java.lang.String THAI_MODE_5
          Thai mode 5 property value - composed mode with space and EOF alignment (Thai session only)
static java.lang.String TN_ENHANCED
          TNEnhanced property keyword
static java.lang.String TRIM_RECT_REMAIN_AFTER
          Trim Rectangle Remain After Edit
static java.lang.String TRIM_RECT_SIZING_HANDLES
          Trim Rectangle Sizing handles
static java.lang.String UDC_OFF
           
static java.lang.String UDC_ON
           
static java.lang.String UDC_SETTING
           
static java.lang.String UDC_TABLE_SELECTION
           
static java.lang.String VISUAL
          textType property value - visual (bi-directional sessions only)
static java.lang.String VISUAL_DISP
          textTypeDisp property values (VT bi-directional sessions only)
static java.lang.String VT_ANS_BACK_MSG
          VTAnswerBackMsg property keyword
static java.lang.String VT_AUTOWRAP
          VTAutowrap property keyword
static java.lang.String VT_BACKSPACE
          VTBackspace property keyword
static java.lang.String VT_CURSOR
          VTCursor property keyword
static java.lang.String VT_ID
          //@d79a VT ID property keyword //@d79a
static java.lang.String VT_KEYPAD
          VTKeypad property keyword
static java.lang.String VT_LOCAL_ECHO
          VTLocalEcho property keyword
static java.lang.String VT_NEW_LINE
          VTNewLine property keyword
static java.lang.String VT_PRINT_ASCII_CONVERT
           
static java.lang.String VT_REVERSE_SCREEN
          VTReverseScreen property keyword
static java.lang.String VT_TERMINAL_TYPE
          VTTerminalType property keyword
static java.lang.String WORKSTATION_ID
          workstationID property keyword
 
Fields inherited from class com.ibm.eNetwork.beans.HOD.HODBean
BEAN_VERSION_STRING, TRACE_LEVEL, TRACE_MAXIMUM, TRACE_MINIMUM, TRACE_NONE, TRACE_NORMAL
 
Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT
 
Constructor Summary
Session()
          Constructor which builds a Session Bean using the default property values.
Session(java.util.Properties newProperties)
          Constructor which builds a Session Bean using the property values passed in the Properties object.
 
Method Summary
 void addCommListener(CommListener l)
          Adds a CommEvent listener
 void addGUIListener(GUIListener l)
          Adds a GUIEvent listener
 void addOIAListener(OIAListener l)
          Adds an OIAEvent listener
 void addPSListener(PSListener l)
          Adds a PSEvent listener
 void addTraceListener(TraceListener l)
          Adds a TraceEvent listener
static java.util.Properties defaults()
          Returns a Properties object containing the default properties and their values for this Session Bean.
 void dispose()
          Disposes of the Session and all of its resources.
 java.lang.String getBIDIMode()
          Returns the current value of the BIDIMode property
 java.lang.String getCICSGWCodePage()
          Returns the current value of the CICSGWCodepage property.
 java.lang.String getCICSServerName()
          Returns the current value of the CICSServerName property.
 java.lang.String getCodePage()
          Returns the current value of the codePage property.
 int getCommStatus()
          Returns the status of communications with the host.
 java.lang.String getCursorDirection()
          Returns the current value of the cursorDirection property
 boolean getCursorMovementState()
          Returns the current value of the CursorMovementState property.
 java.lang.String getDeviceName()
          If isDeviceNameReady() is true, returns the device name in use, otherwise returns null.
 com.ibm.eNetwork.ECL.ECLSession getECLSession()
          Returns the ECLSession object associated with this Session.
 java.lang.String getGraphicsCellSize()
          Returns the current value of the graphicsCellSize property.
 java.lang.String getHistorySize()
           
 java.lang.String getHost()
          Returns the current value of the host property.
 java.lang.String getLamAlef()
          Returns the current value of the LamAlef property.
 java.lang.String getLUMLicensing()
          Returns the License method type
 int getLUMPort()
          Returns the LUM server port number
 java.lang.String getLUMServer()
          Returns the LUM server
 java.lang.String getLUName()
          Returns the current value of the LUName property.
 java.lang.String getNumeralShape()
          Returns the current value of the numeralShape property.
 java.lang.String getNumeralShapeDisp()
          Returns the current value of the numeralShapeDisp property
 int getPasteTabColumns()
          Returns the current value of the pasteTabColumns property.
 java.lang.String getPasteTabOptions()
          Returns the current setting of the pasteOptionsType property.
 int getPasteTabSpaces()
          Returns the current value of the pasteTabSpaces property.
 int getPort()
          Returns the current value of the port property.
 java.lang.String getPrinterName()
          Returns the current value of the printerName property.
 java.lang.String getPrintFileName()
          Returns the current value of the printFileName property.
 java.util.Properties getProperties()
          Returns the current properties for Session.
 java.lang.String getProxyAuthenMethod()
          Returns the current value of the Socks v5 authentication method.
 java.lang.String getProxyServerName()
          Returns the currently defined proxy server.
 int getProxyServerPort()
          Returns the current value of the port to connect to on proxy server.
 java.lang.String getProxyType()
          Returns the current value of the proxy server property.
 java.lang.String getProxyUserID()
          Returns the current value of the user id used for authentication with the Socks v5 Proxy.
 java.lang.String getProxyUserPassword()
          Returns the current value of the password used for authentication with the Socks 5 Proxy.
 java.lang.String getRoundTrip()
          Returns the current value of the roundTrip property.
 java.lang.String getScreenSize()
          Returns the current value of the screenSize property.
 java.lang.String getSecurityProtocol()
          Returns the value of the SecurityProtocol property.
 java.lang.String getServiceMgrHost()
          Returns the HOD server
 Session getSession()
          Needed for SessionInterface
 java.lang.String getSessionID()
          Returns the value of the sessionID property.
 java.lang.String getSessionName()
          Returns the value of the sessionName property.
 java.lang.String getSessionType()
          Returns the current setting of the sessionType property.
 java.lang.String getSLPAS400Name()
          Returns the current value of the SLPAS400Name property.
 int getSLPMaxWaitTime()
          Returns the current value of the SLPMaxWaitTime property.
 java.lang.String getSLPScope()
          Returns the current value of the SLPScope property.
 java.lang.String getSmartOrdering()
          Returns the current value of the smartOrdering property
 java.lang.String getSSLCertificateHash()
          Returns the current value of the SSLCertificateHash property.
 java.lang.String getSSLCertificateName()
          Returns the current value of the SSLCertificateName property.
 java.lang.String getSSLCertificatePromptHowOften()
          Returns the current value of the SSLCertificatePromptHowOften property.
 java.lang.String getSSLCertificateSource()
          Returns the current value of the SSLCertificateSource property.
 java.lang.String getSSLCertificateURL()
          Returns the current value of the SSLCertificateURL property.
 java.lang.String getTextOrientation()
          Returns the current value of the textOrientation property.
 java.lang.String getTextType()
          Returns the current value of the textType property.
 java.lang.String getTextTypeDisp()
          Returns the current value of the TextTypeDisp property
 int getThaiDisplayMode()
          Returns the current value of the ThaiDisplayMode property
 int getTimeout()
          Returns the current value of the timeout property in millisecs
 java.lang.String getTraceName()
          Returns a trace identifier for this bean
 java.lang.String getVTAnswerBackMsg()
          Returns the current value of the VTAnswerBackMsg property.
 java.lang.String getVTID()
           
 java.lang.String getVTPDTName()
          Returns the name of PDT file for VT BIDI session
 java.lang.String getVTTerminalType()
          Returns the current value of the VTTerminalType property.
 java.lang.String getWorkstationID()
          Returns the current value of the workstation ID property.
 boolean isAutoConnect()
          Returns the value of the autoConnect property.
 boolean isAutoReconnect()
          Returns the current value of the autoReconnect property.
 boolean isCommReady()
          Returns true if the host is ready for interaction, otherwise returns false.
 boolean isCommStarted()
          Determines whether the connection with the host has been started.
 boolean isCopyAltSignLocation()
          Returns the value of the copyAltSignLocation property.
 boolean isCopyOnlyIfTrimmed()
          Returns the value of the copyOnlyIfTrimmed property.
 boolean isDeviceNameReady()
          Returns true if the device name is ready, otherwise returns false.
 boolean isENPTUI()
          Returns the value of the enptui property.
 boolean isHistory()
           
 boolean isHostGraphics()
          Returns the value of the hostGraphics property.
 boolean isIgnoreWellKnownTrustedCAs()
          Returns the value of the ignoreWellKnownTrustedCAs property.
 boolean isInsertOffOnAIDKEY()
          Returns the value of the Insert OFF on AID KEY property.
 boolean isNumericFieldLock()
          Returns the value of the Numeric Field Lock property.
 boolean isNumericSwapEnabled()
          Returns the current value of the Numeric Swapping property.
 boolean isPasteFieldWrap()
          Returns the value of the pasteFieldWrap property.
 boolean isPasteLineWrap()
          Returns the value of the pasteLineWrap property.
 boolean isPasteStopAtProtectedLine()
          Returns the value of the pasteStopAtProtectedLine property.
 boolean isPasteToTrimmedArea()
          Returns the value of the pasteToTrimmedArea property.
 boolean isPasteWordBreak()
          Returns the value of the pasteWordBreak property.
 boolean isPrintDestination()
          Returns the current value of the printDestination property.
 boolean isSeparateFiles()
          Returns the current value of the separateFiles property.
 boolean isShowTextAttributesEnabled()
          Returns the current value of the Show Text Attributes property.
 boolean isSLPEnabled()
          Returns the current value of the SLPEnabled property.
 boolean isSLPThisScopeOnly()
          Returns the current value of the SLPThisScopeOnly property.
 boolean isSSL()
          Returns the value of the SSL property.
 boolean isSSLBrowserKeyringAdded()
          Returns the current value of the SSLBrowserKeyringAdded property.
 boolean isSSLCertificatePromptBeforeConnect()
          Returns the current value of the SSLCertificatePromptBeforeConnect property.
 boolean isSSLCertificatePrompted()
          Returns the current value of the SSLCertificatePrompted property.
 boolean isSSLCertificateProvided()
          Returns the current value of the SSLCertificateProvided property.
 boolean isSSLCertificateRemembered()
          Returns the current value of the SSLCertificateRemembered property.
 boolean isSSLServerAuthentication()
          Returns the current value of the SSLServerAuthentication property.
 boolean isSSLTelnetNegotiated()
          Returns the current value of the SSLTelnetNegotiated property.
 boolean isSymmetricSwapEnabled()
          Returns the current value of the Symmetric Swapping property.
 boolean isTNEnhanced()
          Returns the current value of the TNEnhanced property.
 boolean isTrimRectRemainAfterEdit()
          Returns the value of the trimRectRemainAfterEdit property.
 boolean isTrimRectSizingHandles()
          Returns the value of the trimRectSizingHandles property.
static boolean isValidLUName(java.lang.String luName)
          Tests the given luName for correct syntax.
static boolean isValidSLPAS400Name(java.lang.String as400Name)
          Tests the given SLPAS400Name for correct syntax.
static boolean isValidSLPScope(java.lang.String scope)
          Tests the given SLPScope for correct syntax.
static boolean isValidWorkstationID(java.lang.String workstationID)
          Tests the given workstationID for correct syntax.
 boolean isVTAutowrap()
          Returns the value of the VTAutowrap property.
 boolean isVTBackspace()
          Returns the value of the VTBackspace property.
 boolean isVTCursor()
          Returns the value of the VTCursor property.
 boolean isVTKeypad()
          Returns the value of the VTKeypad property.
 boolean isVTLocalEcho()
          Returns the value of the VTLocalEcho.
 boolean isVTNewLine()
          Returns the current value of the VTNewLine property.
 boolean isVTPrintConvert()
          Checks is host-to-printer codepage conversion for VT BIDI session enabled
 boolean isVTReverseScreen()
          Returns the value of the VTReverseScreen property.
 boolean isWorkstationIDReady()
          Returns true if the workstation ID is ready, otherwise returns false.
static java.util.Enumeration listBIDIModes()
          Returns a list of the valid values for BIDIMode property
static java.util.Enumeration listCICSGWCodePages()
          Returns the list of valid CICSGWCodePage values.
 java.util.Enumeration listCodePages()
          Returns a list of the valid codePage values for the current session type.
static java.util.Enumeration listCodePages(java.lang.String sessionType)
          Returns a list of the valid codePage values for the given session type.
static java.util.Enumeration listCursorDirections()
          Returns a list of the valid values for cursorDirections property
static java.util.Enumeration listGraphicsCellSizes()
          Returns a list of the valid graphicsCellSize values
 java.util.Enumeration listHistorySizes()
          Returns a list of the valid History size values for the current session type.
 java.util.Enumeration listHistorySizes(java.lang.String sessionType)
           
static java.util.Enumeration listLamAlef()
          Returns the list of valid textType values.
static java.util.Enumeration listLUMLicensing()
           
static java.util.Enumeration listNumeralShapes()
          Returns the list of valid numeralShape values.
static java.util.Enumeration listNumeralShapesDisp()
          Returns a list of the valid values for NumeralShape property
static java.util.Enumeration listPasteTabOptions()
          Returns a list of the valid pasteOptionsType values.
static java.util.Enumeration listProxyAuthenMethods()
          Returns a list of the valid Socks v5 authentication methods.
static java.util.Enumeration listProxyTypes()
          Returns a list of the valid sessionType values.
static java.util.Enumeration listRoundTripModes()
          Returns a list of the valid roundTrip values.
 java.util.Enumeration listScreenSizes()
          Returns a list of the valid screenSize values for the current session type.
static java.util.Enumeration listScreenSizes(java.lang.String sessionType)
          Returns a list of the valid screenSize values for the specified session type.
static java.util.Enumeration listSessionTypes()
          Returns a list of the valid sessionType values.
static java.util.Enumeration listSmartOrdering()
          Returns a list of the valid values for smartOrdering property
static java.util.Enumeration listTextOrientations()
          Returns a list of the valid textOrientation values.
static java.util.Enumeration listTextTypes()
          Returns the list of valid textType values.
static java.util.Enumeration listTextTypesDisp()
          Returns a list of the valid values for TextTypeDisp property
static java.util.Enumeration listThaiDisplayModes()
          Returns the list of valid ThaiDisplayMode values.
 java.util.Enumeration listVTIDs()
          Returns a list of the valid VT ID values for this VT Session.
static java.util.Enumeration listVTTerminalTypes()
          Returns a list of the valid VTTerminalTypes.
 void removeCommListener(CommListener l)
          Removes a CommEvent listener
 void removeGUIListener(GUIListener l)
          Removes a GUIEvent listener
 void removeOIAListener(OIAListener l)
          Remove an OIAEvent listener
 void removePSListener(PSListener l)
          Removes a PSEvent listener
 void sendKeys(SendKeyEvent evt)
          Handles SendKeyEvents sent to this Session Bean.
 void setAutoConnect(boolean autoConnect)
          Sets the autoConnect property.
 void setAutoReconnect(boolean autoReconnect)
          Sets the autoReconnect property.
 void setBIDIMode(java.lang.String to)
          Sets BIDImode property.
 void setCICSGWCodePage(java.lang.String codePage)
          Sets the CICSGWCodepage property.
 void setCICSServerName(java.lang.String server)
          Sets the CICSServerName property.
 void setCodePage(java.lang.String codePage)
          Sets the codePage property.
 void setCopyAltSignLocation(boolean copyAltSignLocation)
          Sets the copyAltSignLocation property.
 void setCopyOnlyIfTrimmed(boolean copyOnlyIfTrimmed)
          Sets the copyOnlyIfTrimmed property.
 void setCursorDirection(java.lang.String to)
          Sets cursorDirection property.
 void setCursorMovementState(boolean movementState)
          Sets the CursorMovementState property.
 void setENPTUI(boolean enptui)
          Sets the enptui property.
 void setGraphicsCellSize(java.lang.String cellSize)
          Sets the graphicsCellSize property.
 void setHistory(boolean history)
          Sets the History property.
 void setHistorySize(java.lang.String size)
          Sets the History size property.
 void setHost(java.lang.String host)
          Sets the name of host associated with this Session Bean.
 void setHostGraphics(boolean hostGraphics)
          Sets the hostGraphics property.
 void setIgnoreWellKnownTrustedCAs(boolean ignoreWellKnownCAs)
          Sets the ignoreWellKnownTrustedCAs property.
 void setInsertOffOnAIDKEY(boolean activate)
          Sets the InsertOffOnAIDKEY property of Session.
 void setLamAlef(java.lang.String tt)
          Sets the LamAlef property.
 void setLUMLicensing(java.lang.String servertype)
          Sets the license method to either LUM or HOD.
 void setLUMPort(int PortNumber)
          Sets the LUMPort property.
 void setLUMServer(java.lang.String LUMServer)
          Sets the LUM server property.
 void setLUName(java.lang.String luName)
          Sets the LUName property.
 void setNeedToRegisterListeners(boolean fNeed)
           
 void setNumeralShape(java.lang.String ns)
          Sets the numeralShape property.
 void setNumeralShapeDisp(java.lang.String to)
          Sets numeralShapeDisp property.
 void setNumericFieldLock(boolean lock)
          Sets the Numeric Field Lock property of Session.
 void setNumericSwapEnabled(boolean value)
          Sets the Numeric swapping property.
 void setPasteFieldWrap(boolean pasteFieldWrap)
          Sets the pasteFieldWrap property.
 void setPasteLineWrap(boolean pasteLineWrap)
          Sets the pasteLineWrap property.
 void setPasteStopAtProtectedLine(boolean pasteStopAtProtectedLine)
          Sets the pasteStopAtProtectedLine property.
 void setPasteTabColumns(int pasteTabColumns)
          Sets the pasteTabColumns to set the number of columns represented by a tab.
 void setPasteTabOptions(java.lang.String pasteTabOptions)
          Sets the pasteTabOptions property.
 void setPasteTabSpaces(int pasteTabSpaces)
          Sets the pasteTabSpaces to set the number of spaces represented by a tab.
 void setPasteToTrimmedArea(boolean pasteToTrimmedArea)
          Sets the pasteToTrimmedArea property.
 void setPasteWordBreak(boolean pasteWordBreak)
          Sets the pasteWordBreak property.
 void setPort(int port)
          Sets the port that will be used to communicate with the host.
 void setPrintDestination(boolean printer)
          Sets the printDestination property.
 void setPrinterName(java.lang.String printerName)
          Sets the printerName property.
 void setPrintFileName(java.lang.String fileName)
          Sets the printFileName property.
 void setProxyAuthenMethod(java.lang.String authMethod)
          Sets the authentication method that will be used to communicate with the Socks 5 Proxy.
 void setProxyServerName(java.lang.String hostName)
          Sets the name of the proxy server name to use.
 void setProxyServerPort(int port)
          Sets the port that will be opened on the proxy server.
 void setProxyType(java.lang.String newProxyType)
          Sets the type of the proxy server that will be used.
 void setProxyUserID(java.lang.String userID)
          Sets the value of the user id used for authentication with the Socks v5 Proxy.
 void setProxyUserPassword(java.lang.String userPassword)
          Sets the value of the password used for authentication with the Socks 5 Proxy.
 void setRoundTrip(java.lang.String to)
          Sets the roundTrip property.
 void setScreenSize(java.lang.String screenSize)
          Sets the screenSize property.
 void setSecurityProtocol(java.lang.String protocol)
          Sets the SecurityProtocol property of Session.
 void setSeparateFiles(boolean separate)
          Sets the separateFiles property.
 void setServiceMgrHost(java.lang.String ServerMgrHost)
          Sets the HOD server property.
 void setSessionID(java.lang.String ID)
          Sets the sessionID property.
 void setSessionName(java.lang.String name)
          Sets the sessionName property.
 void setSessionType(java.lang.String type)
          Sets the sessionType property.
 void setShowTextAttributesEnabled(boolean value)
          Sets the Show Text Attributes property.
 void setSLPAS400Name(java.lang.String as400Name)
          Sets the SLPAS400Name property.
 void setSLPEnabled(boolean slp)
          Sets the SLPEnabled property.
 void setSLPMaxWaitTime(int maxWaitTime)
          Sets the SLPMaxWaitTime in milliseconds that will be used when waiting for service response.
 void setSLPScope(java.lang.String scope)
          Sets the SLPScope property.
 void setSLPThisScopeOnly(boolean thisScopeOnly)
          Sets the SLPThisScopeOnly property.
 void setSmartOrdering(java.lang.String to)
          Sets the smartOrdering property.
 void setSSL(boolean ssl)
          Sets the SSL property of Session.
 void setSSLBrowserKeyringAdded(boolean addKeyring)
          Sets the SSLBrowserKeyringAdded property of Session
 void setSSLCertificateHash(java.lang.String hash)
          Sets the SSLCertificateHash property of Session
 void setSSLCertificateName(java.lang.String name)
          Sets the SSLCertificateName property of Session
 void setSSLCertificatePassword(java.lang.String password)
          Sets the SSLCertificatePassword property of Session
 void setSSLCertificatePromptBeforeConnect(boolean before)
          Sets the SSLCertificatePromptBeforeConnect property of Session
 void setSSLCertificatePrompted(boolean prompted)
          Sets the SSLCertificatePrompted property of Session
 void setSSLCertificatePromptHowOften(java.lang.String howOften)
          Sets the SSLCertificatePromptHowOften property of Session
 void setSSLCertificateProvided(boolean hasCert)
          Sets the SSLCertificateProvided property of Session
 void setSSLCertificateRemembered(boolean remembered)
          Sets the SSLCertificateRemembered property of Session
 void setSSLCertificateSource(java.lang.String src)
          Sets the SSLCertificateSource property of Session
 void setSSLCertificateURL(java.lang.String url)
          Sets the SSLCertificateURL property of Session
 void setSSLServerAuthentication(boolean authentication)
          Sets the SSLServerAuthentication property of Session
 void setSSLTelnetNegotiated(boolean TNnegotiated)
          Sets the SSLTelnetNegotiated property of Session.
 void setSymmetricSwapEnabled(boolean value)
          Sets the Symmetric swapping property.
 void setTextOrientation(java.lang.String to)
          Sets the textOrientation property.
 void setTextType(java.lang.String tt)
          Sets the textType property.
 void setTextTypeDisp(java.lang.String to)
          Sets TextTypeDisp property.
 void setThaiDisplayMode(int mode)
          Set Thai display mode property.
 void setTimeout(int timeout)
          Sets the timeout that will be used to terminate inactive sessions.
 void setTNEnhanced(boolean enhanced)
          Sets the TNEnhanced property.
 void setTrimRectRemainAfterEdit(boolean trimRectRemainAfterEdit)
          Sets the trimRectRemainAfterEdit property.
 void setTrimRectSizingHandles(boolean trimRectSizingHandles)
          Sets the trimRectSizingHandles property.
 void setVTAnswerBackMsg(java.lang.String ansbackmsg)
          Sets the VTAnswerBackMsg property.
 void setVTAutowrap(boolean autowrap)
          Sets the VTAutowrap property.
 void setVTBackspace(boolean backspace)
          Sets the VTBackspace property.
 void setVTCursor(boolean application)
          Sets the VTCursor property.
 void setVTID(java.lang.String id)
          Sets the VT ID property.
 void setVTKeypad(boolean application)
          Sets the VTKeypad property.
 void setVTLocalEcho(boolean localEcho)
          Sets the VTLocalEcho property.
 void setVTNewLine(boolean CROnly)
          Sets the VTNewLine property.
 void setVTPDTName(java.lang.String pdtname)
          Sets the name of PDT file for VT BIDI session.
 void setVTPrintConvert(boolean convert)
          Enables/Disables host-to-printer codepage conversion for VT BIDI session.
 void setVTReverseScreen(boolean reverse)
          Sets the VTReverseScreen property.
 void setVTTerminalType(java.lang.String terminalType)
          Sets the VTTerminalType property.
 void setWorkstationID(java.lang.String workstationID)
          Sets the workstationID property.
 void startCommunication()
          Starts communications with the host.
 void stopCommunication()
          Stops communications with the host.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.HODBean
addPropertyChangeListener, addVetoableChangeListener, clone, getComponent, getFunction, getTraceLevel, propertyChange, readExternal, removePropertyChangeListener, removeTraceListener, removeVetoableChangeListener, setProperties, setTraceLevel, toString, writeExternal
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.beans.PropertyChangeListener
propertyChange
 

Field Detail

SESSION_TYPE

public static final java.lang.String SESSION_TYPE
sessionType property keyword

SESSION_NAME

public static final java.lang.String SESSION_NAME
sessionName property keyword

SESSION_ID

public static final java.lang.String SESSION_ID
sessionID property keyword

TN_ENHANCED

public static final java.lang.String TN_ENHANCED
TNEnhanced property keyword

LU_NAME

public static final java.lang.String LU_NAME
LUName property keyword

HOST

public static final java.lang.String HOST
host property keyword

PORT

public static final java.lang.String PORT
port property keyword

SCREEN_SIZE

public static final java.lang.String SCREEN_SIZE
screenSize property keyword

PRINT_BUFFSIZE

public static final java.lang.String PRINT_BUFFSIZE
printBufferSize property keyword

WORKSTATION_ID

public static final java.lang.String WORKSTATION_ID
workstationID property keyword

CODE_PAGE

public static final java.lang.String CODE_PAGE
codePage property keyword

HOST_GRAPHICS

public static final java.lang.String HOST_GRAPHICS
hostGraphics property keyword

GRAPHICS_CELL_SIZE

public static final java.lang.String GRAPHICS_CELL_SIZE
graphicsCellSize property keyword

ENPTUI

public static final java.lang.String ENPTUI
enptui property keyword

AUTO_CONNECT

public static final java.lang.String AUTO_CONNECT
autoConnect property keyword

AUTO_RECONNECT

public static final java.lang.String AUTO_RECONNECT
autoReconnect property keyword

SLP_ENABLED

public static final java.lang.String SLP_ENABLED
SLPEnabled property keyword

SLP_SCOPE

public static final java.lang.String SLP_SCOPE
SLPScope property keyword

SLP_AS400_NAME

public static final java.lang.String SLP_AS400_NAME
SLPAS400Name property keyword

SLP_THIS_SCOPE_ONLY

public static final java.lang.String SLP_THIS_SCOPE_ONLY
SLPThisScopeOnly property keyword

SLP_MAX_WAIT_TIME

public static final java.lang.String SLP_MAX_WAIT_TIME
SLPMaxWaitTime Property keyword

SSL

public static final java.lang.String SSL
SSL property keyword

SECURITY_PROTOCOL

public static final java.lang.String SECURITY_PROTOCOL
SecurityProtocol property keyword

SSL_TELNET_NEGOTIATED

public static final java.lang.String SSL_TELNET_NEGOTIATED
SSLTelnetNegotiated property keyword

SSL_SERVER_AUTHENTICATION

public static final java.lang.String SSL_SERVER_AUTHENTICATION
SSLServerAuthentication property keyword

SSL_BROWSER_KEYRING_ADDED

public static final java.lang.String SSL_BROWSER_KEYRING_ADDED
SSLBrowserKeyringAdded property keyword

SSL_CERTIFICATE_PROVIDED

public static final java.lang.String SSL_CERTIFICATE_PROVIDED
SSLCertificateProvided property keyword

SSL_CERTIFICATE_SOURCE

public static final java.lang.String SSL_CERTIFICATE_SOURCE
SSLCertificateSource property keyword

SSL_CERTIFICATE_URL

public static final java.lang.String SSL_CERTIFICATE_URL
SSLCertificateURL property keyword

SSL_CERTIFICATE_PASSWORD

public static final java.lang.String SSL_CERTIFICATE_PASSWORD
SSLCertificatePassword property keyword

SSL_CERTIFICATE_NAME

public static final java.lang.String SSL_CERTIFICATE_NAME
SSLCertificateName property keyword

SSL_CERTIFICATE_PROMPT_HOW_OFTEN

public static final java.lang.String SSL_CERTIFICATE_PROMPT_HOW_OFTEN
SSLCertificatePromptHowOften property keyword

SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT

public static final java.lang.String SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
SSLCertificatePromptBeforeConnect property keyword

SSL_CERTIFICATE_HASH

public static final java.lang.String SSL_CERTIFICATE_HASH
SSLCertificateHash property keyword

SSL_CERTIFICATE_PROMPTED

public static final java.lang.String SSL_CERTIFICATE_PROMPTED
SSLCertificatePrompted property keyword

SSL_CERTIFICATE_REMEMBERED

public static final java.lang.String SSL_CERTIFICATE_REMEMBERED
SSLCertificateRemembered property keyword

CICS_SERVER_NAME

public static final java.lang.String CICS_SERVER_NAME
CICSServerName property keyword

CICS_GW_CODE_PAGE

public static final java.lang.String CICS_GW_CODE_PAGE
CICSGWCodePage property keyword

VT_TERMINAL_TYPE

public static final java.lang.String VT_TERMINAL_TYPE
VTTerminalType property keyword

VT_NEW_LINE

public static final java.lang.String VT_NEW_LINE
VTNewLine property keyword

VT_BACKSPACE

public static final java.lang.String VT_BACKSPACE
VTBackspace property keyword

VT_LOCAL_ECHO

public static final java.lang.String VT_LOCAL_ECHO
VTLocalEcho property keyword

SSL_IGNORE_WELLKNOWNTRUSTEDCA_CLASS

public static final java.lang.String SSL_IGNORE_WELLKNOWNTRUSTEDCA_CLASS
ignoreWellKnownTrustedCAs property keyword

VT_CURSOR

public static final java.lang.String VT_CURSOR
VTCursor property keyword

VT_ID

public static final java.lang.String VT_ID
//@d79a VT ID property keyword //@d79a

VT_KEYPAD

public static final java.lang.String VT_KEYPAD
VTKeypad property keyword

VT_AUTOWRAP

public static final java.lang.String VT_AUTOWRAP
VTAutowrap property keyword

VT_REVERSE_SCREEN

public static final java.lang.String VT_REVERSE_SCREEN
VTReverseScreen property keyword

CURSOR_MOVEMENT_STATE

public static final java.lang.String CURSOR_MOVEMENT_STATE
CursorMovementState property keyword

VT_ANS_BACK_MSG

public static final java.lang.String VT_ANS_BACK_MSG
VTAnswerBackMsg property keyword

PRINT_DESTINATION

public static final java.lang.String PRINT_DESTINATION
printDestination property keyword

PRINT_FILE_NAME

public static final java.lang.String PRINT_FILE_NAME
printFileName property keyword

PRINT_SEPARATE_FILES

public static final java.lang.String PRINT_SEPARATE_FILES
separateFiles property keyword

PRINTER_NAME

public static final java.lang.String PRINTER_NAME
printerName property keyword

HISTORY

public static final java.lang.String HISTORY
History property keyword

HISTORY_SIZE

public static final java.lang.String HISTORY_SIZE
History size property keyword

NUM_FIELD_LOCK

public static final java.lang.String NUM_FIELD_LOCK
numericFieldLock property keyword

INSERT_OFF_ON_AIDKEY

public static final java.lang.String INSERT_OFF_ON_AIDKEY
InsertOffOnAIDKEY property keyword

NUMERAL_SHAPE

public static final java.lang.String NUMERAL_SHAPE
numeralShape property keyword

TEXT_TYPE

public static final java.lang.String TEXT_TYPE
textType property keyword

TEXT_ORIENTATION

public static final java.lang.String TEXT_ORIENTATION
textOrientation property keyword

ROUNDTRIP

public static final java.lang.String ROUNDTRIP
roundTrip property keyword

LAMALEF

public static final java.lang.String LAMALEF
lamalef property keyword

LAMALEF_ON

public static final java.lang.String LAMALEF_ON
lamalef property values (5250 session only)

LAMALEF_OFF

public static final java.lang.String LAMALEF_OFF

NOMINAL

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

NATIONAL

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

CONTEXTUAL

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

VISUAL

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

LOGICAL

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

LEFT_TO_RIGHT

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

RIGHT_TO_LEFT

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

ROUNDTRIP_ON

public static final java.lang.String ROUNDTRIP_ON
roundTrip property value - roindtrip on (bi-directional sessions only)

ROUNDTRIP_OFF

public static final java.lang.String ROUNDTRIP_OFF
roundTrip property value - roindtrip off (bi-directional sessions only)

SYM_SWAP_ENABLED

public static final java.lang.String SYM_SWAP_ENABLED
symmetric swapping value - (Arabic 3270 sessions only)

NUM_SWAP_ENABLED

public static final java.lang.String NUM_SWAP_ENABLED
Numeric swapping value - (Arabic 3270 sessions only)

NUMERAL_SHAPE_DISP

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

NOMINAL_DISP

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

NATIONAL_DISP

public static final java.lang.String NATIONAL_DISP

CONTEXTUAL_DISP

public static final java.lang.String CONTEXTUAL_DISP

TEXT_TYPE_DISP

public static final java.lang.String TEXT_TYPE_DISP
textTypeDisp property keyword (VT bi-directional sessions only)

VISUAL_DISP

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

LOGICAL_DISP

public static final java.lang.String LOGICAL_DISP

BIDI_MODE

public static final java.lang.String BIDI_MODE
BIDIMode property keyword (VT bi-directional sessions only)

BIDI_MODE_ON

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

BIDI_MODE_OFF

public static final java.lang.String BIDI_MODE_OFF

CURSOR_DIRECTION

public static final java.lang.String CURSOR_DIRECTION
cursorDirection property keyword (VT bi-directional sessions only)

CURSOR_LTR

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

CURSOR_RTL

public static final java.lang.String CURSOR_RTL

VT_PRINT_ASCII_CONVERT

public static final java.lang.String VT_PRINT_ASCII_CONVERT

SMART_ORDERING

public static final java.lang.String SMART_ORDERING
smartOrdering property keyword (VT logical bi-directional sessions only)

SMART_ORDERING_ON

public static final java.lang.String SMART_ORDERING_ON
smartOrdering property values (VT logical bi-directional sessions only)

SMART_ORDERING_OFF

public static final java.lang.String SMART_ORDERING_OFF

SHOW_TEXT_ATTRIBUTES_ENABLED

public static final java.lang.String SHOW_TEXT_ATTRIBUTES_ENABLED
ShowTextAttributes property value (VT logical bi-directional sessions only)

THAI_DISPLAY_MODE

public static final java.lang.String THAI_DISPLAY_MODE
ThaiDisplayMode property keyword

THAI_MODE_1

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

THAI_MODE_2

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

THAI_MODE_3

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

THAI_MODE_4

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

THAI_MODE_5

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

CONNECTION_INIT

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

CONNECTION_PND_INACTIVE

public static final int CONNECTION_PND_INACTIVE
commStatus property value - pending inactive

CONNECTION_INACTIVE

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

CONNECTION_PND_ACTIVE

public static final int CONNECTION_PND_ACTIVE
commStatus property value - pending active

CONNECTION_ACTIVE

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

CONNECTION_READY

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

CONNECTION_DEVICE_NAME_READY

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

CONNECTION_WORKSTATION_ID_READY

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

SERVICE_MGR_HOST

public static final java.lang.String SERVICE_MGR_HOST
Service manager host property keyword

LUM_PORT

public static final java.lang.String LUM_PORT
Lum port property keyword

LUM_LICENSING

public static final java.lang.String LUM_LICENSING
Lum licensing property keyword

LUM_SERVER

public static final java.lang.String LUM_SERVER
LUM server property keyword

PASTE_FIELD_WRAP

public static final java.lang.String PASTE_FIELD_WRAP
Paste Field Wrap property keyword

PASTE_LINE_WRAP

public static final java.lang.String PASTE_LINE_WRAP
Paste word line wrap property keyword

PASTE_WORD_BREAK

public static final java.lang.String PASTE_WORD_BREAK
Paste Don't Split Words property keyword

PASTE_TO_TRIMMED_AREA

public static final java.lang.String PASTE_TO_TRIMMED_AREA
Paste To Trimmed area property keyword

PASTE_STOP_PRO_LINE

public static final java.lang.String PASTE_STOP_PRO_LINE
Paste Stop At Protected Line property keyword

PASTE_TAB_OPTIONS

public static final java.lang.String PASTE_TAB_OPTIONS
Paste Tab Options property keyword

PASTE_TAB_COLUMNS

public static final java.lang.String PASTE_TAB_COLUMNS
Paste Tab Columns property keyword

PASTE_TAB_SPACES

public static final java.lang.String PASTE_TAB_SPACES
Paste Tab Spaces property keyword

COPY_ONLY_IF_TRIMMED

public static final java.lang.String COPY_ONLY_IF_TRIMMED
Copy Only If Trimmed property keyword

COPY_ALT_SIGN_LOCATION

public static final java.lang.String COPY_ALT_SIGN_LOCATION
Copy, force leading sign char '+' '-' property keyword

TRIM_RECT_SIZING_HANDLES

public static final java.lang.String TRIM_RECT_SIZING_HANDLES
Trim Rectangle Sizing handles

PROXY_TYPE

public static final java.lang.String PROXY_TYPE

PROXY_BROWSER_DEFAULT

public static final java.lang.String PROXY_BROWSER_DEFAULT

PROXY_SOCKS_V5_THEN_V4

public static final java.lang.String PROXY_SOCKS_V5_THEN_V4

PROXY_SOCKS_V4

public static final java.lang.String PROXY_SOCKS_V4

PROXY_SOCKS_V5

public static final java.lang.String PROXY_SOCKS_V5

PROXY_HTTP

public static final java.lang.String PROXY_HTTP

PROXY_SRV_HOST_NAME

public static final java.lang.String PROXY_SRV_HOST_NAME

PROXY_SRV_HOST_PORT

public static final java.lang.String PROXY_SRV_HOST_PORT

PROXY_SOCKS_USERSID

public static final java.lang.String PROXY_SOCKS_USERSID

PROXY_SOCKS_PASSWORD

public static final java.lang.String PROXY_SOCKS_PASSWORD

PROXY_AUTHEN_METHOD

public static final java.lang.String PROXY_AUTHEN_METHOD

PROXY_AUTHEN_NONE

public static final java.lang.String PROXY_AUTHEN_NONE

PROXY_AUTHEN_CLEAR_TEXT

public static final java.lang.String PROXY_AUTHEN_CLEAR_TEXT

TRIM_RECT_REMAIN_AFTER

public static final java.lang.String TRIM_RECT_REMAIN_AFTER
Trim Rectangle Remain After Edit

UDC_SETTING

public static final java.lang.String UDC_SETTING

UDC_ON

public static final java.lang.String UDC_ON

UDC_OFF

public static final java.lang.String UDC_OFF

UDC_TABLE_SELECTION

public static final java.lang.String UDC_TABLE_SELECTION
Constructor Detail

Session

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

Session

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

Caution: for this constructor, the Properties object must contain at least this valid key-value pair: ECLSession.SESSION_HOST, "<host address>".

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

getSession

public Session getSession()
Needed for SessionInterface
Specified by:
getSession in interface com.ibm.eNetwork.beans.HOD.SessionInterface

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

startCommunication

public void startCommunication()
Starts communications with the host.
Specified by:
startCommunication in interface com.ibm.eNetwork.beans.HOD.SessionInterface

stopCommunication

public void stopCommunication()
Stops communications with the host.
Specified by:
stopCommunication in interface com.ibm.eNetwork.beans.HOD.SessionInterface

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.
Specified by:
isCommStarted in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
isCommReady(), getCommStatus()

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

Specified by:
getCommStatus in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
isCommReady(), isCommStarted()

isCommReady

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

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.

Specified by:
isDeviceNameReady in interface com.ibm.eNetwork.beans.HOD.SessionInterface

getDeviceName

public java.lang.String getDeviceName()
If isDeviceNameReady() is true, returns the device name in use, otherwise returns null. This method is only valid for 3270 session.
Specified by:
getDeviceName in interface com.ibm.eNetwork.beans.HOD.SessionInterface

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.

Specified by:
isWorkstationIDReady in interface com.ibm.eNetwork.beans.HOD.SessionInterface

sendKeys

public void sendKeys(SendKeyEvent evt)
Handles SendKeyEvents sent to this Session Bean. This method is necessary to implement the SendKeyListener interface.
Specified by:
sendKeys in interface SendKeyListener
See Also:
SendKeyListener, SendKeyEvent

addCommListener

public void addCommListener(CommListener l)
Adds a CommEvent listener
Specified by:
addCommListener in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
l - an object that implements the CommListener interface
See Also:
CommListener, CommEvent

removeCommListener

public void removeCommListener(CommListener l)
Removes a CommEvent listener
Specified by:
removeCommListener in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
l - a previously registered CommListener object
See Also:
CommListener, CommEvent

addOIAListener

public void addOIAListener(OIAListener l)
Adds an OIAEvent listener
Specified by:
addOIAListener in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
l - an object that implements the OIAListener interface
See Also:
OIAListener, OIAEvent

removeOIAListener

public void removeOIAListener(OIAListener l)
Remove an OIAEvent listener
Specified by:
removeOIAListener in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
l - a previously registered OIAListener object
See Also:
OIAListener, OIAEvent

addPSListener

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

removePSListener

public void removePSListener(PSListener l)
Removes a PSEvent listener
Parameters:
l - a previously registered PSListener object
See Also:
PSListener, PSEvent

addGUIListener

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

removeGUIListener

public void removeGUIListener(GUIListener l)
Removes a GUIEvent listener
Parameters:
l - a previously registered GUIListener object
See Also:
GUIListener, GUIEvent

addTraceListener

public void addTraceListener(TraceListener l)
Adds a TraceEvent listener
Overrides:
addTraceListener in class HODBean
Parameters:
l - an object that implements the TraceListener interface
See Also:
TraceListener, TraceEvent

setNeedToRegisterListeners

public void setNeedToRegisterListeners(boolean fNeed)

getProperties

public java.util.Properties getProperties()
Returns the current properties for Session.
Overrides:
getProperties in class HODBean
Following copied from class: com.ibm.eNetwork.beans.HOD.HODBean
See Also:
HODBean.setProperties(java.util.Properties)

setSessionType

public void setSessionType(java.lang.String type)
                    throws java.beans.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.

Specified by:
setSessionType in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
type - the new sessionType
Throws:
java.beans.PropertyVetoException - Thrown if an invalid property value is given.
See Also:
getSessionType(), listSessionTypes()

getSessionType

public java.lang.String getSessionType()
Returns the current setting of the sessionType property.
Specified by:
getSessionType in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setSessionType(java.lang.String), listSessionTypes()

listSessionTypes

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

setSessionName

public void setSessionName(java.lang.String name)
                    throws java.beans.PropertyVetoException
Sets the sessionName property.
Specified by:
setSessionName in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
name - The new session name.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSessionName()

getSessionName

public java.lang.String getSessionName()
Returns the value of the sessionName property.
Specified by:
getSessionName in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setSessionName(java.lang.String)

setSessionID

public void setSessionID(java.lang.String ID)
                  throws java.beans.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.

Specified by:
setSessionID in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
ID - The new ID.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSessionID()

getSessionID

public java.lang.String getSessionID()
Returns the value of the sessionID property.
Specified by:
getSessionID in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setSessionID(java.lang.String)

setHost

public void setHost(java.lang.String host)
             throws java.beans.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.

Specified by:
setHost in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
host - The name of the host.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getHost()

getHost

public java.lang.String getHost()
Returns the current value of the host property.
Specified by:
getHost in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setHost(java.lang.String)

setPort

public void setPort(int port)
             throws java.beans.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.

Specified by:
setPort in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
port - The port number.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPort()

getPort

public int getPort()
Returns the current value of the port property.
Specified by:
getPort in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setPort(int)

setTimeout

public void setTimeout(int timeout)
                throws java.beans.PropertyVetoException
Sets the timeout that will be used to terminate inactive sessions. A timeout value of less than or equal to 0 indicates no timeout. This is only valid for 3270, 5250 and VT sessions. The timeout is not used at connection creation time.
Parameters:
timeout - The timeout value in millisecs
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getTimeout()

getTimeout

public int getTimeout()
Returns the current value of the timeout property in millisecs
See Also:
setTimeout(int)

setProxyType

public void setProxyType(java.lang.String newProxyType)
                  throws java.beans.PropertyVetoException
Sets the type of the proxy server that will be used. The possible values are:
Constant Description
ECLSession.SESSION_PROXY_NONE Connect using no proxy.
ECLSession.SESSION_PROXY_BROWSER_DEFAULT Connect using the proxy defined in the browser proxy setup
ECLSession.SESSION_PROXY_SOCKS_V5 Connect using a Socks v5 proxy
ECLSession.SESSION_PROXY_SOCKS_V4 Connect using a Socks v4 proxy
ECLSession.SESSION_PROXY_SOCKS_V5_THEN_V4 Connect using a Socks v5 proxy. It the Socks proxy is a Socks v4 proxy instead, connect anyway
ECLSession.SESSION_PROXY_HTTP Connect using a HTTP proxy
Parameters:
newProxyType - The type of proxy to connect through
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyType(), listProxyTypes()

getProxyType

public java.lang.String getProxyType()
Returns the current value of the proxy server property.
See Also:
setProxyType(java.lang.String), listProxyTypes()

listProxyTypes

public static java.util.Enumeration listProxyTypes()
Returns a list of the valid sessionType values.
See Also:
setProxyType(java.lang.String), listProxyTypes()

setProxyServerName

public void setProxyServerName(java.lang.String hostName)
                        throws java.beans.PropertyVetoException
Sets the name of the proxy server name to use.
Parameters:
hostName - The host name of the proxy server as either a fully qualified name or an IP address
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyServerName()

getProxyServerName

public java.lang.String getProxyServerName()
Returns the currently defined proxy server.
See Also:
setProxyServerName(java.lang.String)

setProxyServerPort

public void setProxyServerPort(int port)
                        throws java.beans.PropertyVetoException
Sets the port that will be opened on the proxy server.
Parameters:
port - The port number to connect to on the proxy server
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyServerPort()

getProxyServerPort

public int getProxyServerPort()
Returns the current value of the port to connect to on proxy server.
See Also:
setProxyServerPort(int)

setProxyUserID

public void setProxyUserID(java.lang.String userID)
                    throws java.beans.PropertyVetoException
Sets the value of the user id used for authentication with the Socks v5 Proxy.
Parameters:
userID - The user id defined on the Socks v5 proxy
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyUserID()

getProxyUserID

public java.lang.String getProxyUserID()
Returns the current value of the user id used for authentication with the Socks v5 Proxy.
See Also:
setProxyUserID(java.lang.String)

setProxyUserPassword

public void setProxyUserPassword(java.lang.String userPassword)
                          throws java.beans.PropertyVetoException
Sets the value of the password used for authentication with the Socks 5 Proxy.
Parameters:
userPassword - The password associated with the user id defined on the Socks v5 proxy
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyUserPassword(), setProxyUserID(java.lang.String), getProxyUserID()

getProxyUserPassword

public java.lang.String getProxyUserPassword()
Returns the current value of the password used for authentication with the Socks 5 Proxy.
See Also:
setProxyUserPassword(java.lang.String)

setProxyAuthenMethod

public void setProxyAuthenMethod(java.lang.String authMethod)
                          throws java.beans.PropertyVetoException
Sets the authentication method that will be used to communicate with the Socks 5 Proxy. The possible values are:
Constant Description
ECLSession.SESSION_PROXY_AUTHEN_NONE Connect using no proxy.
ECLSession.SESSION_PROXY_AUTHEN_CLEAR_TEXT Connect using the proxy defined in the browser proxy setup
Parameters:
authMethod - The authenitcation method to use when connecting to the Socks v5 proxy
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProxyAuthenMethod(), listProxyAuthenMethods()

getProxyAuthenMethod

public java.lang.String getProxyAuthenMethod()
Returns the current value of the Socks v5 authentication method.
See Also:
setProxyAuthenMethod(java.lang.String), listProxyAuthenMethods()

listProxyAuthenMethods

public static java.util.Enumeration listProxyAuthenMethods()
Returns a list of the valid Socks v5 authentication methods.
See Also:
setProxyAuthenMethod(java.lang.String), getProxyAuthenMethod()

setTNEnhanced

public void setTNEnhanced(boolean enhanced)
                   throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isTNEnhanced()

isTNEnhanced

public boolean isTNEnhanced()
Returns the current value of the TNEnhanced property. This method is only valid for 3270 session.
See Also:
setTNEnhanced(boolean)

setSLPEnabled

public void setSLPEnabled(boolean slp)
                   throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSLPEnabled()

isSLPEnabled

public boolean isSLPEnabled()
Returns the current value of the SLPEnabled property.
See Also:
setSLPEnabled(boolean)

setSLPScope

public void setSLPScope(java.lang.String scope)
                 throws java.beans.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.

Note: It is recommended that the isValidSLPScope(String scope) function be called first to check the validity of the String.

Parameters:
scope - The scope which will be used during SLP search for telnet services.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPScope(), setSLPThisScopeOnly(boolean), setSLPEnabled(boolean), isValidSLPScope(java.lang.String)

isValidSLPScope

public static boolean isValidSLPScope(java.lang.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(java.lang.String)

getSLPScope

public java.lang.String getSLPScope()
Returns the current value of the SLPScope property.
See Also:
setSLPScope(java.lang.String), setSLPThisScopeOnly(boolean), setSLPEnabled(boolean)

setSLPThisScopeOnly

public void setSLPThisScopeOnly(boolean thisScopeOnly)
                         throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSLPThisScopeOnly(), setSLPScope(java.lang.String), setSLPEnabled(boolean)

isSLPThisScopeOnly

public boolean isSLPThisScopeOnly()
Returns the current value of the SLPThisScopeOnly property.
See Also:
setSLPThisScopeOnly(boolean), setSLPScope(java.lang.String), setSLPEnabled(boolean)

setSLPMaxWaitTime

public void setSLPMaxWaitTime(int maxWaitTime)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPMaxWaitTime(), setSLPEnabled(boolean)

getSLPMaxWaitTime

public int getSLPMaxWaitTime()
Returns the current value of the SLPMaxWaitTime property.
See Also:
setSLPMaxWaitTime(int), setSLPEnabled(boolean)

setSLPAS400Name

public void setSLPAS400Name(java.lang.String as400Name)
                     throws java.beans.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.

Note: It is recommended that the isValidSLPAS400Name(String as400Name) function be called first to check the validity of the String.

Parameters:
as400name - The as400Name will be used during SLP negotiation. The session will connect to the indicated AS/400.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSLPAS400Name(), setSLPEnabled(boolean), isValidSLPAS400Name(java.lang.String)

isValidSLPAS400Name

public static boolean isValidSLPAS400Name(java.lang.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(java.lang.String)

getSLPAS400Name

public java.lang.String getSLPAS400Name()
Returns the current value of the SLPAS400Name property.
See Also:
setSLPAS400Name(java.lang.String), setSLPEnabled(boolean)

setLUName

public void setLUName(java.lang.String luName)
               throws java.beans.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.

Note: It is recommended that the isValidLUName(String luName) function be called first to check the validity of the String.

Parameters:
luName - The LU name which will be used during enhanced negotiation. Maximum length of LU name is 17 characters.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getLUName(), setTNEnhanced(boolean), isValidLUName(java.lang.String)

isValidLUName

public static boolean isValidLUName(java.lang.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(java.lang.String)

getLUName

public java.lang.String getLUName()
Returns the current value of the LUName property. This method is only valid for 3270 session.
See Also:
setLUName(java.lang.String), setTNEnhanced(boolean)

setScreenSize

public void setScreenSize(java.lang.String screenSize)
                   throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getScreenSize(), listScreenSizes(), listScreenSizes(java.lang.String)

getScreenSize

public java.lang.String getScreenSize()
Returns the current value of the screenSize property.
See Also:
setScreenSize(java.lang.String), listScreenSizes(), listScreenSizes(java.lang.String)

listScreenSizes

public java.util.Enumeration listScreenSizes()
Returns a list of the valid screenSize values for the current session type.
See Also:
setScreenSize(java.lang.String), getScreenSize()

listScreenSizes

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

setCodePage

public void setCodePage(java.lang.String codePage)
                 throws java.beans.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.

Specified by:
setCodePage in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
codePage - The new codepage.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getCodePage(), listCodePages(), listCodePages(java.lang.String)

getCodePage

public java.lang.String getCodePage()
Returns the current value of the codePage property.
Specified by:
getCodePage in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setCodePage(java.lang.String), listCodePages(), listCodePages(java.lang.String)

listCodePages

public java.util.Enumeration listCodePages()
Returns a list of the valid codePage values for the current session type.
See Also:
setCodePage(java.lang.String), getCodePage()

listCodePages

public static java.util.Enumeration listCodePages(java.lang.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(java.lang.String), getCodePage()

setHostGraphics

public void setHostGraphics(boolean hostGraphics)
                     throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHostGraphics()

isHostGraphics

public boolean isHostGraphics()
Returns the value of the hostGraphics property.
See Also:
setHostGraphics(boolean)

setGraphicsCellSize

public void setGraphicsCellSize(java.lang.String cellSize)
                         throws java.beans.PropertyVetoException
Sets the graphicsCellSize property.

The possible values are
Constant Description
ECLSession.SESSION_PS_CELL_AUTO_STR Auto-detect cell size
ECLSession.SESSION_PS_CELL_9X12_STR 9 pixels by 12 pixels
ECLSession.SESSION_PS_CELL_9X16_STR 9 pixels by 16 pixels
ECLSession.SESSION_PS_CELL_9X21_STR 9 pixels by 21 pixels
ECLSession.SESSION_PS_CELL_13X22_STR 13 pixels by 22 pixels
ECLSession.SESSION_PS_CELL_13X29_STR 13 pixels by 29 pixels

Parameters:
cellSize - The new cell size
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getGraphicsCellSize(), listGraphicsCellSizes()

getGraphicsCellSize

public java.lang.String getGraphicsCellSize()
Returns the current value of the graphicsCellSize property.
See Also:
setGraphicsCellSize(java.lang.String), listGraphicsCellSizes()

listGraphicsCellSizes

public static java.util.Enumeration listGraphicsCellSizes()
Returns a list of the valid graphicsCellSize values
See Also:
setGraphicsCellSize(java.lang.String), getGraphicsCellSize()

setENPTUI

public void setENPTUI(boolean enptui)
               throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isENPTUI()

isENPTUI

public boolean isENPTUI()
Returns the value of the enptui property.
See Also:
setENPTUI(boolean)

setAutoConnect

public void setAutoConnect(boolean autoConnect)
                    throws java.beans.PropertyVetoException
Sets the autoConnect property. This indicates whether to automatically connect to the host when the host property is set.
Specified by:
setAutoConnect in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
autoConnect - The new value for the autoConnect property
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isAutoConnect()

isAutoConnect

public boolean isAutoConnect()
Returns the value of the autoConnect property.
Specified by:
isAutoConnect in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setAutoConnect(boolean)

setAutoReconnect

public void setAutoReconnect(boolean autoReconnect)
                      throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isAutoReconnect()

isAutoReconnect

public boolean isAutoReconnect()
Returns the current value of the autoReconnect property.
See Also:
setAutoReconnect(boolean)

setSSL

public void setSSL(boolean ssl)
            throws java.beans.PropertyVetoException
Sets the SSL property of Session. This indicates whether to use the Secure Socket Layer (SSL) feature.

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSL()

isSSL

public boolean isSSL()
Returns the value of the SSL property.
See Also:
setSSL(boolean)

setSecurityProtocol

public void setSecurityProtocol(java.lang.String protocol)
                         throws java.beans.PropertyVetoException
Sets the SecurityProtocol property of Session. This indicates whether to use the TLS v1.0 protocol or the SSL protocol for providing security. @d70a

See HACL: ECLSession for more about the underlying SecurityProtocol features and parameters.

Parameters:
protocol - If set to TLS(default), and if the server is TLS-enabled, then a TLS v1.0 connection is provided If server is not TLS-enabled, then the server negotiates the connection down to SSL protocol.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSecurityProtocol()

getSecurityProtocol

public java.lang.String getSecurityProtocol()
Returns the value of the SecurityProtocol property. @d70a
See Also:
setSecurityProtocol(java.lang.String)

setSSLTelnetNegotiated

public void setSSLTelnetNegotiated(boolean TNnegotiated)
                            throws java.beans.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.

See HACL: ECLSession for more about the underlying SSL features and parameters.

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

Parameters:
TNnegotiated - Determines if SSL will be negotiated on the Telnet connection.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLTelnetNegotiated(), setSSL(boolean)

isSSLTelnetNegotiated

public boolean isSSLTelnetNegotiated()
Returns the current value of the SSLTelnetNegotiated property.
See Also:
setSSLTelnetNegotiated(boolean), setSSL(boolean)

setSSLServerAuthentication

public void setSSLServerAuthentication(boolean authentication)
                                throws java.beans.PropertyVetoException
Sets the SSLServerAuthentication property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLServerAuthentication(), setSSL(boolean)

isSSLServerAuthentication

public boolean isSSLServerAuthentication()
Returns the current value of the SSLServerAuthentication property.
See Also:
setSSLServerAuthentication(boolean), setSSL(boolean)

setSSLBrowserKeyringAdded

public void setSSLBrowserKeyringAdded(boolean addKeyring)
                               throws java.beans.PropertyVetoException
Sets the SSLBrowserKeyringAdded property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLBrowserKeyringAdded(), setSSL(boolean)

isSSLBrowserKeyringAdded

public boolean isSSLBrowserKeyringAdded()
Returns the current value of the SSLBrowserKeyringAdded property.
See Also:
setSSLBrowserKeyringAdded(boolean), setSSL(boolean)

setSSLCertificateProvided

public void setSSLCertificateProvided(boolean hasCert)
                               throws java.beans.PropertyVetoException
Sets the SSLCertificateProvided property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificateProvided(), setSSL(boolean)

isSSLCertificateProvided

public boolean isSSLCertificateProvided()
Returns the current value of the SSLCertificateProvided property.
See Also:
setSSLCertificateProvided(boolean), setSSL(boolean)

setSSLCertificateSource

public void setSSLCertificateSource(java.lang.String src)
                             throws java.beans.PropertyVetoException
Sets the SSLCertificateSource property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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
  • ECLSession.SESSION_SSL_CERTIFICATE_IN_CSP
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateSource(), setSSL(boolean)

getSSLCertificateSource

public java.lang.String getSSLCertificateSource()
Returns the current value of the SSLCertificateSource property.
See Also:
setSSLCertificateSource(java.lang.String), setSSL(boolean)

setSSLCertificateURL

public void setSSLCertificateURL(java.lang.String url)
                          throws java.beans.PropertyVetoException
Sets the SSLCertificateURL property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateURL(), setSSL(boolean)

getSSLCertificateURL

public java.lang.String getSSLCertificateURL()
Returns the current value of the SSLCertificateURL property.
See Also:
setSSLCertificateURL(java.lang.String), setSSL(boolean)

setSSLCertificatePassword

public void setSSLCertificatePassword(java.lang.String password)
                               throws java.beans.PropertyVetoException
Sets the SSLCertificatePassword property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
setSSL(boolean)

setSSLCertificateName

public void setSSLCertificateName(java.lang.String name)
                           throws java.beans.PropertyVetoException
Sets the SSLCertificateName property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateName(), setSSL(boolean)

getSSLCertificateName

public java.lang.String getSSLCertificateName()
Returns the current value of the SSLCertificateName property.
See Also:
setSSLCertificateName(java.lang.String), setSSL(boolean)

setSSLCertificatePromptHowOften

public void setSSLCertificatePromptHowOften(java.lang.String howOften)
                                     throws java.beans.PropertyVetoException
Sets the SSLCertificatePromptHowOften property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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_CONNECT
  • ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECT
  • ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificatePromptHowOften(), setSSL(boolean)

getSSLCertificatePromptHowOften

public java.lang.String getSSLCertificatePromptHowOften()
Returns the current value of the SSLCertificatePromptHowOften property.
See Also:
setSSLCertificatePromptHowOften(java.lang.String), setSSL(boolean)

setSSLCertificatePromptBeforeConnect

public void setSSLCertificatePromptBeforeConnect(boolean before)
                                          throws java.beans.PropertyVetoException
Sets the SSLCertificatePromptBeforeConnect property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificatePromptBeforeConnect(), setSSL(boolean)

isSSLCertificatePromptBeforeConnect

public boolean isSSLCertificatePromptBeforeConnect()
Returns the current value of the SSLCertificatePromptBeforeConnect property.
See Also:
setSSLCertificatePromptBeforeConnect(boolean), setSSL(boolean)

setSSLCertificateHash

public void setSSLCertificateHash(java.lang.String hash)
                           throws java.beans.PropertyVetoException
Sets the SSLCertificateHash property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getSSLCertificateHash(), setSSL(boolean)

getSSLCertificateHash

public java.lang.String getSSLCertificateHash()
Returns the current value of the SSLCertificateHash property.
See Also:
setSSLCertificateHash(java.lang.String), setSSL(boolean)

setSSLCertificatePrompted

public void setSSLCertificatePrompted(boolean prompted)
                               throws java.beans.PropertyVetoException
Sets the SSLCertificatePrompted property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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.

Specified by:
setSSLCertificatePrompted in interface com.ibm.eNetwork.beans.HOD.SessionInterface
Parameters:
prompted - Whether or not the user has been prompted for this connection
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificatePrompted(), setSSL(boolean)

isSSLCertificatePrompted

public boolean isSSLCertificatePrompted()
Returns the current value of the SSLCertificatePrompted property.
Specified by:
isSSLCertificatePrompted in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setSSLCertificatePrompted(boolean), setSSL(boolean)

setSSLCertificateRemembered

public void setSSLCertificateRemembered(boolean remembered)
                                 throws java.beans.PropertyVetoException
Sets the SSLCertificateRemembered property of Session

See HACL: ECLSession for more about the underlying SSL features and parameters.

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 SSLCertificatePromptHowOften to EACH_CONNECT
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSSLCertificateRemembered(), setSSL(boolean)

isSSLCertificateRemembered

public boolean isSSLCertificateRemembered()
Returns the current value of the SSLCertificateRemembered property.
See Also:
setSSLCertificateRemembered(boolean), setSSL(boolean)

setCICSServerName

public void setCICSServerName(java.lang.String server)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getCICSServerName()

getCICSServerName

public java.lang.String getCICSServerName()
Returns the current value of the CICSServerName property.
See Also:
setCICSServerName(java.lang.String)

setCICSGWCodePage

public void setCICSGWCodePage(java.lang.String codePage)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getCICSGWCodePage(), listCICSGWCodePages()

getCICSGWCodePage

public java.lang.String getCICSGWCodePage()
Returns the current value of the CICSGWCodepage property.
See Also:
setCICSGWCodePage(java.lang.String), listCICSGWCodePages()

listCICSGWCodePages

public static java.util.Enumeration listCICSGWCodePages()
Returns the list of valid CICSGWCodePage values.
See Also:
setCICSGWCodePage(java.lang.String), getCICSGWCodePage()

setNumericFieldLock

public void setNumericFieldLock(boolean lock)
                         throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isNumericFieldLock()

isNumericFieldLock

public boolean isNumericFieldLock()
Returns the value of the Numeric Field Lock property.
See Also:
setNumericFieldLock(boolean)

setInsertOffOnAIDKEY

public void setInsertOffOnAIDKEY(boolean activate)
                          throws java.beans.PropertyVetoException
Sets the InsertOffOnAIDKEY property of Session.
If Insert Mode is ON and isInsertOffOnAIDKEY is TRUE, Entering any AIDKEY will turn Insert Mode OFF.
If Insert Mode is ON and isInsertOffOnAIDKEY is FALSE, Entering any AIDKEY will have no effect on the Insert Mode.
If Insert Mode is Off, Entering any AIDKEY will not turn ON Insert Mode, no matter what state isInsertOffOnAIDKEY is in.
This property is valid for 3270 and CICS sessions only.

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

Parameters:
activate - Whether or not Insert Off on AIDKEY will be enabled.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isInsertOffOnAIDKEY()

isInsertOffOnAIDKEY

public boolean isInsertOffOnAIDKEY()
Returns the value of the Insert OFF on AID KEY property.

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

See Also:
setInsertOffOnAIDKEY(boolean)

setVTTerminalType

public void setVTTerminalType(java.lang.String terminalType)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getVTTerminalType(), listVTTerminalTypes()

getVTTerminalType

public java.lang.String getVTTerminalType()
Returns the current value of the VTTerminalType property.
See Also:
setVTTerminalType(java.lang.String), listVTTerminalTypes()

listVTTerminalTypes

public static java.util.Enumeration listVTTerminalTypes()
Returns a list of the valid VTTerminalTypes.
See Also:
setVTTerminalType(java.lang.String), getVTTerminalType()

setVTAnswerBackMsg

public void setVTAnswerBackMsg(java.lang.String ansbackmsg)
                        throws java.beans.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 string can be empty ("") or a user defined value.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getVTAnswerBackMsg()

getVTAnswerBackMsg

public java.lang.String getVTAnswerBackMsg()
Returns the current value of the VTAnswerBackMsg property. This property only applies to VT sessions.
See Also:
setVTAnswerBackMsg(java.lang.String)

setCursorMovementState

public void setCursorMovementState(boolean movementState)
                            throws java.beans.PropertyVetoException
Sets the CursorMovementState property. This property currently only applies to VT sessions.

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

Parameters:
movementState - A boolean which allows cursor movement within the Presentation Space via a mouse click to be enabled or disabled.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getCursorMovementState()

getCursorMovementState

public boolean getCursorMovementState()
Returns the current value of the CursorMovementState property.
See Also:
setCursorMovementState(boolean)

setVTNewLine

public void setVTNewLine(boolean CROnly)
                  throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTNewLine()

isVTNewLine

public boolean isVTNewLine()
Returns the current value of the VTNewLine property.
See Also:
setVTNewLine(boolean)

setVTBackspace

public void setVTBackspace(boolean backspace)
                    throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTBackspace()

setHistory

public void setHistory(boolean history)
                throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHistory()

isHistory

public boolean isHistory()

setHistorySize

public void setHistorySize(java.lang.String size)
                    throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isHistory()

getHistorySize

public java.lang.String getHistorySize()

listHistorySizes

public java.util.Enumeration listHistorySizes()
Returns a list of the valid History size values for the current session type.
See Also:
setHistorySize(java.lang.String), getHistorySize()

listHistorySizes

public java.util.Enumeration listHistorySizes(java.lang.String sessionType)

setVTID

public void setVTID(java.lang.String id)
             throws java.beans.PropertyVetoException
Sets the VT ID 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:
Contains - the VT ID to use. This ID is used to determine how the emulation will identify itself to the host.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.

getVTID

public java.lang.String getVTID()

listVTIDs

public java.util.Enumeration listVTIDs()
Returns a list of the valid VT ID values for this VT Session.
See Also:
setVTID(java.lang.String), getVTID()

setPrintDestination

public void setPrintDestination(boolean printer)
                         throws java.beans.PropertyVetoException
Sets the printDestination property. This property only applies to HOD VT sessions, 3270 printer and 5250 printer sessions.
Parameters:
printer - true causes print job to be sent to a printer device.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPrintDestination()

isPrintDestination

public boolean isPrintDestination()
Returns the current value of the printDestination property.
See Also:
setPrintDestination(boolean)

setSeparateFiles

public void setSeparateFiles(boolean separate)
                      throws java.beans.PropertyVetoException
Sets the separateFiles property. This property only applies to HOD VT sessions, 3270 printer and 5250 printer sessions.
Parameters:
true - causes print jobs to be saved in separate files.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isSeparateFiles()

isSeparateFiles

public boolean isSeparateFiles()
Returns the current value of the separateFiles property.
See Also:
setSeparateFiles(boolean)

setPrintFileName

public void setPrintFileName(java.lang.String fileName)
                      throws java.beans.PropertyVetoException
Sets the printFileName property. This property only applies to HOD VT, 3270 printer and 5250 printer sessions.
Parameters:
fileName - is the name to be assigned to the print file.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPrintFileName()

getPrintFileName

public java.lang.String getPrintFileName()
Returns the current value of the printFileName property.
See Also:
setPrintFileName(java.lang.String)

setPrinterName

public void setPrinterName(java.lang.String printerName)
                    throws java.beans.PropertyVetoException
Sets the printerName property. This property only applies to HOD VT sessions, 3270 printer and 5250 printer sessions.
Parameters:
printerName - is the name of the destination printer device.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPrinterName()

getPrinterName

public java.lang.String getPrinterName()
Returns the current value of the printerName property.
See Also:
setPrinterName(java.lang.String)

setWorkstationID

public void setWorkstationID(java.lang.String workstationID)
                      throws java.beans.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.

Note: It is recommended that the isValidWorkstationID(String workstationID) function be called first to check the validity of the String. All lowercase characters will be converted to uppercase.

Parameters:
workstation - ID The workstation ID that is used during enhanced negotiation for 5250.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getWorkstationID(), isValidWorkstationID(java.lang.String)

isValidWorkstationID

public static boolean isValidWorkstationID(java.lang.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(java.lang.String)

getWorkstationID

public java.lang.String getWorkstationID()
Returns the current value of the workstation ID property. This method is only valid for 5250 session.
Specified by:
getWorkstationID in interface com.ibm.eNetwork.beans.HOD.SessionInterface
See Also:
setWorkstationID(java.lang.String)

isVTBackspace

public boolean isVTBackspace()
Returns the value of the VTBackspace property.
Returns:
the current setting of the VTBackspace property
See Also:
setVTBackspace(boolean)

setVTLocalEcho

public void setVTLocalEcho(boolean localEcho)
                    throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTLocalEcho()

isVTLocalEcho

public boolean isVTLocalEcho()
Returns the value of the VTLocalEcho.
Returns:
the current setting of the VTLocalEcho property
See Also:
setVTNewLine(boolean)

setIgnoreWellKnownTrustedCAs

public void setIgnoreWellKnownTrustedCAs(boolean ignoreWellKnownCAs)
                                  throws java.beans.PropertyVetoException
Sets the ignoreWellKnownTrustedCAs property. This property only applies to SSL sessions.
Parameters:
ignoreWellKnownTrustedCAs - true: ignore WellKnownTrustedCAs.class signer certificates.
false: use WellKnownTrustedCAs.class signer certificates.
See Also:
isIgnoreWellKnownTrustedCAs()

isIgnoreWellKnownTrustedCAs

public boolean isIgnoreWellKnownTrustedCAs()
Returns the value of the ignoreWellKnownTrustedCAs property.
Returns:
the current setting of the ignoreWellKnownTrustedCAs property.
See Also:
setIgnoreWellKnownTrustedCAs(boolean)

setVTCursor

public void setVTCursor(boolean application)
                 throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTCursor()

isVTCursor

public boolean isVTCursor()
Returns the value of the VTCursor property.
Returns:
the current setting of the VTCursor property
See Also:
setVTCursor(boolean)

setVTKeypad

public void setVTKeypad(boolean application)
                 throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTKeypad()

isVTKeypad

public boolean isVTKeypad()
Returns the value of the VTKeypad property.
Returns:
the current setting of the VTKeypad property
See Also:
setVTKeypad(boolean)

setVTAutowrap

public void setVTAutowrap(boolean autowrap)
                   throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTAutowrap()

isVTAutowrap

public boolean isVTAutowrap()
Returns the value of the VTAutowrap property.
Returns:
the current setting of the VTAutowrap property
See Also:
setVTAutowrap(boolean)

setVTReverseScreen

public void setVTReverseScreen(boolean reverse)
                        throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isVTReverseScreen()

isVTReverseScreen

public boolean isVTReverseScreen()
Returns the value of the VTReverseScreen property.
Returns:
the current setting of the VTReverseScreen property
See Also:
setVTReverseScreen(boolean)

setPasteFieldWrap

public void setPasteFieldWrap(boolean pasteFieldWrap)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteFieldWrap()

isPasteFieldWrap

public boolean isPasteFieldWrap()
Returns the value of the pasteFieldWrap property.
Returns:
the current setting of the pasteFieldWrap property
See Also:
setPasteFieldWrap(boolean)

setPasteLineWrap

public void setPasteLineWrap(boolean pasteLineWrap)
                      throws java.beans.PropertyVetoException
Sets the pasteLineWrap property.
Parameters:
pasteLineWrap - true sets wrap on field, false sets normal wrap
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteLineWrap()

isPasteLineWrap

public boolean isPasteLineWrap()
Returns the value of the pasteLineWrap property.
Returns:
the current setting of the pasteLineWrap property
See Also:
setPasteLineWrap(boolean)

setPasteWordBreak

public void setPasteWordBreak(boolean pasteWordBreak)
                       throws java.beans.PropertyVetoException
Sets the pasteWordBreak property. This property does not apply to VT sessions.
Parameters:
pasteWordBreak - true sets paste to paste not to split words, false sets normal paste
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteWordBreak()

isPasteWordBreak

public boolean isPasteWordBreak()
Returns the value of the pasteWordBreak property.
Returns:
the current setting of the pasteWordBreak property
See Also:
setPasteWordBreak(boolean)

setPasteToTrimmedArea

public void setPasteToTrimmedArea(boolean pasteToTrimmedArea)
                           throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteToTrimmedArea()

isPasteToTrimmedArea

public boolean isPasteToTrimmedArea()
Returns the value of the pasteToTrimmedArea property.
Returns:
the current setting of the pasteToTrimmedArea property
See Also:
setPasteToTrimmedArea(boolean)

setPasteStopAtProtectedLine

public void setPasteStopAtProtectedLine(boolean pasteStopAtProtectedLine)
                                 throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isPasteStopAtProtectedLine()

isPasteStopAtProtectedLine

public boolean isPasteStopAtProtectedLine()
Returns the value of the pasteStopAtProtectedLine property.
Returns:
the current setting of the pasteStopAtProtectedLine property
See Also:
setPasteStopAtProtectedLine(boolean)

setPasteTabOptions

public void setPasteTabOptions(java.lang.String pasteTabOptions)
                        throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.
See Also:
getPasteTabOptions(), listPasteTabOptions()

getPasteTabOptions

public java.lang.String getPasteTabOptions()
Returns the current setting of the pasteOptionsType property.
See Also:
setPasteTabOptions(java.lang.String), listPasteTabOptions()

listPasteTabOptions

public static java.util.Enumeration listPasteTabOptions()
Returns a list of the valid pasteOptionsType values.
See Also:
setPasteTabOptions(java.lang.String), getPasteTabOptions()

setPasteTabColumns

public void setPasteTabColumns(int pasteTabColumns)
                        throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPasteTabColumns()

getPasteTabColumns

public int getPasteTabColumns()
Returns the current value of the pasteTabColumns property.
See Also:
setPasteTabColumns(int)

setPasteTabSpaces

public void setPasteTabSpaces(int pasteTabSpaces)
                       throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getPasteTabSpaces()

getPasteTabSpaces

public int getPasteTabSpaces()
Returns the current value of the pasteTabSpaces property.
See Also:
setPasteTabSpaces(int)

setCopyOnlyIfTrimmed

public void setCopyOnlyIfTrimmed(boolean copyOnlyIfTrimmed)
                          throws java.beans.PropertyVetoException
Sets the copyOnlyIfTrimmed property.
Parameters:
copyOnlyIfTrimmed - true sets copy error when no trim, false copy entire screen when no trim
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isCopyOnlyIfTrimmed()

isCopyOnlyIfTrimmed

public boolean isCopyOnlyIfTrimmed()
Returns the value of the copyOnlyIfTrimmed property.
Returns:
the current setting of the copyOnlyIfTrimmed property
See Also:
setCopyOnlyIfTrimmed(boolean)

setCopyAltSignLocation

public void setCopyAltSignLocation(boolean copyAltSignLocation)
                            throws java.beans.PropertyVetoException
Sets the copyAltSignLocation property.
Parameters:
copyAltSignLocation - true sets copy error when no trim, false copy entire screen when no trim
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isCopyAltSignLocation()

isCopyAltSignLocation

public boolean isCopyAltSignLocation()
Returns the value of the copyAltSignLocation property.
Returns:
the current setting of the copyAltSignLocation property
See Also:
setCopyAltSignLocation(boolean)

setTrimRectSizingHandles

public void setTrimRectSizingHandles(boolean trimRectSizingHandles)
                              throws java.beans.PropertyVetoException
Sets the trimRectSizingHandles property.
Parameters:
trimRectSizingHandles - true sets trim rec sizeable, false sets unsizeable
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
isTrimRectSizingHandles()

isTrimRectSizingHandles

public boolean isTrimRectSizingHandles()
Returns the value of the trimRectSizingHandles property.
Returns:
the current setting of the trimRectSizingHandles property
See Also:
setTrimRectSizingHandles(boolean)

setTrimRectRemainAfterEdit

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

isTrimRectRemainAfterEdit

public boolean isTrimRectRemainAfterEdit()
Returns the value of the trimRectRemainAfterEdit property.
Returns:
the current setting of the trimRectRemainAfterEdit property
See Also:
setTrimRectRemainAfterEdit(boolean)

getECLSession

public com.ibm.eNetwork.ECL.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.
Specified by:
getECLSession in interface com.ibm.eNetwork.beans.HOD.SessionInterface

defaults

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

setNumeralShape

public void setNumeralShape(java.lang.String ns)
                     throws java.beans.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
  • Session.CONTEXTUAL
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getNumeralShape

public java.lang.String getNumeralShape()
Returns the current value of the numeralShape property.
See Also:
setNumeralShape(java.lang.String)

listNumeralShapes

public static java.util.Enumeration listNumeralShapes()
Returns the list of valid numeralShape values.
See Also:
setNumeralShape(java.lang.String)

setTextType

public void setTextType(java.lang.String tt)
                 throws java.beans.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
  • Session.LOGICAL
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getTextType

public java.lang.String getTextType()
Returns the current value of the textType property.
See Also:
setTextType(java.lang.String)

listTextTypes

public static java.util.Enumeration listTextTypes()
Returns the list of valid textType values.
See Also:
setTextType(java.lang.String)

setTextOrientation

public void setTextOrientation(java.lang.String to)
                        throws java.beans.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
  • Session.RIGHT_TO_LEFT
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getTextOrientation

public java.lang.String getTextOrientation()
Returns the current value of the textOrientation property.
See Also:
setTextOrientation(java.lang.String)

listTextOrientations

public static java.util.Enumeration listTextOrientations()
Returns a list of the valid textOrientation values.
See Also:
setTextOrientation(java.lang.String)

setLamAlef

public void setLamAlef(java.lang.String tt)
                throws java.beans.PropertyVetoException
Sets the LamAlef property. Determines whether LamAlef should be expanded/compressed. This property applies Arabic Sessions only.

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

Parameters:
tt - Can be one of the following string constants:
  • Session.LAMALEF_ON
  • Session.LAMALEF_OFF
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getLamAlef

public java.lang.String getLamAlef()
Returns the current value of the LamAlef property.
See Also:
setLamAlef(java.lang.String)

listLamAlef

public static java.util.Enumeration listLamAlef()
Returns the list of valid textType values.
See Also:
setLamAlef(java.lang.String)

setRoundTrip

public void setRoundTrip(java.lang.String to)
                  throws java.beans.PropertyVetoException
Sets the roundTrip 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.ROUNDTRIP_ON
  • Session.ROUNDTRIP_OFF
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value or if an incorrect value is specified.

getRoundTrip

public java.lang.String getRoundTrip()
Returns the current value of the roundTrip property.
See Also:
setRoundTrip(java.lang.String)

listRoundTripModes

public static java.util.Enumeration listRoundTripModes()
Returns a list of the valid roundTrip values.
See Also:
setRoundTrip(java.lang.String)

setThaiDisplayMode

public void setThaiDisplayMode(int mode)
                        throws java.beans.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:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value
See Also:
getThaiDisplayMode()

getThaiDisplayMode

public int getThaiDisplayMode()
Returns the current value of the ThaiDisplayMode property
See Also:
setThaiDisplayMode(int)

listThaiDisplayModes

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

getTraceName

public java.lang.String getTraceName()
Returns a trace identifier for this bean
Overrides:
getTraceName in class HODBean

setBIDIMode

public void setBIDIMode(java.lang.String to)
                 throws java.beans.PropertyVetoException
Sets BIDImode property. Is used to enable or disable BIDI functions, like characters shaping. This property applies Arabic VT sessions only
Parameters:
to - Enabling BIDI functions. Can be one of the following constants:
  • Session.BIDIMODE_ON
  • Session.BIDIMODE_OFF
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value

getBIDIMode

public java.lang.String getBIDIMode()
Returns the current value of the BIDIMode property
See Also:
setBIDIMode(java.lang.String)

setTextTypeDisp

public void setTextTypeDisp(java.lang.String to)
                     throws java.beans.PropertyVetoException
Sets TextTypeDisp property. Determines whether session works in Logical or Visual mode This property applies BIDI VT sessions only
Parameters:
to - New display mode. Can be one of the following string constants:
  • Session.VISUAL_DISP
  • Session.LOGICAL_DISP
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value

getTextTypeDisp

public java.lang.String getTextTypeDisp()
Returns the current value of the TextTypeDisp property
See Also:
setTextTypeDisp(java.lang.String)

setCursorDirection

public void setCursorDirection(java.lang.String to)
                        throws java.beans.PropertyVetoException
Sets cursorDirection property. Determines whether cursor direction is left-to-right or right-to-left This property applies BIDI Visual VT sessions only
Parameters:
to - New direction. Can be one of the following values:
  • Session.CURSOR_LTR
  • Session.CURSOR_RTL
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value

getCursorDirection

public java.lang.String getCursorDirection()
Returns the current value of the cursorDirection property
See Also:
setCursorDirection(java.lang.String)

setNumeralShapeDisp

public void setNumeralShapeDisp(java.lang.String to)
                         throws java.beans.PropertyVetoException
Sets numeralShapeDisp property. Determines how numerals should be shaped This property applies Arabic VT sessions only
Parameters:
to - New shaping. Can be one of the following values:
  • Session.NOMINAL_DISP
  • Session.NATIONAL_DISP
  • Session.CONTEXTUAL_DISP
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value

getNumeralShapeDisp

public java.lang.String getNumeralShapeDisp()
Returns the current value of the numeralShapeDisp property
See Also:
setNumeralShapeDisp(java.lang.String)

setSmartOrdering

public void setSmartOrdering(java.lang.String to)
                      throws java.beans.PropertyVetoException
Sets the smartOrdering property. Determines whether segment of characters with different text attributes is ordered separatly. This property applies BIDI Logical VT sessions only
Parameters:
to - New ordering value
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value

getSmartOrdering

public java.lang.String getSmartOrdering()
Returns the current value of the smartOrdering property
See Also:
setSmartOrdering(java.lang.String)

listTextTypesDisp

public static java.util.Enumeration listTextTypesDisp()
Returns a list of the valid values for TextTypeDisp property
See Also:
setTextTypeDisp(java.lang.String), getTextTypeDisp()

listCursorDirections

public static java.util.Enumeration listCursorDirections()
Returns a list of the valid values for cursorDirections property
See Also:
setCursorDirection(java.lang.String), getCursorDirection()

listBIDIModes

public static java.util.Enumeration listBIDIModes()
Returns a list of the valid values for BIDIMode property
See Also:
setBIDIMode(java.lang.String), getBIDIMode()

listNumeralShapesDisp

public static java.util.Enumeration listNumeralShapesDisp()
Returns a list of the valid values for NumeralShape property
See Also:
setNumeralShape(java.lang.String), getNumeralShape()

listSmartOrdering

public static java.util.Enumeration listSmartOrdering()
Returns a list of the valid values for smartOrdering property
See Also:
setSmartOrdering(java.lang.String), getSmartOrdering()

setLUMPort

public void setLUMPort(int PortNumber)
                throws java.beans.PropertyVetoException
Sets the LUMPort property.

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

Parameters:
PortNumber - Port number for the LUM server
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

getLUMPort

public int getLUMPort()
Returns the LUM server port number

setServiceMgrHost

public void setServiceMgrHost(java.lang.String ServerMgrHost)
                       throws java.beans.PropertyVetoException
Sets the HOD server property.

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

Parameters:
ServerMgrHost - name for the HOD server
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

getServiceMgrHost

public java.lang.String getServiceMgrHost()
Returns the HOD server

setLUMLicensing

public void setLUMLicensing(java.lang.String servertype)
                     throws java.beans.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
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

getLUMLicensing

public java.lang.String getLUMLicensing()
Returns the License method type

listLUMLicensing

public static java.util.Enumeration listLUMLicensing()

setLUMServer

public void setLUMServer(java.lang.String LUMServer)
                  throws java.beans.PropertyVetoException
Sets the LUM server property.

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

Parameters:
LumServer - name for the LUM server
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

getLUMServer

public java.lang.String getLUMServer()
Returns the LUM server

setSymmetricSwapEnabled

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

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

Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isSymmetricSwapEnabled

public boolean isSymmetricSwapEnabled()
Returns the current value of the Symmetric Swapping property.
See Also:
setSymmetricSwapEnabled(boolean)

setNumericSwapEnabled

public void setNumericSwapEnabled(boolean value)
                           throws java.beans.PropertyVetoException
Sets the Numeric swapping property. This property applies (Arabic 3270 sessions only)

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

Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isNumericSwapEnabled

public boolean isNumericSwapEnabled()
Returns the current value of the Numeric Swapping property.
See Also:
setNumericSwapEnabled(boolean)

setShowTextAttributesEnabled

public void setShowTextAttributesEnabled(boolean value)
                                  throws java.beans.PropertyVetoException
Sets the Show Text Attributes property. This property applies (logical bidi VT sessions only)
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isShowTextAttributesEnabled

public boolean isShowTextAttributesEnabled()
Returns the current value of the Show Text Attributes property.

setVTPDTName

public void setVTPDTName(java.lang.String pdtname)
                  throws java.beans.PropertyVetoException
Sets the name of PDT file for VT BIDI session. When the property is not set, void default PDT is used, and printing is performed with default printer character set.

For more about this feature, see Host On-Demand Online Help -> National Language Support -> Bidirectional language support -> Help for VT bidirectional language support (Arabic and Hebrew) is available -> Bidirectional support for printing in a VT session .

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

Parameters:
pdtname - Name of PDT file
Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

getVTPDTName

public java.lang.String getVTPDTName()
Returns the name of PDT file for VT BIDI session

setVTPrintConvert

public void setVTPrintConvert(boolean convert)
                       throws java.beans.PropertyVetoException
Enables/Disables host-to-printer codepage conversion for VT BIDI session.

For more about this feature, see Host On-Demand Online Help -> National Language Support -> Bidirectional language support -> Help for VT bidirectional language support (Arabic and Hebrew) is available -> Bidirectional support for printing in a VT session .

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

Throws:
java.beans.PropertyVetoException - Thrown if one of the VetoableChangeListeners rejects the change.

isVTPrintConvert

public boolean isVTPrintConvert()
Checks is host-to-printer codepage conversion for VT BIDI session enabled