@zowe/zosmf-for-zowe-sdk/lib/ZosmfSession.js

Zowe SDK to interact with the z/OS Management Facility

"use strict";
/*
* 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.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ZosmfSession = void 0;
const imperative_1 = require("@zowe/imperative");
/**
 * Utility Methods for Zowe
 * @export
 */
class ZosmfSession {
    /**
     * Given command line arguments, create an session configuration object.
     * @param {ICommandArguments} args - The arguments specified by the user
     * @returns {ISession} - A session configuration to be used for a session.
     */
    static createSessCfgFromArgs(args) {
        const msToSecs = 1000;
        return {
            rejectUnauthorized: args.rejectUnauthorized,
            basePath: args.basePath,
            protocol: args.protocol ? args.protocol.toLowerCase() : 'https',
            requestCompletionTimeout: isNaN(args.completionTimeout) ? undefined : args.completionTimeout * msToSecs,
            socketConnectTimeout: isNaN(args.establishConnectionTimeout) ? undefined : args.establishConnectionTimeout * msToSecs,
            certAccount: args.certAccount,
        };
    }
    static get log() {
        return imperative_1.Logger.getAppLogger();
    }
}
exports.ZosmfSession = ZosmfSession;
ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP = "Zosmf Connection Options";
/**
 * Option used in profile creation and commands for hostname for z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_HOST = {
    name: "host",
    aliases: ["H"],
    description: "The z/OSMF server host name.",
    type: "string",
    required: false,
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used in profile creation and commands for port for z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_PORT = {
    name: "port",
    aliases: ["P"],
    description: "The z/OSMF server port.",
    type: "number",
    defaultValue: 443,
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used in profile creation and commands for username / ID for z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_USER = {
    name: "user",
    aliases: ["u"],
    description: "Mainframe (z/OSMF) user name, which can be the same as your TSO login.",
    type: "string",
    required: false,
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used in profile creation and commands for password/passphrase for z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_PASSWORD = {
    name: "password",
    aliases: ["pass", "pw"],
    description: "Mainframe (z/OSMF) password, which can be the same as your TSO password.",
    type: "string",
    required: false,
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED = {
    name: "reject-unauthorized",
    aliases: ["ru"],
    description: "Reject self-signed certificates.",
    type: "boolean",
    defaultValue: true,
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used in profile creation and commands for base path setting for connecting to z/OSMF
 */
ZosmfSession.ZOSMF_OPTION_BASE_PATH = {
    name: "base-path",
    aliases: ["bp"],
    description: "The base path for your API mediation layer instance." +
        " Specify this option to prepend the base path to all z/OSMF resources when making REST requests." +
        " Do not specify this option if you are not using an API mediation layer.",
    type: "string",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used to specify HTTP or HTTPS Protocol
 */
ZosmfSession.ZOSMF_OPTION_PROTOCOL = {
    name: "protocol",
    description: "The protocol used (HTTP or HTTPS)",
    type: "string",
    defaultValue: "https",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP,
    allowableValues: { values: ["http", "https"], caseSensitive: false }
};
/**
 * Option used to specify the path to the certificate file for authentication
 */
ZosmfSession.ZOSMF_OPTION_CERT_FILE = {
    name: "cert-file",
    description: "The file path to a certificate file to use for authentication",
    type: "existingLocalFile",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used to specify the path to the cert's key file for authentication
 */
ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE = {
    name: "cert-key-file",
    description: "The file path to a certificate key file to use for authentication",
    type: "existingLocalFile",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used to specify the account name for PKCS 12 certificate stored in credential manager
 */
ZosmfSession.ZOSMF_OPTION_CERT_ACCOUNT = {
    name: "cert-account",
    description: "The account name for PKCS 12 certificate stored in credential manager",
    type: "string",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option used to specify the path to the certificate file for authentication
 */
// public static ZOSMF_OPTION_CERT_FILE_PASSPHRASE: ICommandOptionDefinition = {
//     name: "cert-file-passphrase",
//     description: "The passphrase to decrypt a certificate file to use for authentication",
//     type: "string",
//     group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
// };
/**
 * Option to specify a request completion timeout
 */
ZosmfSession.ZOSMF_OPTION_COMPLETION_TIMEOUT = {
    name: "completion-timeout",
    aliases: ["cto"],
    description: "The amount in time, in seconds, a REST operation should wait to complete before timing out",
    type: "number",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Option to specify a request establishment timeout
 */
ZosmfSession.ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT = {
    name: "establish-connection-timeout",
    aliases: ["ecto"],
    description: "The amount of time, in seconds, a REST operation should wait while connecting to the server before timing out",
    type: "number",
    group: ZosmfSession.ZOSMF_CONNECTION_OPTION_GROUP
};
/**
 * Options related to connecting to z/OSMF
 * These options can be filled in if the user creates a profile
 */
ZosmfSession.ZOSMF_CONNECTION_OPTIONS = [
    ZosmfSession.ZOSMF_OPTION_HOST,
    ZosmfSession.ZOSMF_OPTION_PORT,
    ZosmfSession.ZOSMF_OPTION_USER,
    ZosmfSession.ZOSMF_OPTION_PASSWORD,
    ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED,
    ZosmfSession.ZOSMF_OPTION_BASE_PATH,
    ZosmfSession.ZOSMF_OPTION_PROTOCOL,
    ZosmfSession.ZOSMF_OPTION_CERT_FILE,
    ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE,
    ZosmfSession.ZOSMF_OPTION_CERT_ACCOUNT,
    ZosmfSession.ZOSMF_OPTION_COMPLETION_TIMEOUT,
    ZosmfSession.ZOSMF_OPTION_ESTABLISH_CONNECTION_TIMEOUT,
    // ZosmfSession.ZOSMF_OPTION_CERT_FILE_PASSPHRASE
];
//# sourceMappingURL=ZosmfSession.js.map