com.ibm.eNetwork.ECL
Class ECLConnection

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.ECLConnection

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ECLSession

public class ECLConnection

extends java.lang.Object

implements java.lang.Runnable

ECLConnection is the base class from which ECLSession inherits. An application must use an instance of ECLSession to access the methods in this class.

Field Summary

static int	CONNECTION_ACTIVE
static int	CONNECTION_AUTOMATIC_INCREMENT_FAILED
static int	CONNECTION_DEVICE_NAME_READY
static int	CONNECTION_DEVNAME_IN_USE
static int	CONNECTION_INACTIVE
static int	CONNECTION_INIT
static int	CONNECTION_LOCAL_CLIENT_NOT_FOUND
static int	CONNECTION_PND_ACTIVE
static int	CONNECTION_PND_INACTIVE
static int	CONNECTION_READY
static int	CONNECTION_WORKSTATION_ID_READY
static int	ENCRYPTION_128BIT
static int	ENCRYPTION_168BIT
static int	ENCRYPTION_40BIT
static int	ENCRYPTION_56BIT
static int	ENCRYPTION_NOKEY
static int	ENCRYPTION_NONE

Method Summary

java.lang.String	customAIDHandlingList() Returns List of AID keys to be handled uniquely, according to html applet param.
int	getBackupIndex() Gets the current active backup server index.
java.lang.String	getCertificateName() Returns configured client certificate Name
boolean	getCertificateNameAdmin() Returns whether the certificate Name can be modified
boolean	getCertificatePromptHowOftenAdmin() Returns whether how often the certificate is prompted can be modified
int	GetCICSGWCodePage() Gets the user-specified CICS gateway code page.
java.lang.String	GetCICSServer() Gets the name of CICS server.
int	GetCodePage() Gets the host code page.
int	GetCommStatus() Returns the status of the connection to the host
int	GetConnType() Gets the session type.
boolean	getContentionResolution() Returns the current state of Contention Resolution.
java.lang.String	GetDeviceName() Returns the device (or LU) name associated with this session.
int	GetEncryptionLevel() Gets the session encryption level.
java.lang.String	GetHost() Gets the name of the host with which the session is established.
java.lang.String	getHost(int backup) Gets the name of the host ( primary, bakcup1, backup2 )
boolean	getignoreWellKnownTrustedCAsOption() Returns the value of the ignoreWellKnownTrustedCAs property
java.lang.String	GetLabel() Gets the session label.
java.lang.String	getLUName(int backup) Gets the name of the LU ( primary, bakcup1, backup2 )
java.lang.String	GetName() Gets the session name.
int	GetPort() Gets the host port number of the session.
int	getPort(int backup) Gets the name of the port ( primary, bakcup1, backup2 )
java.util.Properties	getProperties() Return the Properties object used when constructing this session.
java.lang.String	getProxyAuthenMethod() Returns the current method of authentication in use for the configured proxy server.
java.lang.String	getProxyServerName() Returns the currently defined proxy server.
java.lang.String	getProxyServerPort() Returns the current value of the port to connect to on proxy server.
java.lang.String	getProxyType() Returns the current value of the proxy server property.
java.lang.String	getProxyUserID() Returns the current value of the user id used for authentication with the proxy server.
java.lang.String	getProxyUserPassword() Gets the value of the password used for authentication with the proxy server.
int	GetTimeout() Gets the timeout for the session.
int	getTransportReceiveBuffSize() Returns the current value of the transport receive buffer size property.
boolean	GetUnicodeDataStreamEnabled() Returns the current value of the Unicode Data Stream is enabled or not
java.lang.String	GetWorkstationID() Returns the name of a workstation ID for this session.
boolean	IsCommReady() Checks whether the session is ready for interaction such as sending keystrokes or calling other API methods.
boolean	IsCommStarted() Checks whether the session is connected to the host.
boolean	IsDeviceNameReady() Checks whether the negotiated device name is ready.
boolean	isENPTUI() Returns whether or not the ENPTUI function should be enabled for 5250 display session.
boolean	isPrintDestination() Determines if the print destination is a printer or a file This is only valid for VT sessions.
boolean	isQuietMode() Returns whether or not quiet mode processing is enabled.
boolean	isSeparateFiles() Determines if each print job goes to a unique file or have printer jobs appended to each other in one file.
boolean	isTCPNODELAY() Returns the setting of the TCPNODELAY configuration option.
boolean	IsWorkstationIDReady() Checks whether the negotiated workstation ID is ready.
void	RegisterCommEvent(ECLCommNotify notify, boolean initEvent) Registers a notification object for events dispatched by a single instance of ECLConnection.
void	setCertificateName(java.lang.String name) Set configured client certificate Name
void	setCertificatePromptHowOften(java.lang.String howOften) Set how often the client certificate should be prompted
void	setProxyAuthenMethod(java.lang.String authMethod) Sets the authentication method that will be used to authenitcate with the proxy server.
void	setProxyServerName(java.lang.String hostName) Sets the name of the proxy server to use.
void	setProxyServerPort(java.lang.String port) Sets the port that will be opened on the proxy server.
void	setProxyType(java.lang.String newProxyType) Sets the type of the proxy server that will be used.
void	setProxyUserID(java.lang.String newUserID) Sets the value of the user id used for authentication with the proxy server.
void	setProxyUserPassword(java.lang.String newUserPW) Sets the value of the password used for authentication with the proxy server.
void	setTransportReceiveBuffSize(int buffSize) Sets the transport receive buffer size.
void	SetUnicodeDataStreamEnabled(boolean unicode) Sets the value of the Unicode Data Stream is enabled or not
void	StartCommunication() Starts the communications link to the host.
void	StopCommunication() Stops the communications link to the host.
void	syncStopCommunication() Stops the communications link to the host.
void	UnregisterCommEvent(ECLCommNotify notify) Unregisters a notification object previously registered with the RegisterCommEvent() method.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

