/
ConsoleValidator.ts
128 lines (118 loc) · 4.64 KB
/
ConsoleValidator.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { ICollectParms, IIssueParms } from "./";
import { IZosmfIssueParms } from "./doc/zosmf/IZosmfIssueParms";
import { AbstractSession, ImperativeExpect, TextUtils } from "@zowe/imperative";
import { noSession } from "@zowe/core-for-zowe-sdk";
import { noCollectParameters, noCommandKey, noConsoleInput, noConsoleName, noZosmfInput } from "./ConsoleConstants";
/**
* Class validates parameters for console commands
* @export
* @class ConsoleValidator
*/
export class ConsoleValidator {
/**
* Validate supplied parameters
* @static
* @param {AbstractSession} session representing connection to this api
* @param {string} consoleName name of the EMCS console that is used to issue the command
* @param {IZosmfIssueParms} commandParms synchronous console issue parameters, @see {IZosmfIssueParms}
* @memberof
*/
public static validateCommonParms(session: AbstractSession, consoleName: string, commandParms: IZosmfIssueParms) {
this.validateSession(session);
this.validateConsoleName(consoleName);
ImperativeExpect.toNotBeNullOrUndefined(commandParms, noZosmfInput.message);
}
/**
* Validate supplied parameters
* @static
* @param {AbstractSession} session representing connection to this api
* @param {IIssueParms} parms console issue parameters, @see {IIssueParms}
* @memberof ConsoleValidator
*/
public static validateIssueParms(session: AbstractSession, parms: IIssueParms) {
this.validateSession(session);
this.validateIssueParm(parms);
}
/**
* Validate supplied parameters
* @static
* @param {AbstractSession} session representing connection to this api
* @param {string} theCommand command to issue
* @memberof ConsoleValidator
*/
public static validateIssueSimpleParms(session: AbstractSession, theCommand: string) {
this.validateSession(session);
ImperativeExpect.toNotBeNullOrUndefined(theCommand, noConsoleInput.message);
}
/**
* Validate supplied parameters
* @static
* @param {ICollectParms} parms console collect parameters, @see {ICollectParms}
* @memberof ConsoleValidator
*/
public static validateCollectParm(parms: ICollectParms) {
ImperativeExpect.toNotBeNullOrUndefined(parms, noCollectParameters.message);
}
/**
* Validate supplied parameters
* @static
* @param {IIssueParms} parms console issue parameters, @see {IIssueParms}
* @memberof ConsoleValidator
*/
public static validateIssueParm(parms: IIssueParms) {
ImperativeExpect.toNotBeNullOrUndefined(parms, noConsoleInput.message);
}
/**
* Validate supplied parameters
* @static
* @param {AbstractSession} session representing connection to this api
* @param {string} consoleName name of the EMCS console that is used to issue the command
* @param {string} commandResponseKey command response key from the Issue Command request
* @memberof ConsoleValidator
*/
public static validateCollectCommonParms(session: AbstractSession, consoleName: string, commandResponseKey: string) {
this.validateSession(session);
this.validateConsoleName(consoleName);
ImperativeExpect.toNotBeNullOrUndefined(commandResponseKey, noCommandKey.message);
}
/**
* Validate supplied parameters
* @static
* @param {AbstractSession} session representing connection to this api
* @param {ICollectParms} parms console collect parameters, @see {ICollectParms}
* @memberof ConsoleValidator
*/
public static validateCollectParms(session: AbstractSession, parms: ICollectParms) {
this.validateSession(session);
this.validateCollectParm(parms);
}
/**
* Validate session
* @static
* @param {AbstractSession} session representing connection to this api
* @memberof ConsoleValidator
*/
private static validateSession(session: AbstractSession) {
ImperativeExpect.toNotBeNullOrUndefined(session,
TextUtils.formatMessage(noSession.message));
}
/**
* Validate console name
* @static
* @param {string} consoleName
* @memberof ConsoleValidator
*/
private static validateConsoleName(consoleName: string) {
ImperativeExpect.toNotBeNullOrUndefined(consoleName, noConsoleName.message);
}
}