All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.Session
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.HODBean
|
+----com.ibm.eNetwork.beans.HOD.Session
- public class Session
- extends HODBean
- implements SendKeyListener, PropertyChangeListener, SessionInterface
The Session Bean is used to establish a connection with a host. It
defines the behavior and characteristics of the session with the host.
The Session Bean can be constructed with a Properties object which contains
some or all the configuration information for the session.
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.
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.
The following table lists the properties of the Session Bean:
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) |
-
AUTO_CONNECT
- autoConnect property keyword
-
AUTO_RECONNECT
- autoReconnect property keyword
-
BIDI_MODE
- BIDIMode property keyword (VT bi-directional sessions only)
-
BIDI_MODE_OFF
-
-
BIDI_MODE_ON
- BIDIMode property values (VT bi-directional sessions only)
-
CICS_GW_CODE_PAGE
- CICSGWCodePage property keyword
-
CICS_SERVER_NAME
- CICSServerName property keyword
-
CODE_PAGE
- codePage property keyword
-
CONNECTION_ACTIVE
- commStatus property value - active (connected to host)
-
CONNECTION_DEVICE_NAME_READY
- commStatus property value - the device name is available from the host
-
CONNECTION_INACTIVE
- commStatus property value - inactive (no connection to host)
-
CONNECTION_INIT
- commStatus property value - initial state (no connection to host)
-
CONNECTION_PND_ACTIVE
- commStatus property value - pending active
-
CONNECTION_PND_INACTIVE
- commStatus property value - pending inactive
-
CONNECTION_READY
- commStatus property value - host is ready for interaction
-
CONNECTION_WORKSTATION_ID_READY
- commStatus property value - the workstation ID is available from the host
-
CONTEXTUAL
- numeralShape property value - contextual (bi-directional sessions only)
-
CONTEXTUAL_DISP
-
-
COPY_ONLY_IF_TRIMMED
- Copy Only If Trimmed property keyword
-
CURSOR_DIRECTION
- cursorDirection property keyword (VT bi-directional sessions only)
-
CURSOR_LTR
- cursorDirection property values (VT bi-directional sessions only)
-
CURSOR_RTL
-
-
ENPTUI
- enptui property keyword
-
GRAPHICS_CELL_SIZE
- graphicsCellSize property keyword
-
HISTORY
- History property keyword
-
HISTORY_SIZE
- History size property keyword
-
HOST
- host property keyword
-
HOST_GRAPHICS
- hostGraphics property keyword
-
LEFT_TO_RIGHT
- textOrientation property value - left to right (bi-directional sessions only)
-
LOGICAL
- textType property value - logical (bi-directional sessions only)
-
LOGICAL_DISP
-
-
LU_NAME
- LUName property keyword
-
LUM_LICENSING
- Lum licensing property keyword
-
LUM_PORT
- Lum port property keyword
-
LUM_SERVER
- LUM server property keyword
-
NATIONAL
- numeralShape property value - national (bi-directional sessions only)
-
NATIONAL_DISP
-
-
NOMINAL
- numeralShape property value - nominal (bi-directional sessions only)
-
NOMINAL_DISP
- numeralShapeDisp property values (VT bi-directional sessions only)
-
NUM_FIELD_LOCK
- numericFieldLock property keyword
-
NUM_SWAP_ENABLED
- Numeric swapping value - (Arabic 3270 sessions only)
-
NUMERAL_SHAPE
- numeralShape property keyword
-
NUMERAL_SHAPE_DISP
- numeralShapeDisp property keyword (VT bi-directional sessions only)
-
PASTE_FIELD_WRAP
- Paste Field Wrap property keyword
-
PASTE_LINE_WRAP
- Paste word line wrap property keyword
-
PASTE_STOP_PRO_LINE
- Paste Stop At Protected Line property keyword
-
PASTE_TAB_COLUMNS
- Paste Tab Columns property keyword
-
PASTE_TAB_OPTIONS
- Paste Tab Options property keyword
-
PASTE_TAB_SPACES
- Paste Tab Spaces property keyword
-
PASTE_TO_TRIMMED_AREA
- Paste To Trimmed area property keyword
-
PORT
- port property keyword
-
PRINT_BUFFSIZE
- printBufferSize property keyword
-
PRINT_DESTINATION
- printDestination property keyword
-
PRINT_FILE_NAME
- printFileName property keyword
-
PRINT_SEPARATE_FILES
- separateFiles property keyword
-
PRINTER_NAME
- printerName property keyword
-
RIGHT_TO_LEFT
- textOrientation property value - right to left (bi-directional sessions only)
-
SCREEN_SIZE
- screenSize property keyword
-
SERVICE_MGR_HOST
- Service manager host property keyword
-
SESSION_ID
- sessionID property keyword
-
SESSION_NAME
- sessionName property keyword
-
SESSION_TYPE
- sessionType property keyword
-
SLP_AS400_NAME
- SLPAS400Name property keyword
-
SLP_ENABLED
- SLPEnabled property keyword
-
SLP_MAX_WAIT_TIME
- SLPMaxWaitTime Property keyword
-
SLP_SCOPE
- SLPScope property keyword
-
SLP_THIS_SCOPE_ONLY
- SLPThisScopeOnly property keyword
-
SSL
- SSL property keyword
-
SSL_BROWSER_KEYRING_ADDED
- SSLBrowserKeyringAdded property keyword
-
SSL_CERTIFICATE_HASH
- SSLCertificateHash property keyword
-
SSL_CERTIFICATE_NAME
- SSLCertificateName property keyword
-
SSL_CERTIFICATE_PASSWORD
- SSLCertificatePassword property keyword
-
SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
- SSLCertificatePromptBeforeConnect property keyword
-
SSL_CERTIFICATE_PROMPT_HOW_OFTEN
- SSLCertificatePromptHowOften property keyword
-
SSL_CERTIFICATE_PROMPTED
- SSLCertificatePrompted property keyword
-
SSL_CERTIFICATE_PROVIDED
- SSLCertificateProvided property keyword
-
SSL_CERTIFICATE_REMEMBERED
- SSLCertificateRemembered property keyword
-
SSL_CERTIFICATE_SOURCE
- SSLCertificateSource property keyword
-
SSL_CERTIFICATE_URL
- SSLCertificateURL property keyword
-
SSL_SERVER_AUTHENTICATION
- SSLServerAuthentication property keyword
-
SSL_TELNET_NEGOTIATED
- SSLTelnetNegotiated property keyword
-
SYM_SWAP_ENABLED
- symmetric swapping value - (Arabic 3270 sessions only)
-
TEXT_ORIENTATION
- textOrientation property keyword
-
TEXT_TYPE
- textType property keyword
-
TEXT_TYPE_DISP
- textTypeDisp property keyword (VT bi-directional sessions only)
-
THAI_DISPLAY_MODE
- ThaiDisplayMode property keyword
-
THAI_MODE_1
- Thai mode 1 property value - non composed mode (Thai session only)
-
THAI_MODE_2
- Thai mode 2 property value - composed mode (Thai session only)
-
THAI_MODE_3
- Thai mode 3 property value - composed mode with space alignment (Thai session only)
-
THAI_MODE_4
- Thai mode 4 property value - composed mode with EOF alignment (Thai session only)
-
THAI_MODE_5
- Thai mode 5 property value - composed mode with space and EOF alignment (Thai session only)
-
TN_ENHANCED
- TNEnhanced property keyword
-
TRIM_RECT_REMAIN_AFTER
- Trim Rectangle Remain After Edit
-
TRIM_RECT_SIZING_HANDLES
- Trim Rectangle Sizing handles
-
VISUAL
- textType property value - visual (bi-directional sessions only)
-
VISUAL_DISP
- textTypeDisp property values (VT bi-directional sessions only)
-
VT_ANS_BACK_MSG
- VTAnswerBackMsg property keyword
-
VT_AUTOWRAP
- VTAutowrap property keyword
-
VT_BACKSPACE
- VTBackspace property keyword
-
VT_CURSOR
- VTCursor property keyword
-
VT_KEYPAD
- VTKeypad property keyword
-
VT_LOCAL_ECHO
- VTLocalEcho property keyword
-
VT_NEW_LINE
- VTNewLine property keyword
-
VT_REVERSE_SCREEN
- VTReverseScreen property keyword
-
VT_TERMINAL_TYPE
- VTTerminalType property keyword
-
WORKSTATION_ID
- workstationID property keyword
-
Session()
- Constructor which builds a Session Bean using the default property
values.
-
Session(Properties)
- Constructor which builds a Session Bean using the property values passed
in the Property object.
-
addCommListener(CommListener)
- Adds a CommEvent listener
-
addGUIListener(GUIListener)
- Adds a GUIEvent listener
-
addOIAListener(OIAListener)
- Adds an OIAEvent listener
-
addPSListener(PSListener)
- Adds a PSEvent listener
-
addTraceListener(TraceListener)
- Adds a TraceEvent listener
-
defaults()
- Returns a Properties object containing the default properties and their
values for this Session Bean.
-
dispose()
- Disposes of the Session and all of its resources.
-
getBIDIMode()
-
-
getCICSGWCodePage()
- Returns the current value of the CICSGWCodepage property.
-
getCICSServerName()
- Returns the current value of the CICSServerName property.
-
getCodePage()
- Returns the current value of the codePage property.
-
getCommStatus()
- Returns the status of communications with the host.
-
getCursorDirection()
-
-
getDeviceName()
- If isDeviceNameReady() is true, returns the device name in use, otherwise returns null.
-
getECLSession()
- Returns the ECLSession object associated with this Session.
-
getGraphicsCellSize()
- Returns the current value of the graphicsCellSize property.
-
getHistorySize()
-
-
getHost()
- Returns the current value of the host property.
-
getLUMLicensing()
- Returns the License method type
-
getLUMPort()
- Returns the LUM server port number
-
getLUMServer()
- Returns the LUM server
-
getLUName()
- Returns the current value of the LUName property.
-
getNumeralShape()
- Returns the current value of the numeralShape property.
-
getNumeralShapeDisp()
-
-
getPasteTabColumns()
- Returns the current value of the pasteTabColumns property.
-
getPasteTabOptions()
- Returns the current setting of the pasteOptionsType property.
-
getPasteTabSpaces()
- Returns the current value of the pasteTabSpaces property.
-
getPort()
- Returns the current value of the port property.
-
getPrinterName()
- Returns the current value of the printerName property.
-
getPrintFileName()
- Returns the current value of the printFileName property.
-
getProperties()
- Returns the current properties for Session.
-
getScreenSize()
- Returns the current value of the screenSize property.
-
getSecurityInfoIntf(Frame)
-
-
getServiceMgrHost()
- Returns the HOD server
-
getSession()
- Needed for SessionInterface
-
getSessionID()
- Returns the value of the sessionID property.
-
getSessionName()
- Returns the value of the sessionName property.
-
getSessionType()
- Returns the current setting of the sessionType property.
-
getSLPAS400Name()
- Returns the current value of the SLPAS400Name property.
-
getSLPMaxWaitTime()
- Returns the current value of the SLPMaxWaitTime property.
-
getSLPScope()
- Returns the current value of the SLPScope property.
-
getSSLCertificateHash()
- Returns the current value of the SSLCertificateHash property.
-
getSSLCertificateName()
- Returns the current value of the SSLCertificateName property.
-
getSSLCertificatePromptHowOften()
- Returns the current value of the SSLCertificatePromptHowOften property.
-
getSSLCertificateSource()
- Returns the current value of the SSLCertificateSource property.
-
getSSLCertificateURL()
- Returns the current value of the SSLCertificateURL property.
-
getTextOrientation()
- Returns the current value of the textOrientation property.
-
getTextType()
- Returns the current value of the textType property.
-
getTextTypeDisp()
-
-
getThaiDisplayMode()
- Returns the current value of the ThaiDisplayMode property
-
getTraceName()
- Returns a trace identifier for this bean
-
getVTAnswerBackMsg()
- Returns the current value of the VTAnswerBackMsg property.
-
getVTTerminalType()
- Returns the current value of the VTTerminalType property.
-
getWorkstationID()
- Returns the current value of the workstation ID property.
-
isAutoConnect()
- Returns the value of the autoConnect property.
-
isAutoReconnect()
- Returns the current value of the autoReconnect property.
-
isCommReady()
- Returns true if the host is ready for interaction, otherwise returns
false.
-
isCommStarted()
- Determines whether the connection with the host has been started.
-
isCopyOnlyIfTrimmed()
- Returns the value of the copyOnlyIfTrimmed property.
-
isDeviceNameReady()
- Returns true if the device name is ready, otherwise returns false.
-
isENPTUI()
- Returns the value of the enptui property.
-
isHistory()
-
-
isHostGraphics()
- Returns the value of the hostGraphics property.
-
isNumericFieldLock()
- Returns the value of the Numeric Field Lock property.
-
isNumericSwapEnabled()
- Returns the current value of the Numeric Swapping property.
-
isPasteFieldWrap()
- Returns the value of the pasteFieldWrap property.
-
isPasteLineWrap()
- Returns the value of the pasteLineWrap property.
-
isPasteStopAtProtectedLine()
- Returns the value of the pasteStopAtProtectedLine property.
-
isPasteToTrimmedArea()
- Returns the value of the pasteToTrimmedArea property.
-
isPrintDestination()
- Returns the current value of the printDestination property.
-
isSeparateFiles()
- Returns the current value of the separateFiles property.
-
isSLPEnabled()
- Returns the current value of the SLPEnabled property.
-
isSLPThisScopeOnly()
- Returns the current value of the SLPThisScopeOnly property.
-
isSSL()
- Returns the value of the SSL property.
-
isSSLBrowserKeyringAdded()
- Returns the current value of the SSLBrowserKeyringAdded property.
-
isSSLCertificatePromptBeforeConnect()
- Returns the current value of the SSLCertificatePromptBeforeConnect property.
-
isSSLCertificatePrompted()
- Returns the current value of the SSLCertificatePrompted property.
-
isSSLCertificateProvided()
- Returns the current value of the SSLCertificateProvided property.
-
isSSLCertificateRemembered()
- Returns the current value of the SSLCertificateRemembered property.
-
isSSLServerAuthentication()
- Returns the current value of the SSLServerAuthentication property.
-
isSSLTelnetNegotiated()
- Returns the current value of the SSLTelnetNegotiated property.
-
isSymmetricSwapEnabled()
- Returns the current value of the Symmetric Swapping property.
-
isTNEnhanced()
- Returns the current value of the TNEnhanced property.
-
isTrimRectRemainAfterEdit()
- Returns the value of the trimRectRemainAfterEdit property.
-
isTrimRectSizingHandles()
- Returns the value of the trimRectSizingHandles property.
-
isValidLUName(String)
- Tests the given luName for correct syntax.
-
isValidSLPAS400Name(String)
- Tests the given SLPAS400Name for correct syntax.
-
isValidSLPScope(String)
- Tests the given SLPScope for correct syntax.
-
isValidWorkstationID(String)
- Tests the given workstationID for correct syntax.
-
isVTAutowrap()
- Returns the value of the VTAutowrap property.
-
isVTBackspace()
- Returns the value of the VTBackspace property.
-
isVTCursor()
- Returns the value of the VTCursor property.
-
isVTKeypad()
- Returns the value of the VTKeypad property.
-
isVTLocalEcho()
- Returns the value of the VTLocalEcho.
-
isVTNewLine()
- Returns the current value of the VTNewLine property.
-
isVTReverseScreen()
- Returns the value of the VTReverseScreen property.
-
isWorkstationIDReady()
- Returns true if the workstation ID is ready, otherwise returns false.
-
listBIDIModes()
-
-
listCICSGWCodePages()
- Returns the list of valid CICSGWCodePage values.
-
listCodePages()
- Returns a list of the valid codePage values for the current session
type.
-
listCodePages(String)
- Returns a list of the valid codePage values for the given session type.
-
listCursorDirections()
-
-
listGraphicsCellSizes()
- Returns a list of the valid graphicsCellSize values
-
listHistorySizes()
- Returns a list of the valid History size values for the current session
type.
-
listHistorySizes(String)
-
-
listLUMLicensing()
-
-
listNumeralShapes()
- Returns the list of valid numeralShape values.
-
listNumeralShapesDisp()
-
-
listPasteTabOptions()
- Returns a list of the valid pasteOptionsType values.
-
listScreenSizes()
- Returns a list of the valid screenSize values for the current session
type.
-
listScreenSizes(String)
- Returns a list of the valid screenSize values for the specified
session type.
-
listSessionTypes()
- Returns a list of the valid sessionType values.
-
listTextOrientations()
- Returns a list of the valid textOrientation values.
-
listTextTypes()
- Returns the list of valid textType values.
-
listTextTypesDisp()
-
-
listThaiDisplayModes()
- Returns the list of valid ThaiDisplayMode values.
-
listVTTerminalTypes()
- Returns a list of the valid VTTerminalTypes.
-
removeCommListener(CommListener)
- Removes a CommEvent listener
-
removeGUIListener(GUIListener)
- Removes a GUIEvent listener
-
removeOIAListener(OIAListener)
- Remove an OIAEvent listener
-
removePSListener(PSListener)
- Removes a PSEvent listener
-
sendKeys(SendKeyEvent)
- Handles SendKeyEvents sent to this Session Bean.
-
setAutoConnect(boolean)
- Sets the autoConnect property.
-
setAutoReconnect(boolean)
- Sets the autoReconnect property.
-
setBIDIMode(String)
-
-
setCICSGWCodePage(String)
- Sets the CICSGWCodepage property.
-
setCICSServerName(String)
- Sets the CICSServerName property.
-
setCodePage(String)
- Sets the codePage property.
-
setCopyOnlyIfTrimmed(boolean)
- Sets the copyOnlyIfTrimmed property.
-
setCursorDirection(String)
-
-
setENPTUI(boolean)
- Sets the enptui property.
-
setGraphicsCellSize(String)
- Sets the graphicsCellSize property.
-
setHistory(boolean)
- Sets the History property.
-
setHistorySize(String)
- Sets the History size property.
-
setHost(String)
- Sets the name of host associated with this Session Bean.
-
setHostGraphics(boolean)
- Sets the hostGraphics property.
-
setLUMLicensing(String)
- Sets the license method to either LUM or HOD.
-
setLUMPort(int)
- Sets the LUMPort property.
-
setLUMServer(String)
- Sets the LUM server property.
-
setLUName(String)
- Sets the LUName property.
-
setNumeralShape(String)
- Sets the numeralShape property.
-
setNumeralShapeDisp(String)
-
-
setNumericFieldLock(boolean)
- Sets the Numeric Field Lock property of Session.
-
setNumericSwapEnabled(boolean)
- Sets the Numeric swapping property.
-
setPasteFieldWrap(boolean)
- Sets the pasteFieldWrap property.
-
setPasteLineWrap(boolean)
- Sets the pasteLineWrap property.
-
setPasteStopAtProtectedLine(boolean)
- Sets the pasteStopAtProtectedLine property.
-
setPasteTabColumns(int)
- Sets the pasteTabColumns to set the number of columns represented by
a tab.
-
setPasteTabOptions(String)
- Sets the pasteTabOptions property.
-
setPasteTabSpaces(int)
- Sets the pasteTabSpaces to set the number of spaces represented by
a tab.
-
setPasteToTrimmedArea(boolean)
- Sets the pasteToTrimmedArea property.
-
setPort(int)
- Sets the port that will be used to communicate with the host.
-
setPrintDestination(boolean)
- Sets the printDestination property.
-
setPrinterName(String)
- Sets the printerName property.
-
setPrintFileName(String)
- Sets the printFileName property.
-
setScreenSize(String)
- Sets the screenSize property.
-
setSeparateFiles(boolean)
- Sets the separateFiles property.
-
setServiceMgrHost(String)
- Sets the HOD server property.
-
setSessionID(String)
- Sets the sessionID property.
-
setSessionName(String)
- Sets the sessionName property.
-
setSessionType(String)
- Sets the sessionType property.
-
setSLPAS400Name(String)
- Sets the SLPAS400Name property.
-
setSLPEnabled(boolean)
- Sets the SLPEnabled property.
-
setSLPMaxWaitTime(int)
- Sets the SLPMaxWaitTime in milliseconds that will be used when waiting
for service response.
-
setSLPScope(String)
- Sets the SLPScope property.
-
setSLPThisScopeOnly(boolean)
- Sets the SLPThisScopeOnly property.
-
setSSL(boolean)
- Sets the SSL property of Session.
-
setSSLBrowserKeyringAdded(boolean)
- Sets the SSLBrowserKeyringAdded property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateHash(String)
- Sets the SSLCertificateHash property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateName(String)
- Sets the SSLCertificateName property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificatePassword(String)
- Sets the SSLCertificatePassword property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificatePromptBeforeConnect(boolean)
- Sets the SSLCertificatePromptBeforeConnect property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificatePrompted(boolean)
- Sets the SSLCertificatePrompted property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificatePromptHowOften(String)
- Sets the SSLCertificatePromptHowOften property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateProvided(boolean)
- Sets the SSLCertificateProvided property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateRemembered(boolean)
- Sets the SSLCertificateRemembered property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateSource(String)
- Sets the SSLCertificateSource property of Session
In Personal Communications, this property is ignored.
-
setSSLCertificateURL(String)
- Sets the SSLCertificateURL property of Session
In Personal Communications, this property is ignored.
-
setSSLServerAuthentication(boolean)
- Sets the SSLServerAuthentication property of Session
In Personal Communications, this property is ignored.
-
setSSLTelnetNegotiated(boolean)
- Sets the SSLTelnetNegotiated property of Session.
-
setSymmetricSwapEnabled(boolean)
- Sets the Symmetric swapping property.
-
setTextOrientation(String)
- Sets the textOrientation property.
-
setTextType(String)
- Sets the textType property.
-
setTextTypeDisp(String)
-
-
setThaiDisplayMode(int)
- Set Thai display mode property.
-
setTNEnhanced(boolean)
- Sets the TNEnhanced property.
-
setTrimRectRemainAfterEdit(boolean)
- Sets the trimRectRemainAfterEdit property.
-
setTrimRectSizingHandles(boolean)
- Sets the trimRectSizingHandles property.
-
setVTAnswerBackMsg(String)
- Sets the VTAnswerBackMsg property.
-
setVTAutowrap(boolean)
- Sets the VTAutowrap property.
-
setVTBackspace(boolean)
- Sets the VTBackspace property.
-
setVTCursor(boolean)
- Sets the VTCursor property.
-
setVTKeypad(boolean)
- Sets the VTKeypad property.
-
setVTLocalEcho(boolean)
- Sets the VTLocalEcho property.
-
setVTNewLine(boolean)
- Sets the VTNewLine property.
-
setVTReverseScreen(boolean)
- Sets the VTReverseScreen property.
-
setVTTerminalType(String)
- Sets the VTTerminalType property.
-
setWorkstationID(String)
- Sets the workstationID property.
-
startCommunication()
- Starts communications with the host.
-
stopCommunication()
- Stops communications with the host.
SESSION_TYPE
public static final String SESSION_TYPE
- sessionType property keyword
SESSION_NAME
public static final String SESSION_NAME
- sessionName property keyword
SESSION_ID
public static final String SESSION_ID
- sessionID property keyword
TN_ENHANCED
public static final String TN_ENHANCED
- TNEnhanced property keyword
LU_NAME
public static final String LU_NAME
- LUName property keyword
HOST
public static final String HOST
- host property keyword
PORT
public static final String PORT
- port property keyword
SCREEN_SIZE
public static final String SCREEN_SIZE
- screenSize property keyword
PRINT_BUFFSIZE
public static final String PRINT_BUFFSIZE
- printBufferSize property keyword
WORKSTATION_ID
public static final String WORKSTATION_ID
- workstationID property keyword
CODE_PAGE
public static final String CODE_PAGE
- codePage property keyword
HOST_GRAPHICS
public static final String HOST_GRAPHICS
- hostGraphics property keyword
GRAPHICS_CELL_SIZE
public static final String GRAPHICS_CELL_SIZE
- graphicsCellSize property keyword
ENPTUI
public static final String ENPTUI
- enptui property keyword
AUTO_CONNECT
public static final String AUTO_CONNECT
- autoConnect property keyword
AUTO_RECONNECT
public static final String AUTO_RECONNECT
- autoReconnect property keyword
SLP_ENABLED
public static final String SLP_ENABLED
- SLPEnabled property keyword
SLP_SCOPE
public static final String SLP_SCOPE
- SLPScope property keyword
SLP_AS400_NAME
public static final String SLP_AS400_NAME
- SLPAS400Name property keyword
SLP_THIS_SCOPE_ONLY
public static final String SLP_THIS_SCOPE_ONLY
- SLPThisScopeOnly property keyword
SLP_MAX_WAIT_TIME
public static final String SLP_MAX_WAIT_TIME
- SLPMaxWaitTime Property keyword
SSL
public static final String SSL
- SSL property keyword
SSL_TELNET_NEGOTIATED
public static final String SSL_TELNET_NEGOTIATED
- SSLTelnetNegotiated property keyword
SSL_SERVER_AUTHENTICATION
public static final String SSL_SERVER_AUTHENTICATION
- SSLServerAuthentication property keyword
SSL_BROWSER_KEYRING_ADDED
public static final String SSL_BROWSER_KEYRING_ADDED
- SSLBrowserKeyringAdded property keyword
SSL_CERTIFICATE_PROVIDED
public static final String SSL_CERTIFICATE_PROVIDED
- SSLCertificateProvided property keyword
SSL_CERTIFICATE_SOURCE
public static final String SSL_CERTIFICATE_SOURCE
- SSLCertificateSource property keyword
SSL_CERTIFICATE_URL
public static final String SSL_CERTIFICATE_URL
- SSLCertificateURL property keyword
SSL_CERTIFICATE_PASSWORD
public static final String SSL_CERTIFICATE_PASSWORD
- SSLCertificatePassword property keyword
SSL_CERTIFICATE_NAME
public static final String SSL_CERTIFICATE_NAME
- SSLCertificateName property keyword
SSL_CERTIFICATE_PROMPT_HOW_OFTEN
public static final String SSL_CERTIFICATE_PROMPT_HOW_OFTEN
- SSLCertificatePromptHowOften property keyword
SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
public static final String SSL_CERTIFICATE_PROMPT_BEFORE_CONNECT
- SSLCertificatePromptBeforeConnect property keyword
SSL_CERTIFICATE_HASH
public static final String SSL_CERTIFICATE_HASH
- SSLCertificateHash property keyword
SSL_CERTIFICATE_PROMPTED
public static final String SSL_CERTIFICATE_PROMPTED
- SSLCertificatePrompted property keyword
SSL_CERTIFICATE_REMEMBERED
public static final String SSL_CERTIFICATE_REMEMBERED
- SSLCertificateRemembered property keyword
CICS_SERVER_NAME
public static final String CICS_SERVER_NAME
- CICSServerName property keyword
CICS_GW_CODE_PAGE
public static final String CICS_GW_CODE_PAGE
- CICSGWCodePage property keyword
VT_TERMINAL_TYPE
public static final String VT_TERMINAL_TYPE
- VTTerminalType property keyword
VT_NEW_LINE
public static final String VT_NEW_LINE
- VTNewLine property keyword
VT_BACKSPACE
public static final String VT_BACKSPACE
- VTBackspace property keyword
VT_LOCAL_ECHO
public static final String VT_LOCAL_ECHO
- VTLocalEcho property keyword
VT_CURSOR
public static final String VT_CURSOR
- VTCursor property keyword
VT_KEYPAD
public static final String VT_KEYPAD
- VTKeypad property keyword
VT_AUTOWRAP
public static final String VT_AUTOWRAP
- VTAutowrap property keyword
VT_REVERSE_SCREEN
public static final String VT_REVERSE_SCREEN
- VTReverseScreen property keyword
VT_ANS_BACK_MSG
public static final String VT_ANS_BACK_MSG
- VTAnswerBackMsg property keyword
PRINT_DESTINATION
public static final String PRINT_DESTINATION
- printDestination property keyword
PRINT_FILE_NAME
public static final String PRINT_FILE_NAME
- printFileName property keyword
PRINT_SEPARATE_FILES
public static final String PRINT_SEPARATE_FILES
- separateFiles property keyword
PRINTER_NAME
public static final String PRINTER_NAME
- printerName property keyword
HISTORY
public static final String HISTORY
- History property keyword
HISTORY_SIZE
public static final String HISTORY_SIZE
- History size property keyword
NUM_FIELD_LOCK
public static final String NUM_FIELD_LOCK
- numericFieldLock property keyword
NUMERAL_SHAPE
public static final String NUMERAL_SHAPE
- numeralShape property keyword
TEXT_TYPE
public static final String TEXT_TYPE
- textType property keyword
TEXT_ORIENTATION
public static final String TEXT_ORIENTATION
- textOrientation property keyword
NOMINAL
public static final String NOMINAL
- numeralShape property value - nominal (bi-directional sessions only)
NATIONAL
public static final String NATIONAL
- numeralShape property value - national (bi-directional sessions only)
CONTEXTUAL
public static final String CONTEXTUAL
- numeralShape property value - contextual (bi-directional sessions only)
VISUAL
public static final String VISUAL
- textType property value - visual (bi-directional sessions only)
LOGICAL
public static final String LOGICAL
- textType property value - logical (bi-directional sessions only)
LEFT_TO_RIGHT
public static final String LEFT_TO_RIGHT
- textOrientation property value - left to right (bi-directional sessions only)
RIGHT_TO_LEFT
public static final String RIGHT_TO_LEFT
- textOrientation property value - right to left (bi-directional sessions only)
SYM_SWAP_ENABLED
public static final String SYM_SWAP_ENABLED
- symmetric swapping value - (Arabic 3270 sessions only)
NUM_SWAP_ENABLED
public static final String NUM_SWAP_ENABLED
- Numeric swapping value - (Arabic 3270 sessions only)
NUMERAL_SHAPE_DISP
public static final String NUMERAL_SHAPE_DISP
- numeralShapeDisp property keyword (VT bi-directional sessions only)
NOMINAL_DISP
public static final String NOMINAL_DISP
- numeralShapeDisp property values (VT bi-directional sessions only)
NATIONAL_DISP
public static final String NATIONAL_DISP
CONTEXTUAL_DISP
public static final String CONTEXTUAL_DISP
TEXT_TYPE_DISP
public static final String TEXT_TYPE_DISP
- textTypeDisp property keyword (VT bi-directional sessions only)
VISUAL_DISP
public static final String VISUAL_DISP
- textTypeDisp property values (VT bi-directional sessions only)
LOGICAL_DISP
public static final String LOGICAL_DISP
BIDI_MODE
public static final String BIDI_MODE
- BIDIMode property keyword (VT bi-directional sessions only)
BIDI_MODE_ON
public static final String BIDI_MODE_ON
- BIDIMode property values (VT bi-directional sessions only)
BIDI_MODE_OFF
public static final String BIDI_MODE_OFF
CURSOR_DIRECTION
public static final String CURSOR_DIRECTION
- cursorDirection property keyword (VT bi-directional sessions only)
CURSOR_LTR
public static final String CURSOR_LTR
- cursorDirection property values (VT bi-directional sessions only)
CURSOR_RTL
public static final String CURSOR_RTL
THAI_DISPLAY_MODE
public static final String THAI_DISPLAY_MODE
- ThaiDisplayMode property keyword
THAI_MODE_1
public static final String THAI_MODE_1
- Thai mode 1 property value - non composed mode (Thai session only)
THAI_MODE_2
public static final String THAI_MODE_2
- Thai mode 2 property value - composed mode (Thai session only)
THAI_MODE_3
public static final String THAI_MODE_3
- Thai mode 3 property value - composed mode with space alignment (Thai session only)
THAI_MODE_4
public static final String THAI_MODE_4
- Thai mode 4 property value - composed mode with EOF alignment (Thai session only)
THAI_MODE_5
public static final String THAI_MODE_5
- Thai mode 5 property value - composed mode with space and EOF alignment (Thai session only)
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 String SERVICE_MGR_HOST
- Service manager host property keyword
LUM_PORT
public static final String LUM_PORT
- Lum port property keyword
LUM_LICENSING
public static final String LUM_LICENSING
- Lum licensing property keyword
LUM_SERVER
public static final String LUM_SERVER
- LUM server property keyword
PASTE_FIELD_WRAP
public static final String PASTE_FIELD_WRAP
- Paste Field Wrap property keyword
PASTE_LINE_WRAP
public static final String PASTE_LINE_WRAP
- Paste word line wrap property keyword
PASTE_TO_TRIMMED_AREA
public static final String PASTE_TO_TRIMMED_AREA
- Paste To Trimmed area property keyword
PASTE_STOP_PRO_LINE
public static final String PASTE_STOP_PRO_LINE
- Paste Stop At Protected Line property keyword
PASTE_TAB_OPTIONS
public static final String PASTE_TAB_OPTIONS
- Paste Tab Options property keyword
PASTE_TAB_COLUMNS
public static final String PASTE_TAB_COLUMNS
- Paste Tab Columns property keyword
PASTE_TAB_SPACES
public static final String PASTE_TAB_SPACES
- Paste Tab Spaces property keyword
COPY_ONLY_IF_TRIMMED
public static final String COPY_ONLY_IF_TRIMMED
- Copy Only If Trimmed property keyword
TRIM_RECT_SIZING_HANDLES
public static final String TRIM_RECT_SIZING_HANDLES
- Trim Rectangle Sizing handles
TRIM_RECT_REMAIN_AFTER
public static final String TRIM_RECT_REMAIN_AFTER
- Trim Rectangle Remain After Edit
Session
public Session()
- Constructor which builds a Session Bean using the default property
values.
Session
public Session(Properties newProperties) throws PropertyVetoException
- Constructor which builds a Session Bean using the property values passed
in the Property object. Any properties which are not specified in the
Properties object are set to their default values.
- Parameters:
- newProperties - the new property settings for the Session bean.
- Throws: PropertyVetoException
- Fired if an incorrect property value
is given.
getSession
public Session getSession()
- Needed for 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.
stopCommunication
public void stopCommunication()
- Stops communications with the host.
isCommStarted
public boolean isCommStarted()
- Determines whether the connection with the host has been started.
A return value of true means that the connection has been started, but
the connection may not be ready for interaction.
- See Also:
- isCommReady, getCommStatus
getCommStatus
public int getCommStatus()
- Returns the status of communications with the host.
The possible values are
Constant |
Description |
CONNECTION_INIT |
Initial state (no connection with host)
|
CONNECTION_PND_INACTIVE |
Stop communications in progress |
CONNECTION_INACTIVE |
The connection is stopped |
CONNECTION_PND_ACTIVE |
Start communications in progress |
CONNECTION_ACTIVE |
Connection is established |
CONNECTION_READY |
Negotiations started |
- See Also:
- isCommReady, isCommStarted
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.
In Personal Communications, this property is not supported.
getDeviceName
public String getDeviceName()
- If isDeviceNameReady() is true, returns the device name in use, otherwise returns null.
This method is only valid for 3270 session.
isWorkstationIDReady
public boolean isWorkstationIDReady()
- Returns true if the workstation ID is ready, otherwise returns false.
This method is only valid for 5250 session.
In Personal Communications, this property is not supported.
sendKeys
public void sendKeys(SendKeyEvent evt)
- Handles SendKeyEvents sent to this Session Bean. This method is
necessary to implement the SendKeyListener interface.
- See Also:
- SendKeyListener, SendKeyEvent
addCommListener
public void addCommListener(CommListener l)
- Adds a CommEvent listener
- Parameters:
- l - an object that implements the CommListener interface
- See Also:
- CommListener, CommEvent
removeCommListener
public void removeCommListener(CommListener l)
- Removes a CommEvent listener
- Parameters:
- l - a previously registered CommListener object
- See Also:
- CommListener, CommEvent
addOIAListener
public void addOIAListener(OIAListener l)
- Adds an OIAEvent listener
- Parameters:
- l - an object that implements the OIAListener interface
- See Also:
- OIAListener, OIAEvent
removeOIAListener
public void removeOIAListener(OIAListener l)
- Remove an OIAEvent listener
- 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
- Parameters:
- l - an object that implements the TraceListener interface
- Overrides:
- addTraceListener in class HODBean
- See Also:
- TraceListener, TraceEvent
getProperties
public Properties getProperties()
- Returns the current properties for Session.
- Overrides:
- getProperties in class HODBean
setSessionType
public synchronized void setSessionType(String type) throws PropertyVetoException
- Sets the sessionType property. This indicates what type of host session
will be established. The possible values are:
Constant |
Description |
ECLSession.SESSION_TYPE_3270_STR |
3270 session |
ECLSession.SESSION_TYPE_5250_STR |
5250 session |
ECLSession.SESSION_TYPE_VT_STR |
VT session |
ECLSession.SESSION_TYPE_CICS_STR |
CICS session |
In Personal Communications, this property is ignored. The sessionType is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- type - the new sessionType
- Throws: PropertyVetoException
- Thrown if an invalid property value
is given.
- See Also:
- getSessionType, listSessionTypes
getSessionType
public String getSessionType()
- Returns the current setting of the sessionType property.
- See Also:
- setSessionType, listSessionTypes
listSessionTypes
public static Enumeration listSessionTypes()
- Returns a list of the valid sessionType values.
- See Also:
- setSessionType, listSessionTypes
setSessionName
public void setSessionName(String name) throws PropertyVetoException
- Sets the sessionName property.
- Parameters:
- name - The new session name.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSessionName
getSessionName
public String getSessionName()
- Returns the value of the sessionName property.
- See Also:
- setSessionName
setSessionID
public void setSessionID(String ID) throws PropertyVetoException
- Sets the sessionID property.
In Personal Communications, this property can be used to connect to an existing
Personal Communications session. Set the sessionID to the one character session
ID of the Personal Communications session (for example, "A") to connect to that
session.
- Parameters:
- ID - The new ID.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSessionID
getSessionID
public String getSessionID()
- Returns the value of the sessionID property.
- See Also:
- setSessionID
setHost
public void setHost(String host) throws PropertyVetoException
- Sets the name of host associated with this Session Bean. Communication
between this Session Bean and the host will be started after a call to
startCommunication.
In Personal Communications, the host property is the name of the
Personal Communications Workstation Profile (.WS file) that contains
the session configuration information. See the "IBM eNetwork Personal
Communications Version 4.3 for Windows 95, Windows 98 and Windows NT
Quick Beginnings", GC31-8679, for how to create a Personal Communications
Workstation Profile.
- Parameters:
- host - The name of the host.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getHost
getHost
public String getHost()
- Returns the current value of the host property.
- See Also:
- setHost
setPort
public void setPort(int port) throws PropertyVetoException
- Sets the port that will be used to communicate with the host.
In Personal Communications, this property is ignored. The port is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- port - The port number.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getPort
getPort
public int getPort()
- Returns the current value of the port property.
- See Also:
- setPort
setTNEnhanced
public void setTNEnhanced(boolean enhanced) throws PropertyVetoException
- Sets the TNEnhanced property. This method is only valid for 3270
session.
In Personal Communications, this property is ignored. Enhanced Telnet is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- enhanced - Enhanced session (TN3270E) parameters will be
negotiated when true.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isTNEnhanced
isTNEnhanced
public boolean isTNEnhanced()
- Returns the current value of the TNEnhanced property.
This method is only valid for 3270 session.
- See Also:
- setTNEnhanced
setSLPEnabled
public void setSLPEnabled(boolean slp) throws PropertyVetoException
- Sets the SLPEnabled property.
In Personal Communications, this property is ignored. The SLP Enabled is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- slp - Service Location Protocol will be used when true.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSLPEnabled
isSLPEnabled
public boolean isSLPEnabled()
- Returns the current value of the SLPEnabled property.
- See Also:
- setSLPEnabled
setSLPScope
public void setSLPScope(String scope) throws PropertyVetoException
- Sets the SLPScope property. This property is only valid when the
SLPEnabled property is true.
In Personal Communications, this property is ignored. The SLP Scope is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- scope - The scope which will be used during SLP
search for telnet services.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSLPScope, setSLPThisScopeOnly, setSLPEnabled
isValidSLPScope
public static boolean isValidSLPScope(String scope)
- Tests the given SLPScope for correct syntax. This method is called by
setSLPScope. If this method returns false setSLPScope will throw a
PropertyVetoException.
- Parameters:
- scope - The scope to be tested. Must be a string, 0 to 128 characters
long and contain letters, numbers. Scope may not contain
comma "," or colon ":" or forward slash "/".
- See Also:
- setSLPScope
getSLPScope
public String getSLPScope()
- Returns the current value of the SLPScope property.
- See Also:
- setSLPScope, setSLPThisScopeOnly, setSLPEnabled
setSLPThisScopeOnly
public void setSLPThisScopeOnly(boolean thisScopeOnly) throws PropertyVetoException
- Sets the SLPThisScopeOnly property. This property is only valid when the
SLPEnabled property is true and there is a SLPScope provided.
In Personal Communications, this property is ignored. This SLP property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- SLPThisScopeOnly - Session will be established only to a server which
supports the provided scope.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSLPThisScopeOnly, setSLPScope, setSLPEnabled
isSLPThisScopeOnly
public boolean isSLPThisScopeOnly()
- Returns the current value of the SLPThisScopeOnly property.
- See Also:
- setSLPThisScopeOnly, setSLPScope, setSLPEnabled
setSLPMaxWaitTime
public void setSLPMaxWaitTime(int maxWaitTime) throws PropertyVetoException
- Sets the SLPMaxWaitTime in milliseconds that will be used when waiting
for service response. This property is only valid when the
SLPEnabled property is true.
In Personal Communications, this property is ignored. This SLP property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- maxWaitTime - The maximum wait time for SLP directory agent and
service agent responses.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSLPMaxWaitTime, setSLPEnabled
getSLPMaxWaitTime
public int getSLPMaxWaitTime()
- Returns the current value of the SLPMaxWaitTime property.
- See Also:
- setSLPMaxWaitTime, setSLPEnabled
setSLPAS400Name
public void setSLPAS400Name(String as400Name) throws PropertyVetoException
- Sets the SLPAS400Name property. This property is only valid when the
SLPEnabled property is true.
In Personal Communications, this property is ignored. This SLP property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- as400name - The as400Name will be used during SLP
negotiation. The session will connect to the indicated AS/400.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSLPAS400Name, setSLPEnabled
isValidSLPAS400Name
public static boolean isValidSLPAS400Name(String as400Name)
- Tests the given SLPAS400Name for correct syntax. This method is called by
setSLPAS400Name. If this method returns false setSLPAS400Name will throw a
PropertyVetoException.
- Parameters:
- as400name - The as400Name to be tested. Must be a string in the
form, x.y, where x and y can each be 1 to 8 characters long
and include uppercase letters, numbers, "$", "@" or "#"
characters. Neither x nor y may begin with a number.
- See Also:
- setSLPAS400Name
getSLPAS400Name
public String getSLPAS400Name()
- Returns the current value of the SLPAS400Name property.
- See Also:
- setSLPAS400Name, setSLPEnabled
setLUName
public void setLUName(String luName) throws PropertyVetoException
- Sets the LUName property. This property is only valid when the
TNEnhanced property is true.
This method is only valid for 3270 session.
In Personal Communications, this property is ignored. LUName is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- luName - The LU name which will be used during enhanced
negotiation. Maximum length of LU name is 17 characters.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getLUName, setTNEnhanced
isValidLUName
public static boolean isValidLUName(String luName)
- Tests the given luName for correct syntax. This method is called by
setLUName. If this method returns false setLUName will throw a
PropertyVetoException.
- Parameters:
- luName - The LU name to be tested. Must be a string, 0 to 17
characters in length.
- See Also:
- setLUName
getLUName
public String getLUName()
- Returns the current value of the LUName property.
This method is only valid for 3270 session.
- See Also:
- setLUName, setTNEnhanced
setScreenSize
public void setScreenSize(String screenSize) throws PropertyVetoException
- Sets the screenSize property. The supported screen size changes based
on the sessionType property. The valid values are:
3270
Constant |
Description |
ECLSession.SESSION_PS_24X80_STR |
24 rows by 80 columns |
ECLSession.SESSION_PS_32X80_STR |
32 rows by 80 columns |
ECLSession.SESSION_PS_43X80_STR |
43 rows by 80 columns |
ECLSession.SESSION_PS_27X132_STR |
27 rows by 132 columns |
5250
Constant |
Description |
ECLSession.SESSION_PS_24X80_STR |
24 rows by 80 columns |
ECLSession.SESSION_PS_27X132_STR |
27 rows by 132 columns |
VT
Constant |
Description |
ECLSession.SESSION_PS_24X80_STR |
24 rows by 80 columns |
ECLSession.SESSION_PS_24X132_STR |
24 rows by 132 columns |
ECLSession.SESSION_PS_36X80_STR |
36 rows by 80 columns |
ECLSession.SESSION_PS_36X132_STR |
36 rows by 132 columns |
ECLSession.SESSION_PS_48X80_STR |
48 rows by 80 columns |
ECLSession.SESSION_PS_48X132_STR |
48 rows by 132 columns |
ECLSession.SESSION_PS_72X80_STR |
72 rows by 80 columns |
ECLSession.SESSION_PS_72X132_STR |
72 rows by 132 columns |
ECLSession.SESSION_PS_144X80_STR |
144 rows by 80 columns |
ECLSession.SESSION_PS_144X132_STR |
144 rows by 132 columns |
CICS
Constant |
Description |
ECLSession.SESSION_PS_24X80_STR |
24 rows by 80 columns |
In Personal Communications, this property is ignored. The screenSize is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- size - The new size.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getScreenSize, listScreenSizes, listScreenSizes
getScreenSize
public String getScreenSize()
- Returns the current value of the screenSize property.
- See Also:
- setScreenSize, listScreenSizes, listScreenSizes
listScreenSizes
public Enumeration listScreenSizes()
- Returns a list of the valid screenSize values for the current session
type.
- See Also:
- setScreenSize, getScreenSize
listScreenSizes
public static Enumeration listScreenSizes(String sessionType)
- Returns a list of the valid screenSize values for the specified
session type.
- See Also:
- setScreenSize, getScreenSize
setCodePage
public void setCodePage(String codePage) throws PropertyVetoException
- Sets the codePage property.
In Personal Communications, this property is ignored. The codepage is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- codePage - The new codepage.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getCodePage, listCodePages, listCodePages
getCodePage
public String getCodePage()
- Returns the current value of the codePage property.
- See Also:
- setCodePage, listCodePages, listCodePages
listCodePages
public Enumeration listCodePages()
- Returns a list of the valid codePage values for the current session
type.
- See Also:
- setCodePage, getCodePage
listCodePages
public static Enumeration listCodePages(String sessionType)
- Returns a list of the valid codePage values for the given session type.
- Parameters:
- sessionType - The session type for which to generate the list.
- See Also:
- setCodePage, getCodePage
setHostGraphics
public void setHostGraphics(boolean hostGraphics) throws PropertyVetoException
- Sets the hostGraphics property. This indicates whether to enable the
host graphics functionality. This property can only be enabled for
3270 sessions.
- Parameters:
- hostGraphics - The new value for the hostGraphics property
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isHostGraphics
isHostGraphics
public boolean isHostGraphics()
- Returns the value of the hostGraphics property.
- See Also:
- setHostGraphics
setGraphicsCellSize
public void setGraphicsCellSize(String cellSize) throws PropertyVetoException
- Sets the graphicsCellSize property.
- Parameters:
- cellSize - The new cell size
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getGraphicsCellSize, listGraphicsCellSizes
getGraphicsCellSize
public String getGraphicsCellSize()
- Returns the current value of the graphicsCellSize property.
- See Also:
- setGraphicsCellSize, listGraphicsCellSizes
listGraphicsCellSizes
public static Enumeration listGraphicsCellSizes()
- Returns a list of the valid graphicsCellSize values
- See Also:
- setGraphicsCellSize, getGraphicsCellSize
setENPTUI
public void setENPTUI(boolean enptui) throws PropertyVetoException
- Sets the enptui property. This indicates whether to enable the
ENPTUI functionality. This property can only be enabled for
5250 sessions.
In Personal Communications, this property is ignored. ENPTUI is always
enabled in Personal Communications.
- Parameters:
- enptui - The new value for the enptui property
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isENPTUI
isENPTUI
public boolean isENPTUI()
- Returns the value of the enptui property.
- See Also:
- setENPTUI
setAutoConnect
public void setAutoConnect(boolean autoConnect) throws PropertyVetoException
- Sets the autoConnect property. This indicates whether to automatically
connect to the host when the host property is set.
- Parameters:
- autoConnect - The new value for the autoConnect property
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isAutoConnect
isAutoConnect
public boolean isAutoConnect()
- Returns the value of the autoConnect property.
- See Also:
- setAutoConnect
setAutoReconnect
public void setAutoReconnect(boolean autoReconnect) throws PropertyVetoException
- Sets the autoReconnect property. This indicates whether to automatically
connect to the host after the host connection has been dropped.
In Personal Communications, this property is ignored. AutoReconnect is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- autoReconnect - The new value for the autoReconnect property
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isAutoReconnect
isAutoReconnect
public boolean isAutoReconnect()
- Returns the current value of the autoReconnect property.
- See Also:
- setAutoReconnect
setSSL
public void setSSL(boolean ssl) throws PropertyVetoException
- Sets the SSL property of Session. This indicates whether to use the
Secure Socket Layer (SSL) feature.
In Personal Communications, this property is ignored. SSL is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- SSL - When true, SSL encryption will be enabled.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSL, ssl
isSSL
public boolean isSSL()
- Returns the value of the SSL property.
- See Also:
- setSSL, ssl
setSSLTelnetNegotiated
public void setSSLTelnetNegotiated(boolean TNnegotiated) throws PropertyVetoException
- Sets the SSLTelnetNegotiated property of Session. This property should only
be set to true if connecting to a Telnet server which supports IETF Internet-Draft
"TLS-based Telnet Security." This Internet-Draft defines the protocol for
doing the SSL Handshake over a Telnet connection. The SSL property should also
be set to true.
In Personal Communications, this property is ignored.
- Parameters:
- TNnegotiated - Determines if SSL will be negotiated on the Telnet connection.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLTelnetNegotiated, setSSL, sslTelnetNegotiated
isSSLTelnetNegotiated
public boolean isSSLTelnetNegotiated()
- Returns the current value of the SSLTelnetNegotiated property.
- See Also:
- setSSLTelnetNegotiated, setSSL, sslTelnetNegotiated
setSSLServerAuthentication
public void setSSLServerAuthentication(boolean authentication) throws PropertyVetoException
- Sets the SSLServerAuthentication property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- authentication - Whether or not SSL server authentication will
be enabled.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLServerAuthentication, setSSL, sslServerAuthentication
isSSLServerAuthentication
public boolean isSSLServerAuthentication()
- Returns the current value of the SSLServerAuthentication property.
- See Also:
- setSSLServerAuthentication, setSSL, sslServerAuthentication
setSSLBrowserKeyringAdded
public void setSSLBrowserKeyringAdded(boolean addKeyring) throws PropertyVetoException
- Sets the SSLBrowserKeyringAdded property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- addKeyring - Whether or not the browser keyring will be added to the
HOD client keyring
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLBrowserKeyringAdded, setSSL, sslBrowserKeyringAdded
isSSLBrowserKeyringAdded
public boolean isSSLBrowserKeyringAdded()
- Returns the current value of the SSLBrowserKeyringAdded property.
- See Also:
- setSSLBrowserKeyringAdded, setSSL, sslBrowserKeyringAdded
setSSLCertificateProvided
public void setSSLCertificateProvided(boolean hasCert) throws PropertyVetoException
- Sets the SSLCertificateProvided property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- certificateprovided - Whether or not client has a certificate.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLCertificateProvided, setSSL, sslCertificateProvided
isSSLCertificateProvided
public boolean isSSLCertificateProvided()
- Returns the current value of the SSLCertificateProvided property.
- See Also:
- setSSLCertificateProvided, setSSL, sslCertificateProvided
setSSLCertificateSource
public void setSSLCertificateSource(String src) throws PropertyVetoException
- Sets the SSLCertificateSource property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- src - where the certificate is stored
(ECLSession.SESSION_SSL_CERTIFICATE_IN_URL or
ECLSession.SESSION_SSL_CERTIFICATE_IN_CSP)
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSSLCertificateSource, setSSL, sslCertificateSource
getSSLCertificateSource
public String getSSLCertificateSource()
- Returns the current value of the SSLCertificateSource property.
- See Also:
- setSSLCertificateSource, setSSL, sslCertificateSource
setSSLCertificateURL
public void setSSLCertificateURL(String url) throws PropertyVetoException
- Sets the SSLCertificateURL property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- url - URL of client certificate
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSSLCertificateURL, setSSL, sslCertificateURL
getSSLCertificateURL
public String getSSLCertificateURL()
- Returns the current value of the SSLCertificateURL property.
- See Also:
- setSSLCertificateURL, setSSL, sslCertificateURL
setSSLCertificatePassword
public void setSSLCertificatePassword(String password) throws PropertyVetoException
- Sets the SSLCertificatePassword property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- password - password of client certificate
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- setSSL, sslCertificatePassword
setSSLCertificateName
public void setSSLCertificateName(String name) throws PropertyVetoException
- Sets the SSLCertificateName property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- name - name of the certificate, or "" for any trusted by the server
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSSLCertificateName, setSSL, sslCertificateName
getSSLCertificateName
public String getSSLCertificateName()
- Returns the current value of the SSLCertificateName property.
- See Also:
- setSSLCertificateName, setSSL, sslCertificateName
setSSLCertificatePromptHowOften
public void setSSLCertificatePromptHowOften(String howOften) throws PropertyVetoException
- Sets the SSLCertificatePromptHowOften property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- howOften - how often to prompt
(ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_EACH_CONNECTION or
ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECTION or
ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE)
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSSLCertificatePromptHowOften, setSSL, sslCertificatePromptHowOften
getSSLCertificatePromptHowOften
public String getSSLCertificatePromptHowOften()
- Returns the current value of the SSLCertificatePromptHowOften property.
- See Also:
- setSSLCertificatePromptHowOften, setSSL, sslCertificateName
setSSLCertificatePromptBeforeConnect
public void setSSLCertificatePromptBeforeConnect(boolean before) throws PropertyVetoException
- Sets the SSLCertificatePromptBeforeConnect property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- before - Whether the client should be prompted before connecting to the server
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLCertificatePromptBeforeConnect, setSSL, sslCertificateRemembered
isSSLCertificatePromptBeforeConnect
public boolean isSSLCertificatePromptBeforeConnect()
- Returns the current value of the SSLCertificatePromptBeforeConnect property.
- See Also:
- setSSLCertificatePromptBeforeConnect, setSSL, sslCertificateRemembered
setSSLCertificateHash
public void setSSLCertificateHash(String hash) throws PropertyVetoException
- Sets the SSLCertificateHash property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- hash - hash of the certificate
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getSSLCertificateHash, setSSL, sslCertificateHash
getSSLCertificateHash
public String getSSLCertificateHash()
- Returns the current value of the SSLCertificateHash property.
- See Also:
- setSSLCertificateHash, setSSL, sslCertificateHash
setSSLCertificatePrompted
public void setSSLCertificatePrompted(boolean prompted) throws PropertyVetoException
- Sets the SSLCertificatePrompted property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- prompted - Whether or not the user has been prompted for this connection
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLCertificatePrompted, setSSL, sslCertificatePrompted
isSSLCertificatePrompted
public boolean isSSLCertificatePrompted()
- Returns the current value of the SSLCertificatePrompted property.
- See Also:
- setSSLCertificatePrompted, setSSL, sslCertificatePrompted
setSSLCertificateRemembered
public void setSSLCertificateRemembered(boolean remembered) throws PropertyVetoException
- Sets the SSLCertificateRemembered property of Session
In Personal Communications, this property is ignored. This SSL property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- remembered - true sets SSLCertificatePromptHowOften to FIRST_CONNECT
false sets SSLCertificatrePromptHowOften to EACH_CONNECT
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSSLCertificateRemembered, setSSL, sslCertificateRemembered
isSSLCertificateRemembered
public boolean isSSLCertificateRemembered()
- Returns the current value of the SSLCertificateRemembered property.
- See Also:
- setSSLCertificateRemembered, setSSL, sslCertificateRemembered
setCICSServerName
public void setCICSServerName(String server) throws PropertyVetoException
- Sets the CICSServerName property.
In Personal Communications, this property is ignored. The CICS properties are
controlled by the settings in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- server - The new CICS server.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getCICSServerName
getCICSServerName
public String getCICSServerName()
- Returns the current value of the CICSServerName property.
- See Also:
- setCICSServerName
setCICSGWCodePage
public void setCICSGWCodePage(String codePage) throws PropertyVetoException
- Sets the CICSGWCodepage property.
In Personal Communications, this property is ignored. The CICS properties are
controlled by the settings in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- codePage - The new CICS gateway codepage.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getCICSGWCodePage, listCICSGWCodePages
getCICSGWCodePage
public String getCICSGWCodePage()
- Returns the current value of the CICSGWCodepage property.
- See Also:
- setCICSGWCodePage, listCICSGWCodePages
listCICSGWCodePages
public static Enumeration listCICSGWCodePages()
- Returns the list of valid CICSGWCodePage values.
- See Also:
- setCICSGWCodePage, getCICSGWCodePage
setNumericFieldLock
public void setNumericFieldLock(boolean lock) throws PropertyVetoException
- Sets the Numeric Field Lock property of Session. When true, only
characters 0 through 9, -, +, period, and comma are allowed in fields
defined by a host application as numeric. This property is valid for
3270 and CICS sessions only.
In Personal Communications, this property is not supported.
- Parameters:
- lock - Whether or not Numeric Field Lock will be enabled.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isNumericFieldLock
isNumericFieldLock
public boolean isNumericFieldLock()
- Returns the value of the Numeric Field Lock property.
- See Also:
- setNumericFieldLock
setVTTerminalType
public void setVTTerminalType(String terminalType) throws PropertyVetoException
- Sets the VTTerminalType property. This property applies only to VT
sessions. The valid values are:
Constant |
Description |
ECLSession.SESSION_VT_TERMINAL_TYPE_VT52 |
VT52 |
ECLSession.SESSION_VT_TERMINAL_TYPE_VT100 |
VT100 |
ECLSession.SESSION_VT_TERMINAL_TYPE_VT420_7 |
VT420 Model 7 |
ECLSession.SESSION_VT_TERMINAL_TYPE_VT420_8 |
VT420 Model 8 |
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- terminalType - The VT terminal type.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getVTTerminalType, listVTTerminalTypes
getVTTerminalType
public String getVTTerminalType()
- Returns the current value of the VTTerminalType property.
- See Also:
- setVTTerminalType, listVTTerminalTypes
listVTTerminalTypes
public static Enumeration listVTTerminalTypes()
- Returns a list of the valid VTTerminalTypes.
- See Also:
- setVTTerminalType, getVTTerminalType
setVTAnswerBackMsg
public void setVTAnswerBackMsg(String ansbackmsg) throws PropertyVetoException
- Sets the VTAnswerBackMsg property. This property only applies to VT sessions.
- Parameters:
- ansbackmsg - A string which is returned to the remote VT server
in response to an ENQ command (0x05)
This sting can be null or a user defined value.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getVTAnswerBackMsg
getVTAnswerBackMsg
public String getVTAnswerBackMsg()
- Returns the current value of the VTAnswerBackMsg property. This property
only applies to VT sessions.
- See Also:
- setVTAnswerBackMsg
setVTNewLine
public void setVTNewLine(boolean CROnly) throws PropertyVetoException
- Sets the VTNewLine property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- CROnly - true causes carriage return to be interpreted
as CR only, false causes it to be interpreted as
a CR and LF.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTNewLine
isVTNewLine
public boolean isVTNewLine()
- Returns the current value of the VTNewLine property.
- See Also:
- setVTNewLine
setVTBackspace
public void setVTBackspace(boolean backspace) throws PropertyVetoException
- Sets the VTBackspace property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- backspace - true causes normal backspace behavior, false causes
it to delete the character under the cursor.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTBackspace
setHistory
public void setHistory(boolean history) throws PropertyVetoException
- Sets the History property. This property currently only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- history - true causes history log to be kept, false will not
keep history log information.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isHistory
isHistory
public boolean isHistory()
setHistorySize
public void setHistorySize(String size) throws PropertyVetoException
- Sets the History size property. This property currently only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- history - is determines the size of the internal planes used to store
history log information.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isHistory
getHistorySize
public String getHistorySize()
listHistorySizes
public Enumeration listHistorySizes()
- Returns a list of the valid History size values for the current session
type.
- See Also:
- setHistorySize, getHistorySize
listHistorySizes
public Enumeration listHistorySizes(String sessionType)
setPrintDestination
public void setPrintDestination(boolean printer) throws PropertyVetoException
- Sets the printDestination property. This property only applies to HOD VT sessions.
- Parameters:
- printer - true causes print job to be sent to a printer device.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isPrintDestination
isPrintDestination
public boolean isPrintDestination()
- Returns the current value of the printDestination property.
- See Also:
- setPrintDestination
setSeparateFiles
public void setSeparateFiles(boolean separate) throws PropertyVetoException
- Sets the separateFiles property. This property only applies to HOD VT sessions.
- Parameters:
- true - causes print jobs to be saved in separate files.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isSeparateFiles
isSeparateFiles
public boolean isSeparateFiles()
- Returns the current value of the separateFiles property.
- See Also:
- setSeparateFiles
setPrintFileName
public void setPrintFileName(String fileName) throws PropertyVetoException
- Sets the printFileName property. This property only applies to HOD VT sessions.
- Parameters:
- fileName - is the name to be assigned to the print file.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getPrintFileName
getPrintFileName
public String getPrintFileName()
- Returns the current value of the printFileName property.
- See Also:
- setPrintFileName
setPrinterName
public void setPrinterName(String printerName) throws PropertyVetoException
- Sets the printerName property. This property only applies to HOD VT sessions.
- Parameters:
- printerName - is the name of the destination printer device.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getPrinterName
getPrinterName
public String getPrinterName()
- Returns the current value of the printerName property.
- See Also:
- setPrinterName
setWorkstationID
public void setWorkstationID(String workstationID) throws PropertyVetoException
- Sets the workstationID property.
In Personal Communications, this property is ignored. WorkstationID is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- workstation - ID The workstation ID that is used during enhanced
negotiation for 5250.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getWorkstationID
isValidWorkstationID
public static boolean isValidWorkstationID(String workstationID)
- Tests the given workstationID for correct syntax. This method is called by
setWorkstationID. If this method returns false, setWorkstationID throws a
PropertyVetoException.
- Parameters:
- workstation - ID The workstation ID to be tested. Must be a string,
0 to 10 characters long and contain letters, numbers,
or ".", "_", "$", "@" or "#" characters. Must not
start with a number, "." or "_".
- See Also:
- setWorkstationID
getWorkstationID
public String getWorkstationID()
- Returns the current value of the workstation ID property.
This method is only valid for 5250 session.
- See Also:
- setWorkstationID
isVTBackspace
public boolean isVTBackspace()
- Returns the value of the VTBackspace property.
- Returns:
- the current setting of the VTBackspace property
- See Also:
- setVTBackspace
setVTLocalEcho
public void setVTLocalEcho(boolean localEcho) throws PropertyVetoException
- Sets the VTLocalEcho property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- localEcho - true causes local echo to be on, false
causes it to be off.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTLocalEcho
isVTLocalEcho
public boolean isVTLocalEcho()
- Returns the value of the VTLocalEcho.
- Returns:
- the current setting of the VTLocalEcho property
- See Also:
- setVTNewLine
setVTCursor
public void setVTCursor(boolean application) throws PropertyVetoException
- Sets the VTCursor property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- application - true results in application-controlled cursor behavior,
false results in normal cursor behavior.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTCursor
isVTCursor
public boolean isVTCursor()
- Returns the value of the VTCursor property.
- Returns:
- the current setting of the VTCursor property
- See Also:
- setVTCursor
setVTKeypad
public void setVTKeypad(boolean application) throws PropertyVetoException
- Sets the VTKeypad property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- application - true causes application keypad control, false
causes normal keypad behavior.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTKeypad
isVTKeypad
public boolean isVTKeypad()
- Returns the value of the VTKeypad property.
- Returns:
- the current setting of the VTKeypad property
- See Also:
- setVTKeypad
setVTAutowrap
public void setVTAutowrap(boolean autowrap) throws PropertyVetoException
- Sets the VTAutowrap property. This property only applies to VT sessions.
In Personal Communications, this property is ignored. This VT property is
controlled by the setting in the Personal Communications Workstation Profile
(.WS file) used for this Session.
- Parameters:
- autowrap - true enables autowrap, false disables it.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTAutowrap
isVTAutowrap
public boolean isVTAutowrap()
- Returns the value of the VTAutowrap property.
- Returns:
- the current setting of the VTAutowrap property
- See Also:
- setVTAutowrap
setVTReverseScreen
public void setVTReverseScreen(boolean reverse) throws PropertyVetoException
- Sets the VTReverseScreen property. This property only applies to VT sessions.
This VT property is controlled by the setting in the Personal Communications
Workstation Profile (.WS file) used for this Session.
- Parameters:
- reverse - true sets reverse video, false sets normal video.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isVTReverseScreen
isVTReverseScreen
public boolean isVTReverseScreen()
- Returns the value of the VTReverseScreen property.
- Returns:
- the current setting of the VTReverseScreen property
- See Also:
- setVTReverseScreen
setPasteFieldWrap
public void setPasteFieldWrap(boolean pasteFieldWrap) throws PropertyVetoException
- Sets the pasteFieldWrap property. This property does not apply to VT sessions.
- Parameters:
- pasteFieldWrap - true sets wrap on field, false sets normal wrap
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isPasteFieldWrap
isPasteFieldWrap
public boolean isPasteFieldWrap()
- Returns the value of the pasteFieldWrap property.
- Returns:
- the current setting of the pasteFieldWrap property
- See Also:
- setPasteFieldWrap
setPasteLineWrap
public void setPasteLineWrap(boolean pasteLineWrap) throws PropertyVetoException
- Sets the pasteLineWrap property.
- Parameters:
- pasteLineWrap - true sets wrap on field, false sets normal wrap
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isPasteLineWrap
isPasteLineWrap
public boolean isPasteLineWrap()
- Returns the value of the pasteLineWrap property.
- Returns:
- the current setting of the pasteLineWrap property
- See Also:
- setPasteLineWrap
setPasteToTrimmedArea
public void setPasteToTrimmedArea(boolean pasteToTrimmedArea) throws PropertyVetoException
- Sets the pasteToTrimmedArea property. This property does not apply to VT sessions.
- Parameters:
- pasteToTrimmedArea - true sets paste to paste into trimmed area if defined, false sets normal paste
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isPasteToTrimmedArea
isPasteToTrimmedArea
public boolean isPasteToTrimmedArea()
- Returns the value of the pasteToTrimmedArea property.
- Returns:
- the current setting of the pasteToTrimmedArea property
- See Also:
- setPasteToTrimmedArea
setPasteStopAtProtectedLine
public void setPasteStopAtProtectedLine(boolean pasteStopAtProtectedLine) throws PropertyVetoException
- Sets the pasteStopAtProtectedLine property. This property does not apply to VT sessions.
- Parameters:
- pasteStopAtProtectedLine - true sets stop on paste onto protected line, false sets normal paste
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isPasteStopAtProtectedLine
isPasteStopAtProtectedLine
public boolean isPasteStopAtProtectedLine()
- Returns the value of the pasteStopAtProtectedLine property.
- Returns:
- the current setting of the pasteStopAtProtectedLine property
- See Also:
- setPasteStopAtProtectedLine
setPasteTabOptions
public void setPasteTabOptions(String pasteTabOptions) throws PropertyVetoException
- Sets the pasteTabOptions property.
- Parameters:
- ns - Can be one of the following string constants:
ECLSession.SESSION_PASTE_TAB_OPTIONS_COLUMNS_STR
ECLSession.SESSION_PASTE_TAB_OPTIONS_SPACES_STR
ECLSession.SESSION_PASTE_TAB_OPTIONS_FIELDWRAP_STR
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
- See Also:
- getPasteTabOptions, listPasteTabOptions
getPasteTabOptions
public String getPasteTabOptions()
- Returns the current setting of the pasteOptionsType property.
- See Also:
- setPasteTabOptions, listPasteTabOptions
listPasteTabOptions
public static Enumeration listPasteTabOptions()
- Returns a list of the valid pasteOptionsType values.
- See Also:
- setPasteTabOptions, getPasteTabOptions
setPasteTabColumns
public void setPasteTabColumns(int pasteTabColumns) throws PropertyVetoException
- Sets the pasteTabColumns to set the number of columns represented by
a tab. If this option is active, when tab is encountered, the input
skips to the column that is a multiple of this setting
- Parameters:
- pasteTabColumns - the size of the tab in columns
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getPasteTabColumns
getPasteTabColumns
public int getPasteTabColumns()
- Returns the current value of the pasteTabColumns property.
- See Also:
- setPasteTabColumns
setPasteTabSpaces
public void setPasteTabSpaces(int pasteTabSpaces) throws PropertyVetoException
- Sets the pasteTabSpaces to set the number of spaces represented by
a tab. If this option is active, when tab is encountered, the input
skips the number of spaces specified in this setting
- Parameters:
- pasteTabSpaces - The number of spaces to advance for a tab
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- getPasteTabSpaces
getPasteTabSpaces
public int getPasteTabSpaces()
- Returns the current value of the pasteTabSpaces property.
- See Also:
- setPasteTabSpaces
setTrimRectSizingHandles
public void setTrimRectSizingHandles(boolean trimRectSizingHandles) throws PropertyVetoException
- Sets the trimRectSizingHandles property.
- Parameters:
- trimRectSizingHandles - true sets trim rec sizeable, false sets unsizeable
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isTrimRectSizingHandles
isTrimRectSizingHandles
public boolean isTrimRectSizingHandles()
- Returns the value of the trimRectSizingHandles property.
- Returns:
- the current setting of the trimRectSizingHandles property
- See Also:
- setTrimRectSizingHandles
setTrimRectRemainAfterEdit
public void setTrimRectRemainAfterEdit(boolean trimRectRemainAfterEdit) throws PropertyVetoException
- Sets the trimRectRemainAfterEdit property.
- Parameters:
- trimRectRemainAfterEdit - true sets trim rec remain after cut/copy/paste, false does not remain
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isTrimRectRemainAfterEdit
isTrimRectRemainAfterEdit
public boolean isTrimRectRemainAfterEdit()
- Returns the value of the trimRectRemainAfterEdit property.
- Returns:
- the current setting of the trimRectRemainAfterEdit property
- See Also:
- setTrimRectRemainAfterEdit
setCopyOnlyIfTrimmed
public void setCopyOnlyIfTrimmed(boolean copyOnlyIfTrimmed) throws PropertyVetoException
- Sets the copyOnlyIfTrimmed property.
- Parameters:
- copyOnlyIfTrimmed - true sets copy error when no trim, false copy entire screen when no trim
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value.
- See Also:
- isCopyOnlyIfTrimmed
isCopyOnlyIfTrimmed
public boolean isCopyOnlyIfTrimmed()
- Returns the value of the copyOnlyIfTrimmed property.
- Returns:
- the current setting of the copyOnlyIfTrimmed property
- See Also:
- setCopyOnlyIfTrimmed
getECLSession
public ECLSession getECLSession()
- Returns the ECLSession object associated with this Session. This is
useful if you'd like to use the Host Access Class Library (HACL) API
to interact with the host.
defaults
public static Properties defaults()
- Returns a Properties object containing the default properties and their
values for this Session Bean.
setNumeralShape
public void setNumeralShape(String ns) throws PropertyVetoException
- Sets the numeralShape property. This property applies to bi-directional
Sessions only.
In Personal Communications, this property is not supported.
- Parameters:
- ns - Can be one of the following string constants:
Session.NOMINAL, Session.NATIONAL, or Session.CONTEXTUAL.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
getNumeralShape
public String getNumeralShape()
- Returns the current value of the numeralShape property.
- See Also:
- setNumeralShape
listNumeralShapes
public static Enumeration listNumeralShapes()
- Returns the list of valid numeralShape values.
- See Also:
- setNumeralShape
setTextType
public void setTextType(String tt) throws PropertyVetoException
- Sets the textType property. This property applies to bi-directional
Sessions only.
In Personal Communications, this property is not supported.
- Parameters:
- tt - Can be one of the following string constants:
Session.VISUAL or Session.LOGICAL.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
getTextType
public String getTextType()
- Returns the current value of the textType property.
- See Also:
- setTextType
listTextTypes
public static Enumeration listTextTypes()
- Returns the list of valid textType values.
- See Also:
- setTextType
setTextOrientation
public void setTextOrientation(String to) throws PropertyVetoException
- Sets the textOrientation property. This property applies to bi-directional
Sessions only.
In Personal Communications, this property is not supported.
- Parameters:
- to - Can be one of the following string constants:
Session.LEFT_TO_RIGHT or Session.RIGHT_TO_LEFT.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value or if an
incorrect value is specified.
getTextOrientation
public String getTextOrientation()
- Returns the current value of the textOrientation property.
- See Also:
- setTextOrientation
listTextOrientations
public static Enumeration listTextOrientations()
- Returns a list of the valid textOrientation values.
- See Also:
- setTextOrientation
setThaiDisplayMode
public void setThaiDisplayMode(int mode) throws PropertyVetoException
- Set Thai display mode property. This property applies to Thai
Session only.
In Personal Communications, this property is not supported.
- Parameters:
- mode - Thai display mode.
- Throws: PropertyVetoException
- Thrown if a VetoableChangeListener
vetoes the new value
- See Also:
- getThaiDisplayMode
getThaiDisplayMode
public int getThaiDisplayMode()
- Returns the current value of the ThaiDisplayMode property
- See Also:
- setThaiDisplayMode
listThaiDisplayModes
public static Enumeration listThaiDisplayModes()
- Returns the list of valid ThaiDisplayMode values.
- See Also:
- setThaiDisplayMode
getTraceName
public String getTraceName()
- Returns a trace identifier for this bean
- Overrides:
- getTraceName in class HODBean
setBIDIMode
public void setBIDIMode(String to) throws PropertyVetoException
getBIDIMode
public String getBIDIMode()
setTextTypeDisp
public void setTextTypeDisp(String to) throws PropertyVetoException
getTextTypeDisp
public String getTextTypeDisp()
setCursorDirection
public void setCursorDirection(String to) throws PropertyVetoException
getCursorDirection
public String getCursorDirection()
setNumeralShapeDisp
public void setNumeralShapeDisp(String to) throws PropertyVetoException
getNumeralShapeDisp
public String getNumeralShapeDisp()
listTextTypesDisp
public static Enumeration listTextTypesDisp()
listCursorDirections
public static Enumeration listCursorDirections()
listBIDIModes
public static Enumeration listBIDIModes()
listNumeralShapesDisp
public static Enumeration listNumeralShapesDisp()
setLUMPort
public void setLUMPort(int PortNumber) throws PropertyVetoException
- Sets the LUMPort property.
In Personal Communications, this property is not supported.
- Parameters:
- PortNumber - Port number for the LUM server
getLUMPort
public int getLUMPort()
- Returns the LUM server port number
setServiceMgrHost
public void setServiceMgrHost(String ServerMgrHost) throws PropertyVetoException
- Sets the HOD server property.
In Personal Communications, this property is not supported.
- Parameters:
- ServerMgrHost - name for the HOD server
getServiceMgrHost
public String getServiceMgrHost()
- Returns the HOD server
setLUMLicensing
public void setLUMLicensing(String servertype) throws PropertyVetoException
- Sets the license method to either LUM or HOD.
In Personal Communications, this property is not supported.
- Parameters:
- servertype - Set types for the LUM or HOD Licensing
getLUMLicensing
public String getLUMLicensing()
- Returns the License method type
listLUMLicensing
public static Enumeration listLUMLicensing()
setLUMServer
public void setLUMServer(String LUMServer) throws PropertyVetoException
- Sets the LUM server property.
In Personal Communications, this property is not supported.
- Parameters:
- LumServer - name for the LUM server
getLUMServer
public String getLUMServer()
- Returns the LUM server
setSymmetricSwapEnabled
public void setSymmetricSwapEnabled(boolean value) throws PropertyVetoException
- Sets the Symmetric swapping property. This property applies (Arabic 3270 sessions only)
In Personal Communications, this property is not supported.
isSymmetricSwapEnabled
public boolean isSymmetricSwapEnabled()
- Returns the current value of the Symmetric Swapping property.
- See Also:
- setSymmetricSwapEnabled
setNumericSwapEnabled
public void setNumericSwapEnabled(boolean value) throws PropertyVetoException
- Sets the Numeric swapping property. This property applies (Arabic 3270 sessions only)
In Personal Communications, this property is not supported.
isNumericSwapEnabled
public boolean isNumericSwapEnabled()
- Returns the current value of the Numeric Swapping property.
- See Also:
- setNumericSwapEnabled
getSecurityInfoIntf
public Object getSecurityInfoIntf(Frame frame)
All Packages Class Hierarchy This Package Previous Next Index