Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SshBaseHandler

This class is used by the various handlers in the project as the base class for their implementation.

Hierarchy

  • SshBaseHandler

Implements

  • ICommandHandler

Index

Properties

Protected mArguments

mArguments: ICommandArguments

Command line arguments passed

Protected mHandlerParams

mHandlerParams: IHandlerParameters

Full set of command handler parameters from imperative

Protected mSession

mSession: SshSession

The session creating from the command line arguments / profile

Protected mSshProfile

mSshProfile: IProfile

Loaded z/OS SSH profile if needed

Accessors

console

  • get console(): IHandlerResponseConsoleApi

data

  • get data(): IHandlerResponseDataApi

format

  • get format(): IHandlerFormatOutputApi

progress

  • get progress(): IHandlerProgressApi

Methods

fail

  • fail(err: IImperativeError): void

process

  • process(commandParameters: IHandlerParameters): Promise<void>
  • This will grab the arguments and create a session before calling the subclass {@link SshBaseHandler#processWithSession} method.

    Parameters

    • commandParameters: IHandlerParameters

      Command parameters sent by imperative.

    Returns Promise<void>

Abstract processCmd

  • processCmd(commandParameters: IHandlerParameters): Promise<void>
  • This is called by the {@link SshBaseHandler#process} after it creates a session.

    Parameters

    • commandParameters: IHandlerParameters

      Command parameters sent to the handler.

    Returns Promise<void>

Generated using TypeDoc