CONNECTION_INIT

public static final int CONNECTION_INIT

CONNECTION_PND_INACTIVE

public static final int CONNECTION_PND_INACTIVE

CONNECTION_INACTIVE

public static final int CONNECTION_INACTIVE

CONNECTION_PND_ACTIVE

public static final int CONNECTION_PND_ACTIVE

CONNECTION_ACTIVE

public static final int CONNECTION_ACTIVE

CONNECTION_READY

public static final int CONNECTION_READY

CONNECTION_DEVICE_NAME_READY

public static final int CONNECTION_DEVICE_NAME_READY

CONNECTION_WORKSTATION_ID_READY

public static final int CONNECTION_WORKSTATION_ID_READY

CONNECTION_AUTOMATIC_INCREMENT_FAILED

public static final int CONNECTION_AUTOMATIC_INCREMENT_FAILED

CONNECTION_LOCAL_CLIENT_NOT_FOUND

public static final int CONNECTION_LOCAL_CLIENT_NOT_FOUND

CONNECTION_DEVNAME_IN_USE

public static final int CONNECTION_DEVNAME_IN_USE

ENCRYPTION_NONE

public static final int ENCRYPTION_NONE

ENCRYPTION_NOKEY

public static final int ENCRYPTION_NOKEY

ENCRYPTION_40BIT

public static final int ENCRYPTION_40BIT

ENCRYPTION_56BIT

public static final int ENCRYPTION_56BIT

ENCRYPTION_128BIT

public static final int ENCRYPTION_128BIT

ENCRYPTION_168BIT

public static final int ENCRYPTION_168BIT

Method Detail

getContentionResolution

public boolean getContentionResolution()

Returns the current state of Contention Resolution. If the session has already successfully negotiated contention resolution, then the value returned will be true, else the value returned will be false.

GetConnType

public int GetConnType()

Gets the session type.

Returns:

The session type. The value can be one of these:

• SESSION_TYPE_3270
• SESSION_TYPE_5250
• SESSION_TYPE_VT
• SESSION_TYPE_CICS.

GetEncryptionLevel

public int GetEncryptionLevel()

Gets the session encryption level.

Returns:

The session encryption level. The value can be one of these:

• ENCRYPTION_NONE (0x00)
• ENCRYPTION_NOKEY (0x01)
• ENCRYPTION_40BIT (0x02)
• ENCRYPTION_56BIT (0x04)
• ENCRYPTION_128BIT (0x08)
• ENCRYPTION_168BIT (0x10).

GetName

public java.lang.String GetName()

Gets the session name.

Returns:

The session name.

GetLabel

public java.lang.String GetLabel()

Gets the session label.

Returns:

The session label.

GetCodePage

public int GetCodePage()

Gets the host code page.

Returns:

The code page in use on the host.

GetHost

public java.lang.String GetHost()

Gets the name of the host with which the session is established.

Returns:

The name of the attached host.

GetPort

public int GetPort()

Gets the host port number of the session.

Returns:

The host port number.

getBackupIndex

public int getBackupIndex()

Gets the current active backup server index.

• 0 - primary server
• 1 - backup 1
• 2 - backup 2

Returns:

The current active backup server index

getHost

public java.lang.String getHost(int backup)

Gets the name of the host ( primary, bakcup1, backup2 )

Parameters:

backup - Index for backup server

0 - primary server

1 - backup 1

2 - backup 2

Returns:

The name of the host ( primary, backup1, or backup2)

getPort

public int getPort(int backup)

Gets the name of the port ( primary, bakcup1, backup2 )

Parameters:

backup - Index for backup server

• 0 - primary server
• 1 - backup 1
• 2 - backup 2

Returns:

The name of the port ( primary, backup1, or backup2)

getLUName

public java.lang.String getLUName(int backup)

Gets the name of the LU ( primary, bakcup1, backup2 )

Parameters:

backup - Index for backup server

• 0 - primary server
• 1 - backup 1
• 2 - backup 2

Returns:

The name of the LU ( primary, backup1, or backup2)

GetTimeout

public int GetTimeout()

Gets the timeout for the session. A timeout value of less than or equal to 0 indicates no timeout. This is only valid for 3270, 5250 and VT sessions. The timeout value is used to terminate inactive sessions. The timeout is not used at connection creation time.

Returns:

The timeout value in millisecs

IsCommStarted

public boolean IsCommStarted()

Checks whether the session is connected to the host.

Returns:

True if the Session is started. False otherwise.

IsCommReady

public boolean IsCommReady()

Checks whether the session is ready for interaction such as sending keystrokes or calling other API methods.

Returns:

Returns true when the session is ready.

GetCommStatus

public int GetCommStatus()

Returns the status of the connection to the host

Returns:

The status of the connection

IsDeviceNameReady

public boolean IsDeviceNameReady()

Checks whether the negotiated device name is ready. This is only valid for 3270 session.

Returns:

Returns true if the device name is ready.

See Also:

GetDeviceName()

GetDeviceName

public java.lang.String GetDeviceName()

Returns the device (or LU) name associated with this session. The name is assigned by the host during session negotiation. This is only valid for 3270 session.

Returns:

The assigned device name, or null if one has not been assigned.

See Also:

IsDeviceNameReady()

IsWorkstationIDReady

public boolean IsWorkstationIDReady()

Checks whether the negotiated workstation ID is ready. This is only valid for 5250 session.

Returns:

Returns true if the workstation ID is ready.

See Also:

GetDeviceName()

GetWorkstationID

public java.lang.String GetWorkstationID()

Returns the name of a workstation ID for this session. This is only valid for 5250 session.

Returns:

The workstation ID for 5250, or null if one has not been specified.

StartCommunication

public void StartCommunication()

Starts the communications link to the host.

StopCommunication

public void StopCommunication()

Stops the communications link to the host.

syncStopCommunication

public void syncStopCommunication()

Stops the communications link to the host.

RegisterCommEvent

public void RegisterCommEvent(ECLCommNotify notify,
                              boolean initEvent)

Registers a notification object for events dispatched by a single instance of ECLConnection. The notification object must implement the ECLCommNotify interface which defines three callback methods called by the ECLConnection class under different conditions.

ECLCommNotify objects can be unregistered using the UnregisterCommEvent() method.

Parameters:

notify - ECLCommNotify object which is notified when events occur.

initEvent - Boolean indicating whether or not an initial notification should be sent out for the initial state of communications.

See Also:

UnregisterCommEvent(com.ibm.eNetwork.ECL.ECLCommNotify), ECLCommNotify

UnregisterCommEvent

public void UnregisterCommEvent(ECLCommNotify notify)

Unregisters a notification object previously registered with the RegisterCommEvent() method. If the notification object is not currently registered, this method does nothing.

Parameters:

notify - ECLCommNotify object which should be unregistered.

See Also:

RegisterCommEvent(com.ibm.eNetwork.ECL.ECLCommNotify, boolean), ECLCommNotify

getProperties

public java.util.Properties getProperties()

Return the Properties object used when constructing this session.

Returns:

A properties object. Contains a set of name/value pairs used when constructing this session.

GetCICSServer

public java.lang.String GetCICSServer()

Gets the name of CICS server.

Returns:

The CICS Server name.

GetCICSGWCodePage

public int GetCICSGWCodePage()

Gets the user-specified CICS gateway code page.

Returns:

The user-specified CICS gateway code page.

getCertificateName

public java.lang.String getCertificateName()

Returns configured client certificate Name

See Also:

setCertificateName(java.lang.String)

setCertificateName

public void setCertificateName(java.lang.String name)

Set configured client certificate Name

Parameters:

name - The client certificate name.

See Also:

getCertificateName()

getCertificateNameAdmin

public boolean getCertificateNameAdmin()

Returns whether the certificate Name can be modified

getignoreWellKnownTrustedCAsOption

public boolean getignoreWellKnownTrustedCAsOption()

Returns the value of the ignoreWellKnownTrustedCAs property

setCertificatePromptHowOften

public void setCertificatePromptHowOften(java.lang.String howOften)

Set how often the client certificate should be prompted

The possible values are

Constant	Description
ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_EACH_CONNECT	Prompt each connect with the host
ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_FIRST_CONNECT	Prompt only the first connect with the host
ECLSession.SESSION_SSL_CERTIFICATE_PROMPT_ONLY_ONCE	Prompt only once
ECLSession.SESSION_SSL_CERTIFICATE_DO_NOT_PROMPT	Prompting is disabled

Parameters:

howOften - The value for how often the client certificate should be prompted

getCertificatePromptHowOftenAdmin

public boolean getCertificatePromptHowOftenAdmin()

Returns whether how often the certificate is prompted can be modified

See Also:

setCertificatePromptHowOften(java.lang.String)

customAIDHandlingList

public java.lang.String customAIDHandlingList()

Returns List of AID keys to be handled uniquely, according to html applet param. This param applies for sessions connected in TN3270* mode.

isTCPNODELAY

public boolean isTCPNODELAY()

Returns the setting of the TCPNODELAY configuration option. If this option is true, responses between this session and the telnet server will flow without any attempt to optimize for size. In some user situations, this will result in faster response time on the session. To turn on TCPNODELAY for a session, put an ECLSession.SESSION_TCP_NODELAY key with a value of ECLSession.SESSION_ON into the properties object passed to the ECLSession constructor.

Returns:

True if the TCPNODELAY option is being used when connecting to the Telnet server. Otherwise returns false.

isENPTUI

public boolean isENPTUI()

Returns whether or not the ENPTUI function should be enabled for 5250 display session.

SetUnicodeDataStreamEnabled

public void SetUnicodeDataStreamEnabled(boolean unicode)

Sets the value of the Unicode Data Stream is enabled or not

Parameters:

unicode - Unicode Data Stream is enabled or not

See Also:

GetUnicodeDataStreamEnabled()

GetUnicodeDataStreamEnabled

public boolean GetUnicodeDataStreamEnabled()

Returns the current value of the Unicode Data Stream is enabled or not

See Also:

SetUnicodeDataStreamEnabled(boolean)

isPrintDestination

public boolean isPrintDestination()

Determines if the print destination is a printer or a file This is only valid for VT sessions.

Returns:

Returns true if the destination is a printer

isSeparateFiles

public boolean isSeparateFiles()

Determines if each print job goes to a unique file or have printer jobs appended to each other in one file. This is only valid for VT sessions.

Returns:

Returns true when the print destination is a file and each printer job is written to a separate file.

isQuietMode

public boolean isQuietMode()

Returns whether or not quiet mode processing is enabled. In quiet mode, no sound is produced when a session is connected. When quiet mode is turned off, a sound (normally a beep) will be heard when a session successfully connects to a host.

