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

### Hierarchy

- SshBaseHandler

### Implements

- any

## Index

### Properties

- mArguments
- mHandlerParams
- mSession

### Accessors

- console
- data
- format
- progress

### Methods

- fail
- process
- processCmd

## Properties

### Protected mArguments

mArguments: ICommandArguments

- Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:44

Command line arguments passed

### Protected mHandlerParams

mHandlerParams: IHandlerParameters

- Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:49

Full set of command handler parameters from imperative

### Protected mSession

mSession: SshSession

- Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:39

The session creating from the command line arguments / profile

## Accessors

### console

- get console(): IHandlerResponseConsoleApi

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:177

  Returns the console interface for the command handler

  #### Returns IHandlerResponseConsoleApi

### data

- get data(): IHandlerResponseDataApi

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:193

  Returns the format interface for the command handler

  #### Returns IHandlerResponseDataApi

### format

- get format(): IHandlerFormatOutputApi

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:185

  Returns the format interface for the command handler

  #### Returns IHandlerFormatOutputApi

### progress

- get progress(): IHandlerProgressApi

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:201

  Returns the format interface for the command handler

  #### Returns IHandlerProgressApi

## Methods

### fail

- fail(err: IImperativeError): void

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:169

  Fail the command with an imperative error

  #### Parameters

  - ##### err: IImperativeError

    the imperative error parameters

  #### Returns void

### process

- process(commandParameters: IHandlerParameters): Promise<void>

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:59

  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>

- - Defined in @zowe/zos-uss-for-zowe-sdk/src/SshBaseHandler.ts:211

  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