Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [Telnet] >  [OutboundAdapter]
Private  Storage   

class EnsLib.Telnet.OutboundAdapter extends Ens.OutboundAdapter

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 15 11


Summary

Properties
%CredentialsObj %WarnedLatest BusinessHost ConnectTimeout
Credentials KeepaliveInterval LoginConfirmation LoginFailNotice
LoginMacro LoginPasswordMacro LoginPrompt PasswordPrompt
RegistryID ResponseIdleTimeout ResponseTimeout SSLConfig
SignonScreen StayConnected Telnet TelnetPort
TelnetServer

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
Connect CredentialsSet Disconnect EnumerateSettingsClose
EnumerateSettingsExecute EnumerateSettingsFetch GetSettings OnDisconnect
OnInit OnKeepalive OnTearDown SendMessageString
asHex fromHex quote writeLoginMacro


Parameters

• parameter SETTINGS = "TelnetServer:Basic,TelnetPort:Basic,Credentials:Basic:credentialsSelector,SSLConfig:Connection:sslConfigSelector,LoginPrompt,PasswordPrompt,LoginConfirmation,LoginFailNotice,StayConnected,ConnectTimeout,ResponseTimeout,ResponseIdleTimeout";
These properties can be configured or set by the associated Business Operation

Properties

• property ConnectTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds to wait on each connection attempt
• property LoginConfirmation as %String [ InitialExpression = "Last login: " ];
Text to wait for to verify successful login
• property LoginFailNotice as %String [ InitialExpression = "Login incorrect" ];
Text to wait for to detect failed login
• property LoginMacro as %String;
Optional macro to evaluate to log in after detecting the Login (Username) Prompt string The following variables are defined in the context of the macro: %Username=..%CredentialsObj.Username, %Password=..%CredentialsObj.Password, %Adapter=Adapter object. Text enclosed in &Raw() will be sent out without escaping or translation
• property LoginPasswordMacro as %String;
Optional macro to evaluate to log in after detecting the Password Prompt string The following variables are defined in the context of the macro: %Username=..%CredentialsObj.Username, %Password=..%CredentialsObj.Password, %Adapter=Adapter object. Text enclosed in &Raw() will be sent out without escaping or translation
• property LoginPrompt as %String [ InitialExpression = "login:" ];
Prompt to wait for before submitting Username to the remote host
• property PasswordPrompt as %String [ InitialExpression = "Password:" ];
Prompt to wait for before submitting Password to the remote host
• property ResponseIdleTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds of idle time to tolerate while waiting for a complete response
• property ResponseTimeout as %Numeric(MINVAL=-1) [ InitialExpression = 5 ];
Number of seconds to wait for a complete response. Setting the timeout to -1 means wait forever.
• property SSLConfig as %String;
The name of an existing SSL/TLS system configuration set to use (Secure Socket Layer / Transport Layer Security, configured via the system portal's Security Management page).

If your SSL Configuration requires you to supply a password for the local private key file, specify it in the Private key password property of the SSL/TLS Configuration.

• property SignonScreen as %String;
Holds a record of the signon screen received from the remote host after sending username & password.
• property StayConnected as %Numeric(MINVAL=-1) [ InitialExpression = -1 ];
If non-zero, stay connected to the remote system between handling Requests until idle for this number of seconds. A value of -1 means never disconnect.
• property Telnet as %Net.TelnetStream;
Telnet Session object
• property TelnetPort as %Integer [ InitialExpression = 23 ];
Server port to connect to
• property TelnetServer as %String(MAXLEN=1500) [ Required ];
Server to connect to

Methods

• method Connect(pTimeout As %Numeric) as %Status
Prepare for Telnet transfer by logging in, setting the directory and transfer mode
• method Disconnect() as %Status
Disconnect from the datasource
• method OnDisconnect(pSocket As %IO.Socket, pIntentional As %Boolean, pSCReason As %Status)
Notify of Disconnect from the datasource
• method OnInit() as %Status
This user callback method is called just after %OnNew()
• method OnKeepalive(pUnused As %Status) as %Status
This method is called from the Host.OnTask() method. It will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive().
• method OnTearDown() as %Status
This user callback method is called just before %OnClose()
• method SendMessageString(pRequestString As %String, Output pResponseString As %String, ByRef pTimeout As %Numeric = ..ResponseTimeout, pIdleTimeout As %Numeric = ..ResponseIdleTimeout, pInsensitive As %Boolean, Output pWhich As %Integer, pTarget...) as %Status
Send the given pRequestString, and return in pResponseString any data received back up until pTimeout seconds have elapsed, or until pIdleTimeout seconds elapse with no further data received, or up until any of the optional pTarget strings is encountered.

If pTarget strings are provided the pWhich output argument will contain an integer indicating which of them was matched. A value of 0 in pWhich indicates that none was matched and therefore the timeout expired or an error occurred.

Setting pInsensitive=1 means the pTarget strings will match data received in a case-insensitive way.

To make this method return without waiting for any reply data, call it with pTimeout=0.

• classmethod asHex(pStr) as %String
• classmethod fromHex(pLine)
• classmethod quote(pStr) as %String
• method writeLoginMacro(pMacro As %String, pFlush As %Boolean, Output pSC As %Status) as %String


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.