setProxyUserID

public void setProxyUserID(java.lang.String newUserID)

Sets the value of the user id used for authentication with the proxy server.

This is a generic call that is used for the following proxy types:

• Socks v5 Proxy
• HTTP Proxy

Parameters:

newUserID - The user id definded on the proxy server

See Also:

getProxyUserID()

getProxyUserID

public java.lang.String getProxyUserID()

Returns the current value of the user id used for authentication with the proxy server.

This is a generic call that is used for the following proxy types:

• Socks v5 Proxy
• HTTP Proxy

See Also:

setProxyUserID(java.lang.String)

setProxyUserPassword

public void setProxyUserPassword(java.lang.String newUserPW)

Sets the value of the password used for authentication with the proxy server.

This is a generic call that is use for the following proxy types:

• Socks v5 Proxy
• HTTP Proxy

Parameters:

newUserPW - The password associated with the user id definded on the proxy server

See Also:

getProxyUserPassword()

getProxyUserPassword

public java.lang.String getProxyUserPassword()

Gets the value of the password used for authentication with the proxy server.

This is a generic call that is use for the following proxy types:

• Socks v5 Proxy
• HTTP Proxy

See Also:

setProxyUserPassword(java.lang.String)

setProxyType

public void setProxyType(java.lang.String newProxyType)

Sets the type of the proxy server that will be used. The possible values are:

• ECLSession.SESSION_PROXY_NONE
• ECLSession.SESSION_PROXY_BROWSER_DEFAULT
• ECLSession.SESSION_PROXY_SOCKS_V5
• ECLSession.SESSION_PROXY_SOCKS_V4
• ECLSession.SESSION_PROXY_SOCKS_V5_THEN_V4
• ECLSession.SESSION_PROXY_HTTP

Parameters:

newProxyType - The type of proxy to connect through

See Also:

getProxyType()

getProxyType

public java.lang.String getProxyType()

Returns the current value of the proxy server property.

See Also:

setProxyType(java.lang.String)

setProxyServerName

public void setProxyServerName(java.lang.String hostName)

Sets the name of the proxy server to use.

Parameters:

hostName - The host name of the proxy server as either a fully qualified name or an IP address

See Also:

getProxyServerName()

getProxyServerName

public java.lang.String getProxyServerName()

Returns the currently defined proxy server.

See Also:

setProxyServerName(java.lang.String)

setProxyServerPort

public void setProxyServerPort(java.lang.String port)

Sets the port that will be opened on the proxy server.

Parameters:

port - The port number to connect to on the proxy server

See Also:

getProxyServerPort()

getProxyServerPort

public java.lang.String getProxyServerPort()

Returns the current value of the port to connect to on proxy server.

See Also:

setProxyServerPort(java.lang.String)

setProxyAuthenMethod

public void setProxyAuthenMethod(java.lang.String authMethod)

Sets the authentication method that will be used to authenitcate with the proxy server.

The valid values when using Socks v5 proxies are:

• ECLSession.SESSION_PROXY_AUTHEN_NONE
• ECLSession.SESSION_PROXY_AUTHEN_CLEAR_TEXT

The valid values when using HTTP proxies are:

• ECLSession.SESSION_PROXY_AUTHEN_NONE
• ECLSession.SESSION_PROXY_AUTHEN_BASIC

Parameters:

authMethod - The authenitcation method to use when connecting to the proxy server

See Also:

getProxyAuthenMethod()

getProxyAuthenMethod

public java.lang.String getProxyAuthenMethod()

Returns the current method of authentication in use for the configured proxy server.

See Also:

setProxyAuthenMethod(java.lang.String)

setTransportReceiveBuffSize

public void setTransportReceiveBuffSize(int buffSize)

Sets the transport receive buffer size. A valid value ranges from 263 to 2,147,483,647. A default value will be used if an invalid value is specified.

Parameters:

buffSize - The transport receive buffer size.

See Also:

getTransportReceiveBuffSize()

getTransportReceiveBuffSize

public int getTransportReceiveBuffSize()

Returns the current value of the transport receive buffer size property.

See Also:

setTransportReceiveBuffSize(int)