Class: NVTClient

• Inheritance
• Description
• Class protocol
  • Signal constants
  • accessing
  • class initialization
  • debugging
  • instance creation
  • queries
• Instance protocol
  • accessing
  • connection setup
  • defaults
  • error handling
  • initialization
  • private - commands & responses
  • private - connection setup
  • queries

Inheritance:

   Object
   |
   +--NVTClient
      |
      +--FTPClient
      |
      +--SMTPClient

Package:

stx:goodies/communication

Category:

Net-Communication-Support

Version:

rev: 1.32 date: 2024/04/25 13:47:44

user: stefan

file: NVTClient.st directory: goodies/communication

module: stx stc-classLibrary: communication

Description:

Abstract superclass for Network Virtual Terminal protocol clients;
i.e. FTPCLient, SMTPClient, TelnetClient etc..

copyright
COPYRIGHT (c) 2002 by eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 commandErrorSignal

return the parent of all errors related to command execution

 connectFailedSignal

return the parent of all errors related to connection setup

 loginFailedSignal

return the signal raised if the login fails

 netErrorSignal

return the parent of all net errors

 timeoutErrorSignal

return the signal raised on response timeout

 transmissionErrorSignal

return the parent signal related to all data transmission errors

 unimplementedOperationErrorSignal

return the signal raised if some command is not implemented by
the partner (should not happen)

 SSL

 STARTTLS

 STARTTLS_OPTIONAL

 initialize

Verbose := true.

Usage example(s):

self initialize. Verbose := true.

 verbose: aBoolean

self verbose:false.
self verbose:true.

 connectTo: host

open a connection to some host as anonymous user

 new

return a new ftpClient instance

 openOnHostNamed: host

open a connection to some host; do not login

 isAbstract

Return if this class is an abstract class.
True is returned here for myself only; false for subclasses.
Abstract subclasses must redefine this again.

Instance protocol:

 password

 password: something

 tlsEncryption

 tlsEncryption: aSymbol

Modified (format): / 14-02-2020 / 19:12:39 / Stefan Vogel

 useSSL

connect via SSL

 useSTARTTLS

connect via TLS

 useSTARTTLSIfPossible

connect via TLS, if possible. If not use an unencrypted connection

 userName: aString

 connectTo: host

connect to some user as anonymous user

 connectTo: host port: portNrOrNil user: user password: pw

connect to some host as some user.
host may also be in the format: 'hostName:portNr'.

 connectTo: host user: user

connect to some host as user

 connectTo: host user: user password: pw

connect to some host as user

 connectToHost: host

open a connection; do not login: - VW compatibility

 connectionTimeout: millisOrTimeDurationOrNil

set timeout for establishing a connection. If the millis arg is nonNil,
stop trying to connect after that many milliseconds and raise an exception

 useIPv4Only

 useIPv6Only

 defaultPassword

** This method must be redefined in concrete classes (subclassResponsibility) **

 defaultPort

** This method must be redefined in concrete classes (subclassResponsibility) **

 defaultUser

** This method must be redefined in concrete classes (subclassResponsibility) **

 commandFailed

 connectionFailed

 errorStringFromResponse

 loginFailed

 responseTimeoutError

 unimplementedOperationError

 initialize

(comment from inherited method)
just to ignore initialize to objects which do not need it

 clearReplyPending

 getResponse

wait for and read a response.
Leaves result in lastResponse (ascii) and lastReplyCode (numeric).
MultiLine responses are collected in responseLines.
Finally, handleReplyCode (redefinable) is asked to xlate from response code to
exception (if any)

 getResponseHandlingReplyCodesWith: handleReplyCodeBlock

wait for and read a response.
Leaves result in lastResponse (ascii) and lastReplyCode (numeric).
MultiLine responses are collected in responseLines.
Finally, handleReplyCode (redefinable) is asked to xlate from response code to
exception (if any)

 handleReplyCode: replyCode

intermediate message; final reply code follows

 sendCommand: aCommandString

send a command, wait for response.
Leaves result in lastResponse (ascii) and lastReplyCode (numeric)

Usage example(s):

|ftp| ftp := FTPClient new. ftp connectTo:'porty' user:'anonymous'. ftp sendCommand:'SYST'. ftp close

Usage example(s):

|ftp| ftp := FTPClient new. ftp connectTo:'porty' user:'anonymous'. ftp sendCommand:'HELP'. ftp close

 sendCommandNoWait: aCommandString

send a command, do not wait for response.

 sendLine: aLine

send a line with CRLF

 close

disconnect - if redefined (to send a BYE message), do not forget to
invoke me here as well

 connection

 doConnect

connect, using the previously defined userName, password and hostName

 getInitialConnectResponse

invoked right after the socket connection has been setup;
subclass implementation should read all initial hello-bla

** This method must be redefined in concrete classes (subclassResponsibility) **

 performLoginSequence

invoked after the socket connection has been setup and the initial
connect response blah has been read.
A subclass implementation should perform whatever login sequence has to be performed.

** This method must be redefined in concrete classes (subclassResponsibility) **

 sendGoodByeCommand

invoked before the socket connection is shutDown.
A subclass implementation may want to redefine this for a graceful goodBy
(typically sending a quit-command)

 isConnected