Class NodeCommandHandlers

Hierarchy (View Summary)

CommandHandler
- NodeCommandHandlers

Constructors

constructor

new NodeCommandHandlers(
    leaseManager: LockManager,
    remoteConfigManager: RemoteConfigManager,
    tasks: NodeCommandTasks,
    configs: NodeCommandConfigs,
): NodeCommandHandlers
Parameters
- leaseManager: LockManager
- remoteConfigManager: RemoteConfigManager
- tasks: NodeCommandTasks
- configs: NodeCommandConfigs
Returns NodeCommandHandlers
Overrides CommandHandler.constructor
- Defined in src/commands/node/handlers.ts:37

Properties

`Protected` `Readonly`_configMaps

_configMaps: Map<string, any> = ...

consensusNodes

consensusNodes: ConsensusNode[]

contexts

contexts: string[]

`Optional` `Readonly`logger

logger?: SoloLogger

Methods

add

add(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:574

addExecute

addExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:638

addPrepare

addPrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:593

addSubmitTransactions

addSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:615

changeAllNodeStates

changeAllNodeStates(state: ConsensusNodeStates): SoloListrTask<any>
Changes the state from all consensus nodes components in remote config.
Parameters
- state: ConsensusNodeStates
  to which to change the consensus node component
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:921

commandAction

commandAction(
    argv: any,
    actionTasks: any,
    options: any,
    errorString: string,
    lease: Lock,
): Promise<void>
Parameters
- argv: any
- actionTasks: any
- options: any
- errorString: string
- lease: Lock
Returns Promise<void>
Inherited from CommandHandler.commandAction
- Defined in src/core/command-handler.ts:29

delete

delete(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:485

deleteExecute

deleteExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:551

deletePrepare

deletePrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:506

deleteSubmitTransactions

deleteSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:528

downloadGeneratedFiles

downloadGeneratedFiles(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:286

freeze

freeze(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:848

freezeUpgrade

freezeUpgrade(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:265

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Parameters
- configName: string
Returns string[]
Inherited from CommandHandler.getUnusedConfigs
- Defined in src/core/command-handler.ts:88

keys

keys(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:740

logs

logs(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:668

prepareUpgrade

prepareUpgrade(argv: ArgvStruct): Promise<boolean>
******** Handlers *********
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:242

refresh

refresh(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:709

removeNodeAndProxies

removeNodeAndProxies(): SoloListrTask<any>
Removes the consensus node, envoy and haproxy components from remote config.

Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:902

restart

restart(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:873

setup

setup(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:820

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = ...
Returns string[]
Inherited from CommandHandler.setupHomeDirectory
- Defined in src/core/command-handler.ts:55

setupHomeDirectoryTask

setupHomeDirectoryTask(): { task: () => Promise<void>; title: string }
Returns { task: () => Promise<void>; title: string }
Inherited from CommandHandler.setupHomeDirectoryTask
- Defined in src/core/command-handler.ts:79

start

start(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:790

states

states(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:687

stop

stop(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:763

update

update(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:309

updateExecute

updateExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:370

updatePrepare

updatePrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:328

updateSubmitTransactions

updateSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:349

upgrade

upgrade(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:464

upgradeExecute

upgradeExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:437

upgradePrepare

upgradePrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:397

upgradeSubmitTransactions

upgradeSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:416

validateAllNodeStates

validateAllNodeStates(
    __namedParameters: {
        acceptedStates?: ConsensusNodeStates[];
        excludedStates?: ConsensusNodeStates[];
    },
): SoloListrTask<any>
Creates tasks to validate that each node state is either one of the accepted states or not one of the excluded.
Parameters
- __namedParameters: {
  acceptedStates?: ConsensusNodeStates[];
  excludedStates?: ConsensusNodeStates[];
  }
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:957

validateSingleNodeState

validateSingleNodeState(
    __namedParameters: {
        acceptedStates?: ConsensusNodeStates[];
        excludedStates?: ConsensusNodeStates[];
    },
): SoloListrTask<any>
Creates tasks to validate that specific node state is either one of the accepted states or not one of the excluded.
Parameters
- __namedParameters: {
  acceptedStates?: ConsensusNodeStates[];
  excludedStates?: ConsensusNodeStates[];
  }
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:999

Class NodeCommandHandlers

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommandHandlers

Properties

Protected Readonly_configMaps

consensusNodes

contexts

Optional Readonlylogger

Methods

add

Parameters

Returns Promise<boolean>

addExecute

Parameters

Returns Promise<boolean>

addPrepare

Parameters

Returns Promise<boolean>

addSubmitTransactions

Parameters

Returns Promise<boolean>

changeAllNodeStates

Parameters

Returns SoloListrTask<any>

commandAction

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<boolean>

deleteExecute

Parameters

Returns Promise<boolean>

deletePrepare

Parameters

Returns Promise<boolean>

deleteSubmitTransactions

Parameters

Returns Promise<boolean>

downloadGeneratedFiles

Parameters

Returns Promise<boolean>

freeze

Parameters

Returns Promise<boolean>

freezeUpgrade

Parameters

Returns Promise<boolean>

getUnusedConfigs

Parameters

Returns string[]

keys

Parameters

Returns Promise<boolean>

logs

Parameters

Returns Promise<boolean>

prepareUpgrade

Parameters

Returns Promise<boolean>

refresh

Parameters

Returns Promise<boolean>

removeNodeAndProxies

Returns SoloListrTask<any>

restart

Parameters

Returns Promise<boolean>

setup

Parameters

Returns Promise<boolean>

setupHomeDirectory

Parameters

`Protected` `Readonly`_configMaps

`Optional` `Readonly`logger