The ECLSession class can be used to establish a connection with a host.
This class defines the behavior and characteristics of the session with
the host. It can be constructed with a Properties object which contains
all the configuration information for the session. Configurable information
includes 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.
Once an ECLSession object has been constructed, you can get instances
of ECLPS (presentation space), ECLOIA (operator information area), and
ECLXfer (file transfer) from the ECLSession instance.
GetXfer()
Gets the ECLXfer associated with the session.
boolean
isHTMLDDS()
Returns the value of the HTMLDDS property.
void
setHTMLDDS(boolean val)
Sets the HTMLDDS property.
void
ShowPSDebugger(boolean show)
Shows or hides the PS Debugger.
void
StartCommunicationWithBlocking(long timeout)
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
void
StartCommunicationWithBlocking(long timeout,
ECLScreenDesc scrndesc)
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
void
StartCommunicationWithBlocking(long timeout,
java.lang.String[] scrndescstrings)
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
Methods inherited from class com.ibm.eNetwork.ECL.ECLConnection
public ECLSession(java.util.Properties configData)
throws ECLErr
Creates and initializes a virtual emulation session with a host.
Parameters:
configData - java.util.Properties object containing
keyword and value pairs which control the
behavior of the new session. The keys
are always instances of java.lang.String.
The values are instances of java.lang.String
unless otherwise specified.
The table below shows the valid keys and values. The required
parameters are denoted with an '*'.
Key
Common Properties for All Session Types
SESSION_HOST * - The TCP/IP name or address of a host to which the session will be established
This value must be a valid TCP/IP host name or address. For CICS sessions, it should be the host name or address of the CICS Gateway for Java.
SESSION_HOST_PORT - Host port number
The TCP/IP port used by the host or CICS gateway (default for 3270, 5250, or VT sessions = "23", default for CICS sessions = "2006").
SESSION_APPLET * - Instance of java.applet.Applet when the session is created within the context of a browser.
The Applet instance is a required parameter when the session is
created within the context of a browser. The Applet parameter is needed to
load messages and display help text.
SESSION_NAME - Name used to identify the session
User defined session name. This value can be one or more characters. (default = "A")
SESSION_TYPE - Type of session to establish
The value can be one of the following:
Constant
Value
Session Type
SESSION_TYPE_3270_STR
"1"
3270 (default)
SESSION_TYPE_5250_STR
"2"
5250
SESSION_TYPE_VT_STR
"3"
VT
SESSION_TYPE_CICS_STR
"4"
CICS
SESSION_TYPE_3270_PRT_STR
"5"
3270 Printer
SESSION_TN_ENHANCED - Determines whether the session will use enhanced telnet features (valid only for 3270 sessions)
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Enables enhanced telnet negotiation
SESSION_OFF
"false"
Disables enhanced telnet negotiation (default)
SESSION_LU_NAME - The LU name or LU pool name
Must be a valid LU name or LU pool name. This parameter only has
significance when the SESSION_TN_ENHANCED parameter is ON.
SESSION_WORKSTATION_ID - The Workstation ID
Must be a valid Workstation ID. This parameter only has
significance when the AS/400 supports the enhanced device negotiation.
SESSION_PS_SIZE - Presentation space dimensions
The value can be one of the following:
Valid for
Constant
Value
Size (rows x columns)
3270
5250
VT
CICS
SESSION_PS_24X80_STR
"2"
24x80 (default)
X
X
X
X
SESSION_PS_32X80_STR
"3"
32x80
X
X
SESSION_PS_43X80_STR
"4"
43x80
X
X
SESSION_PS_27X132_STR
"5"
27x132
X
X
X
SESSION_PS_24X132_STR
"6"
24x132
X
SESSION_PS_62X160_STR
"7"
62x160
X
SESSION_AUTOCONNECT - Determines whether the session will autoconnect when constructed
The value can be one of the following:
Constant
Value
Description
SESSION_OFF
"false"
Do not autoconnect (default)
SESSION_ON
"true"
Autoconnect
SESSION_AUTORECONNECT - Determines whether the session will autoreconnect when the
connection goes down.
The value can be one of the following:
Constant
Value
Description
SESSION_OFF
"false"
Do not autoreconnect (default)
SESSION_ON
"true"
Autoreconnect
SESSION_ENPTUI - Determines whether ENPTUI will be enabled (valid only for 5250 sessions)
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Enable ENPTUI
SESSION_OFF
"false"
Do not enable ENPTUI (default)
SESSION_QUIETMODE - Determines whether any sound will be made when the
session connects to the host.
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Don't make a sound when connected
SESSION_OFF
"false"
Make a sound (usually a beep) when a connection is made to the host (default)
SESSION_PROXY_TYPE - Specifies the type proxy (SOCKS or HTTP) and in the case of SOCKS, the version.
The value can be one of the following strings:
Constant
Description
SESSION_PROXY_NONE
Do not use any proxy settings or use browser settings if applicable(default)
SESSION_PROXY_BROWSER_DEFAULT
Use the browser settings if applicable
SESSION_PROXY_SOCKS_V4
Connect to the telnet host via a SOCKS v4 proxy only
SESSION_PROXY_SOCKS_V5
Connect to the telnet host via a SOCKS v5 proxy only
SESSION_PROXY_SOCKS_V5_THEN_V4
Connect to the telnet host via a SOCKS v5 proxy. If the defined SOCKS proxy happens to be a SOCKS v4 proxy instead of a SOCKS v5 proxy, connect in any case
SESSION_PROXY_HTTP
Connect to the telnet host via a HTTP proxy
SESSION_PROXY_SRV_HOST_NAME - Proxy server name
The TCP/IP name or address of the proxy host
SESSION_PROXY_SRV_HOST_PORT - Proxy server port number
The TCP/IP proxy host port (default for SOCKS proxy is SESSION_SOCKS_PROXY_PORT_DEFAULT ("1080"), default for HTTP proxy is SESSION_HTTP_PROXY_PORT_DEFAULT ("8080").
SESSION_PROXY_AUTHEN_METHOD - .
For SOCKS v5 Proxy, the value can be one of the following strings:
Constant
Description
SESSION_PROXY_AUTHEN_NONE
No authentication with SOCKS v5 Proxy (default)
SESSION_PROXY_AUTHEN_CLEAR_TEXT
Use clear text userid and password for authentication with SOCKS v5 Proxy
For HTTP Proxy, the value can be one of the following strings:
Constant
Description
SESSION_PROXY_AUTHEN_NONE
No authentication with HTTP Proxy (default)
SESSION_PROXY_AUTHEN_BASIC
Use HTTP 'Basic' format userid and password for authentication with HTTP Proxy
SESSION_PROXY_SOCKS_USERSID - SOCKS Proxy userid
Used in conjunction with SESSION_PROXY_SOCKS_PASSWORD for plain text authentication on a SOCKS v5 Proxy Server
Used in conjunction with SESSION_PROXY_SOCKS_USERID for plain text authentication on a SOCKS v5 Proxy Server
SESSION_SOCKS_PROXY_PORT_DEFAULT - Default port number to open on the SOCKS Proxy Server
Constant String = "1080"
SESSION_HTTP_PROXY_PORT_DEFAULT - Default port number to open on the HTTP Proxy Server
Constant String = "8080"
SESSION_SSL - Determines whether the session will use the Secure Socket Layer (SSL) for security
The value can be one of the following:
Constant
Value
Description
SESSION_OFF
"false"
Do not use SSL (default)
SESSION_ON
"true"
Use SSL
All classes needed for this option are in habeans.jar.
To request an encrypted session, set this parameter to SESSION_ON.
If the program connects to a server that has a self-signed certificate, a copy of the certificate must be added to the
CustomizedCAs.class file in the program's codebase. If the server has a certificate signed by a CA other than
Verisign or Thawte, the CA's root certificate must be added to the CustomizedCAs.class.
This option only checks to see if the server's certificate is trusted. It does not check to see if the name
in the certificate matches the Internet address the certificate was received from. To add this check, set
SESSION_SSL_SERVER_AUTHENTICATION to SESSION_ON.
All classes needed for this option are in habeans.jar.
If the client is configure to use TLS protocol, then the server which is TLS-enabled will provide a TLS v1.0
connection for the client session. If the server is not TLS-enabled, then the server will negotiate the connection down to
the level of SSL that it supports.
SSH protocol is valid for VT session only.
SESSION_SSL_TELNET_NEGOTIATED - Determines whether the SSL handshake will be done on the Telnet connection or on an SSL connection.
The value can be one of the following:
Constant
Value
Description
SESSION_OFF
"false"
Do the SSL Handshake on an SSL connection prior to Telnet negotiation(default)
SESSION_ON
"true"
Do the SSL Handshake on the Telnet connection
All classes needed for this option are in habeans.jar. SESSION_SSL must be set to SESSION_ON.
This option should only be set to true (SESSION_ON) if you have a Telnet server which supports IETF Internet-Draft
"TLS-based Telnet Security" which defines the protocol for doing the SSL Handshake over a Telnet connection.
All classes needed for this option are in habeans.jar. SESSION_SSL must be set to SESSION_ON.
In a standard HOD SSL connection, the client checks to make sure the server's certificate has been issued by
a trusted CA, but does not check the name in the certificate to make sure it matches the Internet address that
the certificate was received from. Setting SESSION_SSL_SERVER_AUTHENTICATION to SESSION_ON adds this additional
check.
All classes needed for this option are in habeans.jar, hassl.jar, and hacltau.jar.
SESSION_SSL must be set to SESSION_ON, and the server must request a client certificate.
In a standard SSL handshake, the client always requests the server's certificate to authenticate the server.
The server can also request the client's certificate. If you are connecting to a server that requires the
client to present a certificate, and you do not want the program to be prompted for a certificate and password,
then, the SESSION_SSL_CERTIFICATE_SOURCE must be set as ECLSession.SESSION_SSL_CERTIFICATE_IN_CSP
and SESSION_SSL_CERTIFICATE_PROMPT_HOW_OFTEN must be set to "SESSION_SSL_CERTIFICATE_DO_NOT_PROMPT".
Must be either ECLSession.SESSION_SSL_CERTIFICATE_IN_URL for a client certificate in a PKCS12 URL or
ECLSession.SESSION_SSL_CERTIFICATE_IN_CSP for a client certificate in a MSCAPI Cryptographic Service Provider
All classes needed for this option are in habeans.jar, hassl.jar and hacltau.jar.
SESSION_SSL and SESSION_SSL_CERTIFICATE_PROVIDED must be set to SESSION_ON,
and the server must request a client certificate.
Must be a valid URL or local file name of a client certificate in PKCS12 format.
If a URL is specified, the URL protocol (http, ftp, etc.) must be supported by the JVM running the program.
SESSION_SSL_CERTIFICATE_PROMPT_HOW_OFTEN - how often the user should
be prompted for certificate information (PKCS12 file location and password, or certificate name).
The value can be one of the following:
Constant
Value
Description
SESSION_SSL_CERTIFICATE_PROMPT_EACH_CONNECT
"SESSION_SSL_CERTIFICATE_PROMPT_EACH_CONNECT"
prompt the user each time a connection is attempted
SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECT
"SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECT"
prompt the user the first time a connection is attempted after HOD has started (default)
SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE
"SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE"
prompt once, and then store the information in the local preferences file
(this option is only available for client that store their preferences locally)
SESSION_SSL_CERTIFICATE_DO_NOT_PROMPT
"SESSION_SSL_CERTIFICATE_DO_NOT_PROMPT"
disables the prompt for certificate and password from HOD, but not from the browser or security device.
This option is only availabel when the certificate source is "SESSION_SSL_CERTIFICATE_IN_CSP"(default)
All classes needed for this option are in habeans.jar, hassl.jar, and hacltau.jar.
SESSION_SSL and SESSION_SSL_CERTIFICATE_PROVIDED must be set to SESSION_ON,
and the server must request a client certificate.
only prompt the user after the server has requested a certificate (default)
SESSION_ON
"true"
prompt the user before attempting the connection
All classes needed for this option are in habeans.jar, hassl.jar, and hacltau.jar.
SESSION_SSL and SESSION_SSL_CERTIFICATE_PROVIDED must be set to SESSION_ON,
and the server must request a client certificate.
SESSION_SSL_USE_JSSE - Determines whether the session will use Java Secure Socket Extension (JSSE) for
Secure Socket Layer (SSL) security
The value can be one of the following:
Constant
Value
Description
SESSION_OFF
"false"
Do not use JSSE (default)
SESSION_ON
"true"
Use JSSE
Java 2 Only. JSSE packages must be installed to use this option.
SESSION_SLP_ENABLED - Determines whether SLP will be used to determine the destination address and port (valid only for 3270 and 5250 sessions)
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Use SLP
SESSION_OFF
"false"
Do not use SLP (default)
SESSION_SLP_AS400_NAME - The fully qualified CP Name of the AS/400 to which the session will be established (valid only for 5250 sessions)
Blank (default) or a fully qualified CP Name of the destination AS/400. This parameter only has
significance when the SESSION_SLP_ENABLED parameter is ON.
SESSION_SLP_SCOPE - The SCOPE to be used to filter SLP requests (valid only for 3270 and 5250 sessions)
Blank (default) or a valid SCOPE defined at the Communications Server. This parameter only has
significance when the SESSION_SLP_ENABLED parameter is ON.
SESSION_SLP_THIS_SCOPE_ONLY - Determines whether session will be established through unscoped servers (valid only for 3270 and 5250 sessions)
This parameter only has significance when the SESSION_SLP_SCOPE contains a SCOPE. The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Session may only be established through servers with the specified scope.
SESSION_OFF
"false"
Session may be established through unscoped servers or servers with specified scope. (default)
SESSION_SLP_MAX_WAIT_TIME - The maximum time in milliseconds to wait for Directory and Service Agent responses (valid only for 3270 and 5250 sessions)
The maximum time in milliseconds SLP will wait for a response from a Directory or Service Agent. This parameter only has
significance when the SESSION_SLP_ENABLED parameter is ON.(default = "200")
SESSION_CODE_PAGE - Determines the code page table used to map the EBCDIC character set on the host to the Unicode character set on the workstation.
The value can be one of the following:
Constant
Value
Country
The following apply to 3270 and 5250 sessions
SESSION_CODE_PAGE_US
"037"
United States (default)
SESSION_CODE_PAGE_BELGIUM
"037"
Belgium
SESSION_CODE_PAGE_BRAZIL
"037"
Brazil
SESSION_CODE_PAGE_CANADA
"037"
Canada
SESSION_CODE_PAGE_NETHERLANDS
"037"
Netherlands
SESSION_CODE_PAGE_PORTUGAL
"037"
Portugal
SESSION_CODE_PAGE_GERMANY
"273"
Germany
SESSION_CODE_PAGE_AUSTRIA
"273"
Austria
SESSION_CODE_PAGE_BELGIUM_OLD
"274"
Belgium (Old)
SESSION_CODE_PAGE_BRAZIL_OLD
"275"
Brazil (Old)
SESSION_CODE_PAGE_DENMARK
"277"
Denmark
SESSION_CODE_PAGE_NORWAY
"277"
Norway
SESSION_CODE_PAGE_FINLAND
"278"
Finland
SESSION_CODE_PAGE_SWEDEN
"278"
Sweden
SESSION_CODE_PAGE_ITALY
"280"
Italy
SESSION_CODE_PAGE_SPAIN
"284"
Spain
SESSION_CODE_PAGE_LATIN_AMERICA
"284"
Latin-America (Spanish)
SESSION_CODE_PAGE_UNITED_KINGDOM
"285"
United Kingdom
SESSION_CODE_PAGE_FRANCE
"297"
France
SESSION_CODE_PAGE_ARABIC
"420"
Arabic
SESSION_CODE_PAGE_ISRAEL_NEW
"424"
Hebrew (New)
SESSION_CODE_PAGE_MULTILINGUAL
"500"
Multilingual
SESSION_CODE_PAGE_ISRAEL_OLD
"803"
Hebrew (Old)
SESSION_CODE_PAGE_THAI
"838"
Thai
SESSION_CODE_PAGE_ROMANIA
"870"
Romania
SESSION_CODE_PAGE_BOSNIA_HERZEGOVINA
"870"
Bosnia/Herzegovina
SESSION_CODE_PAGE_CROATIA
"870"
Croatia
SESSION_CODE_PAGE_CZECH
"870"
Czech
SESSION_CODE_PAGE_HUNGARY
"870"
Hungary
SESSION_CODE_PAGE_POLAND
"870"
Poland
SESSION_CODE_PAGE_SLOVAKIA
"870"
Slovakia
SESSION_CODE_PAGE_SLOVENIA
"870"
Slovenia
SESSION_CODE_PAGE_ICELAND
"871"
Iceland
SESSION_CODE_PAGE_GREECE
"875"
Greece
SESSION_CODE_PAGE_JAPAN_KATAKANA_NEX
"290"
Japan (Non-ext Katakana)
SESSION_CODE_PAGE_JAPAN_KATAKANA
"930"
Japan (Katakana)
SESSION_CODE_PAGE_KOREA
"933"
Korea
SESSION_CODE_PAGE_PRC
"935"
PRC (Simplified Chinese)
SESSION_CODE_PAGE_ROC
"937"
ROC (Traditional Chinese)
SESSION_CODE_PAGE_JAPAN_ENGLISH
"939"
Japan (English)
SESSION_CODE_PAGE_RUSSIA
"1025"
Russia
SESSION_CODE_PAGE_BELARUS
"1025"
Belarus
SESSION_CODE_PAGE_BULGARIA
"1025"
Bulgaria
SESSION_CODE_PAGE_MACEDONIA
"1025"
FYR Macedonia
SESSION_CODE_PAGE_SERBIA_MONTEGRO
"1025"
Serbia/Montenegro (Cyrillic)
SESSION_CODE_PAGE_TURKEY
"1026"
Turkey
SESSION_CODE_PAGE_OPEN_EDITION
"1047"
Open Edition
SESSION_CODE_PAGE_LATVIA
"1112"
Latvia
SESSION_CODE_PAGE_LITHUANIA
"1112"
Lithuania
SESSION_CODE_PAGE_ESTONIA
"1122"
Estonia
SESSION_CODE_PAGE_UKRAINE
"1123"
Ukraine
SESSION_CODE_PAGE_MULTILINGUAL_ISO_EURO
"924"
Multilingual ISO Euro
SESSION_CODE_PAGE_HINDI
"1137"
Hindi
SESSION_CODE_PAGE_US_EURO
"1140"
United States Euro
SESSION_CODE_PAGE_BELGIUM_EURO
"1140"
Belgium Euro
SESSION_CODE_PAGE_BRAZIL_EURO
"1140"
Brazil Euro
SESSION_CODE_PAGE_CANADA_EURO
"1140"
Canada Euro
SESSION_CODE_PAGE_NETHERLANDS_EURO
"1140"
Netherlands Euro
SESSION_CODE_PAGE_PORTUGAL_EURO
"1140"
Portugal Euro
SESSION_CODE_PAGE_GERMANY_EURO
"1141"
Germany Euro
SESSION_CODE_PAGE_AUSTRIA_EURO
"1141"
Austria Euro
SESSION_CODE_PAGE_DENMARK_EURO
"1142"
Denmark Euro
SESSION_CODE_PAGE_NORWAY_EURO
"1142"
Norway Euro
SESSION_CODE_PAGE_FINLAND_EURO
"1143"
Finland Euro
SESSION_CODE_PAGE_SWEDEN_EURO
"1143"
Sweden Euro
SESSION_CODE_PAGE_ITALY_EURO
"1144"
Italy Euro
SESSION_CODE_PAGE_SPAIN_EURO
"1145"
Spain Euro
SESSION_CODE_PAGE_LATIN_AMERICA_EURO
"1145"
Latin America Euro
SESSION_CODE_PAGE_UNITED_KINGDOM_EURO
"1146"
United Kingdom Euro
SESSION_CODE_PAGE_FRANCE_EURO
"1147"
France Euro
SESSION_CODE_PAGE_MULTILINGUAL_EURO
"1148"
Multilingual Euro
SESSION_CODE_PAGE_ICELAND_EURO
"1149"
Iceland Euro
SESSION_CODE_PAGE_ROMANIA_EURO
"1153"
Romania Euro
SESSION_CODE_PAGE_BOSNIA_HERZEGOVINA_
"1153"
Bosnia/Herzegovina Euro
SESSION_CODE_PAGE_CROATIA_EURO
"1153"
Croatia Euro
SESSION_CODE_PAGE_CZECH_EURO
"1153"
Czech Republic Euro
SESSION_CODE_PAGE_HUNGARY_EURO
"1153"
Hungary Euro
SESSION_CODE_PAGE_POLAND_EURO
"1153"
Poland Euro
SESSION_CODE_PAGE_SLOVAKIA_EURO
"1153"
Slovakia Euro
SESSION_CODE_PAGE_SLOVENIA_EURO
"1153"
Slovenia Euro
SESSION_CODE_PAGE_RUSSIA_EURO
"1154"
Russia Euro
SESSION_CODE_PAGE_BELARUS_EURO
"1154"
Belarus Euro
SESSION_CODE_PAGE_BULGARIA_EURO
"1154"
Bulgaria Euro
SESSION_CODE_PAGE_MACEDONIA_EURO
"1154"
FYR Macedonia Euro
SESSION_CODE_PAGE_SERBIA_MONTEGRO_EUR
"1154"
Serbia/Montenegro (Cyrillic) Euro
SESSION_CODE_PAGE_TURKEY_EURO
"1155"
Turkey Euro
SESSION_CODE_PAGE_LATVIA_EURO
"1156"
Latvia Euro
SESSION_CODE_PAGE_LITHUANIA_EURO
"1156"
Lithuania Euro
SESSION_CODE_PAGE_ESTONIA_EURO
"1157"
Estonia Euro
SESSION_CODE_PAGE_UKRAINE_EURO
"1158"
Ukraine Euro
SESSION_CODE_PAGE_THAI_EURO
"1160"
Thai Euro
SESSION_CODE_PAGE_KOREA_EURO
"1364"
Korea Euro
SESSION_CODE_PAGE_ROC_EURO
"1371"
ROC (Traditional Chinese) Euro
SESSION_CODE_PAGE_PRC_GBK
"1388"
PRC (Simplified Chinese; GBK)
SESSION_CODE_PAGE_JAPAN_KATAKANA_EURO
"1390"
Japanese (Katakana Extended) Euro
SESSION_CODE_PAGE_JAPAN_ENGLISH_EURO
"1399"
Japanese (Latin Extended) Euro
The following apply only to VT sessions
SESSION_VT_CODE_PAGE_MULTI
"1100"
DEC Multinational (default)
SESSION_VT_CODE_PAGE_USA
"1100"
United States
SESSION_VT_CODE_PAGE_BRI
"1101"
British
SESSION_VT_CODE_PAGE_DUT
"1102"
Dutch
SESSION_VT_CODE_PAGE_FIN
"1103"
Finnish
SESSION_VT_CODE_PAGE_FRE
"1104"
French
SESSION_VT_CODE_PAGE_CAN
"1020"
Canadian French
SESSION_VT_CODE_PAGE_GER
"1011"
German
SESSION_VT_CODE_PAGE_ITA
"1012"
Italian
SESSION_VT_CODE_PAGE_NOR
"1105"
Norwegian/Danish
SESSION_VT_CODE_PAGE_SPA
"1023"
Spanish
SESSION_VT_CODE_PAGE_SWE
"1106"
Swedish
SESSION_VT_CODE_PAGE_SWI
"1021"
Swiss
SESSION_VT_CODE_PAGE_THA
"874"
Thai
SESSION_SERVICE_MGR_HOST - The TCP/IP name or address of a host server which is running the NCOD Service Manager
The value must be specified for persistent logging and tracing. Log and trace information are sent to the NCOD Service Manager.
SESSION_TRACE - Activates the Log/Trace facility and starts tracing for the specified components.
A trace level from 1 to 3 can also be specified for each separate component using
the following syntax: "ECLSession=x", where x is the trace level.
The values can be zero or more of the following separated by blanks:
Constant
Value
Components Traced
SESSION_TRACE_SESSION
"ECLSession"
ECLSession and subcomponents
SESSION_TRACE_PS
"ECLPS"
ECLPS and subcomponents
SESSION_TRACE_FIELD
"ECLField"
ECLField and subcomponents
SESSION_TRACE_FIELDLIST
"ECLFieldList"
ECLFieldList and subcomponents
SESSION_TRACE_OIA
"ECLOIA"
ECLOIA and subcomponents
SESSION_TRACE_ERR
"ECLErr"
ECLErr and subcomponents
SESSION_TRACE_XFER
"ECLXFer"
ECLXFer and subcomponents
SESSION_TRACE_DS
"DataStream"
DataStream and subcomponents
SESSION_TRACE_PRINTER
"DataStream"
Printer and subcomponents
SESSION_TRACE_TRANSPORT
"Transport"
Transport and subcomponents
SESSION_TRACE_OIA_EVENT
"ECLOIAEvent"
OIA events
SESSION_TRACE_PS_EVENT
"ECLPSEvent"
PS events
SESSION_TRACE_COMM_EVENT
"ECLCommEvent"
Communications events
SESSION_PS_DEBUGGER - Activates the PS Debug facility which can display all of the
planes associated with the presentation space.
The value is ignored.
Key
Properties Specific to VT Sessions
SESSION_VT_NEW_LINE - Determines the behavior of new line operation
The value can be one of the following:
Constant
Value
Description
SESSION_VT_NEW_LINE_CRLF
"false"
Carriage return and linefeed (CRLF)
SESSION_VT_NEW_LINE_CR
"true"
Carriage return only (CR) (default)
SESSION_VT_BACKSPACE - Determines the behavior of the backspace operation
The value can be one of the following:
Constant
Value
Description
SESSION_VT_BACKSPACE_NORM
"false"
Destructive backspace (default)
SESSION_VT_BACKSPACE_DELETE
"true"
Delete character under cursor
SESSION_VT_CURSOR - Determines the behavior of cursor movement
The value can be one of the following:
Constant
Value
Description
SESSION_VT_CURSOR_NORM
"false"
Normal (default)
SESSION_VT_CURSOR_APPL
"true"
Application controls cursor movement
SESSION_VT_KEYPAD - Determines the behavior of the keypad
The value can be one of the following:
Constant
Value
Description
SESSION_VT_KEYPAD_NORM
"false"
Normal (default)
SESSION_VT_KEYPAD_APPL
"true"
Application controls keypad behavior
SESSION_VT_LOCAL_ECHO - Determines the behavior of local keyboard echo
The value can be one of the following:
Constant
Value
Description
SESSION_VT_LOCAL_ECHO_OFF
"false"
Off (default)
SESSION_VT_LOCAL_ECHO_ON
"true"
On
SESSION_VT_AUTOWRAP - Determines the behavior of autowrap
The value can be one of the following:
Constant
Value
Description
SESSION_VT_AUTOWRAP_OFF
"false"
Off (default)
SESSION_VT_AUTOWRAP_ON
"true"
On
SESSION_VT_ANS_BAK_MSG - Message sent to the host in response to the x05 command
A string of characters user enters or null. The default is null.
SESSION_VT_TERMINAL_TYPE - Determines the VT-specific terminal type
The value can be one of the following:
Constant
Value
Description
SESSION_VT_TERMINAL_TYPE_VT420_7
"1"
VT420 7-bit (default)
SESSION_VT_TERMINAL_TYPE_VT420_8
"2"
VT420 8-bit
SESSION_VT_TERMINAL_TYPE_VT100
"3"
VT100
SESSION_VT_TERMINAL_TYPE_VT52
"4"
VT52
SESSION_VT_ID - For telenet a ASCII value is passed to the host machine to
represent the VT terminal type symbolically. A UNIX and LINUX host attempts to
match that to an entry in the termcap file (most often /etc/termcap).
The values below are suggestions that may be suitable. However, any arbitrary string
value may be used. It is the programmer's responsibility to match the capabilities of the
SESSION_VT_TERMINAL_TYPE to the equivalent capabilities denoted by this SESSION_VT_ID parameter.
The value can be one of the following:
Constant
Value
Description
SESSION_VT_ID_VT420
"VT420"
vt420(default)
SESSION_VT_ID_VT320
"VT320"
vt320
SESSION_VT_ID_VT220
"VT220"
vt220
SESSION_VT_ID_VT102
"VT102"
vt102
SESSION_VT_ID_VT101
"VT102"
vt101
SESSION_VT_ID_VT100
"VT102"
vt100
A user defined String
Any custom value
To match a termcap entry, such as "DEC-VT400" or "DEC VT420"
SESSION_VT_PRINT_DESTINATION - Determines whether print output goes to a printer or a file
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Output goes to a printer device(default)
SESSION_OFF
"false"
Output goes to a file
SESSION_VT_PRINT_FILE_NAME - Printer output file name
The path and name of the file when the print destination is a file. This parameter only has
significance when the SESSION_VT_PRINT_DESTINATION parameter is set to "false".
SESSION_VT_PRINTER_NAME - Printer port name
The name of the port for the printer you want to use. This parameter only has
significance when the SESSION_VT_PRINT_DESTINATION parameter is set to "true".
On Windows workstations, you can type the UNC name of a network printer in either of two formats:
\\server_name\printer name or \\server's_host_name_or_IP_address\printer name. For example,
if you are configuring a printer on Windows 98 or NT, type a port name such as LPT1. If you
are configuring a printer on UNIX, type a device name such as /dev/lp0.
SESSION_VT_PRINT_SEPARATE_FILES - Print jobs to separate files
When the print destination is a file, you can choose whether you want to save each print job to a unique file or have jobs appended to each other in one file.
The value can be one of the following:
Constant
Value
Description
SESSION_ON
"true"
Each print job to a unique file.
SESSION_OFF
"false"
Each print job is appended to each other in one file.(default)
Key
Properties Specific to CICS Sessions
SESSION_CICS_SERVER_NAME - Name of the CICS server
A valid CICS server name (default = CICS Gateway default server)
SESSION_CICS_GW_CODE_PAGE - Determines the table used to map the ASCII character set on the CICS Gateway to the Unicode character set on the workstation
The value can be one of the following:
Constant
Value
Description
SESSION_CICS_CODE_PAGE_AUTO_DETECT
"000"
Uses the code page setting from the CICS Gateway (default)
Frees resources associated with the session. The session
should not be used after a call to dispose().
StartCommunicationWithBlocking
public void StartCommunicationWithBlocking(long timeout)
throws ECLErr,
java.lang.InterruptedException
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
Parameters:
timeout - The maximum amount of time in seconds that can elapse
before returning. If the timeout has been reached before a Ready
state has been achieved, an ECLErr will be thrown.
public void StartCommunicationWithBlocking(long timeout,
java.lang.String[] scrndescstrings)
throws ECLErr,
java.lang.InterruptedException
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
Parameters:
timeout - The maximum amount of time in seconds that can elapse
before returning. If the timeout has been reached before a Ready
state has been achieved, an ECLErr will be thrown.
scrndescstrings - An array of strings that must be present on the
screen before this method will return normally
public void StartCommunicationWithBlocking(long timeout,
ECLScreenDesc scrndesc)
throws ECLErr,
java.lang.InterruptedException
Initiates a connection to the host and blocks until the connection
reports a state of ECLConnection.CONNECTION_READY
Warning: This is a blocking method and should not be called on the AWT Thread
Parameters:
timeout - The maximum amount of time in seconds that can elapse
before returning. If the timeout has been reached before a Ready
state has been achieved, an ECLErr will be thrown.
scrndesc - A reference to a Screen Description object that must
be matched before this method will return normally
Gets the ECLXfer associated with the session. The ECLXfer object
allows applications to transfer files between the local machine
and the host.
Note: File Transfer is only supported for 3270 and 5250 ECLSessions. For
other ECLSessions, GetXfer() will return null.
Returns:
the ECLXfer objected associated with this session.
Shows or hides the PS Debugger. The PS Debugger object displays the
presentation space planes.
setHTMLDDS
public void setHTMLDDS(boolean val)
Sets the HTMLDDS property. This property indicates whether to enable the
HTML keyword in DDS functionality. This property can only be enabled for
5250 sessions and this property will only be set while the session is not connected.
Parameters:
val - The new value for the HTMLDDS property
vetoes the new value.