|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.eNetwork.ECL.ECLConnection
ECLConnection is the base class from which ECLSession inherits. An application must use an instance of ECLSession to access the methods in this class.
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 |
GetConnectionTimeout()
Returns the current value of the connection timeout property in second |
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 |
getJSSETrustStore()
Returns the name of the trust store to be used by JSSE. |
java.lang.String |
getJSSETrustStorePassword()
Returns the password of the trust store to be used by JSSE. |
java.lang.String |
getJSSETrustStoreType()
Returns the type of trust store to be used by JSSE. |
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. |
java.lang.String |
getSocksV4UserID()
Returns the current value of the user id for a Socks v4 proxy server. |
java.lang.String |
GetSSLP12Password()
This method returns the value of the SESSION_SSL_P12_PASSWORD property |
java.lang.String |
getSSOType()
Returns the current value of the single sign-on type property. |
java.lang.String |
getStartupResponseRecord()
Returns the Startup Response Record sent by the host. |
int |
GetTimeout()
Gets the timeout for the session. |
int |
getTransportReceiveBuffSize()
Returns the current value of the transport receive buffer size property. |
java.lang.String |
GetTrustedSignerPath()
This method returns the value of the SESSION_SSL_P12_FILEPATH 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 |
isKeepAlive()
Returns the setting of the Keep Alive configuration option. |
boolean |
isLastHostWithoutTimeout()
Returns whether connect to the last configured host without timeout. |
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 |
isTimeoutNoDataInitialization()
Returns whether timeout or not if no data is received at the session initialization. |
boolean |
isUseJSSE()
Returns whether the session is configured to use JSSE for secure connections. |
static boolean |
isUseJSSENonFIPSMode()
Returns whether non-FIPS JSSE will be used. |
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 |
SetConnectionTimeout(int connectionTimeout)
Sets the connection timeout. |
void |
setJSSETrustStore(java.lang.String s)
Sets the name of the trust store to be used by JSSE. |
void |
setJSSETrustStorePassword(java.lang.String s)
Sets the password of the trust store to be used by JSSE. |
void |
setJSSETrustStoreType(java.lang.String s)
Sets the type of trust store to be used by JSSE. |
void |
setKerberosTicket(byte[] ticket,
int length)
Sets the Kerberos service ticket to be used in Telnet negotiations to establish a single sign-on session with the host. |
void |
setLastHostWithoutTimeout(boolean isLastHostWithoutTimeout)
Sets true or false to connect to the last configured host without timeout. |
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 |
setSocksV4UserID(java.lang.String newUserID)
Sets the value of the user id for a Socks v4 proxy server. |
void |
SetSSLP12Password(java.lang.String pw)
This method sets the SESSION_SSL_P12_PASSWORD property for an application |
void |
setSSOType(java.lang.String ssoType)
Sets the type of single sign-on to be used for connection-based automation. |
void |
setTimeoutNoDataInitialization(boolean timeout)
Sets true or false about timeout if no data is received at the session initialization This value is only valid for 3270 display/printer, 5250 display sessions. |
void |
setTransportReceiveBuffSize(int buffSize)
Sets the transport receive buffer size. |
void |
SetTrustedSignerPath(java.lang.String path)
This method sets the SESSION_SSL_P12_FILEPATH property for an application |
void |
SetUnicodeDataStreamEnabled(boolean unicode)
Sets the value of the Unicode Data Stream is enabled or not |
void |
setUseJSSE(boolean b)
Sets whether the session is configured to use JSSE for secure connections. |
static void |
setUseJSSENonFIPSMode(boolean b)
By default, FIPS-mode JSSE will be used if available. |
void |
StartCommunication()
Starts the communications link to the host. |
void |
StopCommunication()
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 |
Field Detail |
public static final int CONNECTION_INIT
public static final int CONNECTION_PND_INACTIVE
public static final int CONNECTION_INACTIVE
public static final int CONNECTION_PND_ACTIVE
public static final int CONNECTION_ACTIVE
public static final int CONNECTION_READY
public static final int CONNECTION_DEVICE_NAME_READY
public static final int CONNECTION_WORKSTATION_ID_READY
public static final int CONNECTION_AUTOMATIC_INCREMENT_FAILED
public static final int CONNECTION_LOCAL_CLIENT_NOT_FOUND
public static final int CONNECTION_DEVNAME_IN_USE
public static final int CONNECTION_DEVICE_DESCRIPTION_NOT_FOUND
public static final int CONNECTION_CONTROLLER_DESCRIPTION_NOT_FOUND
public static final int CONNECTION_DAMAGED_DEVICE_DESCRIPTION
public static final int CONNECTION_DEVICE_NOT_VARIED_ON
public static final int CONNECTION_DEVICE_NOT_AVAILABLE
public static final int CONNECTION_DEVICE_NOT_VALID_FOR_SESSION
public static final int CONNECTION_SESSION_INITIATION_FAILED
public static final int CONNECTION_SESSION_FAILURE
public static final int CONNECTION_CONTROLLER_NOT_VALID_FOR_SESSION
public static final int CONNECTION_NO_MATCHING_DEVICE_FOUND
public static final int CONNECTION_NOT_AUTHORIZED_TO_OBJECT
public static final int CONNECTION_JOB_CANCELED
public static final int CONNECTION_OBJECT_PARTIALLY_DAMAGED
public static final int CONNECTION_COMMUNICATIONS_ERROR
public static final int CONNECTION_NEGATIVE_RESPONSE_RECEIVED
public static final int CONNECTION_STARTUP_RECORED_BUILT_INCORRECTLY
public static final int CONNECTION_CREATION_OF_DEVICE_FAILED
public static final int CONNECTION_CHANGE_OF_DEVICE_FAILED
public static final int CONNECTION_VARY_ON_OR_VARY_OFF_FAILED
public static final int CONNECTION_MESSAGE_QUEUE_DOES_NOT_EXIST
public static final int CONNECTION_STARTUP_FOR_S36_WSF_RECEIVED
public static final int CONNECTION_SESSION_REJECTED
public static final int CONNECTION_SECURITY_FAILURE_ON_SESSION_ATTEMPT
public static final int CONNECTION_AUTOMATIC_SIGNON_REJECTED
public static final int CONNECTION_AUTOMATIC_CONFIGURATION_FAILED_OR_NOT_ALLOWED
public static final int CONNECTION_SOURCE_SYSTEM_AT_INCOMPATIBLE_RELEASE
public static final int ENCRYPTION_NONE
public static final int ENCRYPTION_NOKEY
public static final int ENCRYPTION_40BIT
public static final int ENCRYPTION_56BIT
public static final int ENCRYPTION_128BIT
public static final int ENCRYPTION_168BIT
public int bmtuSizeReported
Method Detail |
public boolean getContentionResolution()
public int GetConnType()
public int GetEncryptionLevel()
public java.lang.String GetName()
public java.lang.String GetLabel()
public int GetCodePage()
public java.lang.String GetHost()
public int GetPort()
public int getBackupIndex()
public java.lang.String getHost(int backup)
backup
- Index for backup server
public int getPort(int backup)
backup
- Index for backup server
public java.lang.String getLUName(int backup)
backup
- Index for backup server
public int GetTimeout()
public boolean IsCommStarted()
public boolean IsCommReady()
public int GetCommStatus()
public boolean IsDeviceNameReady()
GetDeviceName()
public java.lang.String GetDeviceName()
IsDeviceNameReady()
public boolean IsWorkstationIDReady()
GetDeviceName()
public java.lang.String GetWorkstationID()
public void StartCommunication()
public void StopCommunication()
public void RegisterCommEvent(ECLCommNotify notify, boolean initEvent)
ECLCommNotify objects can be unregistered using the UnregisterCommEvent() method.
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.UnregisterCommEvent(com.ibm.eNetwork.ECL.ECLCommNotify)
,
ECLCommNotify
public void UnregisterCommEvent(ECLCommNotify notify)
notify
- ECLCommNotify object which should be
unregistered.RegisterCommEvent(com.ibm.eNetwork.ECL.ECLCommNotify, boolean)
,
ECLCommNotify
public java.util.Properties getProperties()
public java.lang.String GetCICSServer()
public int GetCICSGWCodePage()
public java.lang.String getCertificateName()
setCertificateName(java.lang.String)
public void setCertificateName(java.lang.String name)
name
- The client certificate name.getCertificateName()
public boolean getCertificateNameAdmin()
public boolean getignoreWellKnownTrustedCAsOption()
public void setCertificatePromptHowOften(java.lang.String howOften)
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 |
howOften
- The value for how often the client certificate should be promptedpublic boolean getCertificatePromptHowOftenAdmin()
setCertificatePromptHowOften(java.lang.String)
public void setUseJSSE(boolean b)
public boolean isUseJSSE()
public void setJSSETrustStore(java.lang.String s)
public java.lang.String getJSSETrustStore()
public void setJSSETrustStoreType(java.lang.String s)
public java.lang.String getJSSETrustStoreType()
public void setJSSETrustStorePassword(java.lang.String s)
public java.lang.String getJSSETrustStorePassword()
public static void setUseJSSENonFIPSMode(boolean b)
public static boolean isUseJSSENonFIPSMode()
public java.lang.String customAIDHandlingList()
public boolean isTCPNODELAY()
public boolean isKeepAlive()
public boolean isENPTUI()
public void SetUnicodeDataStreamEnabled(boolean unicode)
unicode
- Unicode Data Stream is enabled or notGetUnicodeDataStreamEnabled()
public boolean GetUnicodeDataStreamEnabled()
SetUnicodeDataStreamEnabled(boolean)
public boolean isPrintDestination()
public boolean isSeparateFiles()
public boolean isQuietMode()
public void setProxyUserID(java.lang.String newUserID)
This is a generic call that is used for the following proxy types:
newUserID
- The user id definded on the proxy servergetProxyUserID()
public java.lang.String getProxyUserID()
This is a generic call that is used for the following proxy types:
setProxyUserID(java.lang.String)
public void setSocksV4UserID(java.lang.String newUserID)
This call that is only used for a Socks v4 proxy server
newUserID
- The user id used by the Socks v4 servergetProxyUserID()
public java.lang.String getSocksV4UserID()
This call that is only used for a Socks v4 proxy server
setProxyUserID(java.lang.String)
public void setProxyUserPassword(java.lang.String newUserPW)
This is a generic call that is use for the following proxy types:
newUserPW
- The password associated with the user id definded on the proxy servergetProxyUserPassword()
public java.lang.String getProxyUserPassword()
This is a generic call that is use for the following proxy types:
setProxyUserPassword(java.lang.String)
public void setProxyType(java.lang.String newProxyType)
newProxyType
- The type of proxy to connect throughgetProxyType()
public java.lang.String getProxyType()
setProxyType(java.lang.String)
public void setProxyServerName(java.lang.String hostName)
hostName
- The host name of the proxy server as either a fully qualified name or an IP addressgetProxyServerName()
public java.lang.String getProxyServerName()
setProxyServerName(java.lang.String)
public void setProxyServerPort(java.lang.String port)
port
- The port number to connect to on the proxy servergetProxyServerPort()
public java.lang.String getProxyServerPort()
setProxyServerPort(java.lang.String)
public void setProxyAuthenMethod(java.lang.String authMethod)
The valid values when using Socks v5 proxies are:
The valid values when using HTTP proxies are:
authMethod
- The authenitcation method to use when connecting to the proxy servergetProxyAuthenMethod()
public java.lang.String getProxyAuthenMethod()
setProxyAuthenMethod(java.lang.String)
public void setTransportReceiveBuffSize(int buffSize)
buffSize
- The transport receive buffer size.getTransportReceiveBuffSize()
public int getTransportReceiveBuffSize()
setTransportReceiveBuffSize(int)
public void SetConnectionTimeout(int connectionTimeout)
connectionTimeout
- The connection timeout value in second#getConnectionTimeout()
public int GetConnectionTimeout()
#setConnectionTimeout(int)
public void setLastHostWithoutTimeout(boolean isLastHostWithoutTimeout)
isLastHostWithoutTimeout
- connect to the last configured host without timeoutisLastHostWithoutTimeout()
public boolean isLastHostWithoutTimeout()
setLastHostWithoutTimeout(boolean)
public void setTimeoutNoDataInitialization(boolean timeout)
timeout
- timeout if no data is received at the session initialization time.isTimeoutNoDataInitialization()
public boolean isTimeoutNoDataInitialization()
setTimeoutNoDataInitialization(boolean)
public void setSSOType(java.lang.String ssoType)
ssoType
- The type of single sign-on methodgetSSOType()
public java.lang.String getSSOType()
setSSOType(java.lang.String)
public void setKerberosTicket(byte[] ticket, int length)
ticket
- A byte array containing the Kerberos service ticket
length The length of the above ticketpublic java.lang.String getStartupResponseRecord()
public void SetTrustedSignerPath(java.lang.String path)
public java.lang.String GetTrustedSignerPath()
public void SetSSLP12Password(java.lang.String pw)
public java.lang.String GetSSLP12Password()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |