zowe-cli-cics-deploy-plugin/lib/api/BundleContent/NodejsappBundlePart.d.ts

IBM CICS Bundle generation and deployment for Zowe CLI

import { BundlePart } from "./BundlePart";
import { IHandlerParameters } from "@zowe/imperative";
/**
 * Interface to represent the manifest data for a NODEJSAPP BundlePart.
 *
 * @export
 * @interface INodejsappType
 */
interface INodejsappType {
    nodejsapp: INodejsappContents;
}
/**
 * Interface to represent the manifest data contents for a NODEJSAPP BundlePart.
 *
 * @export
 * @interface INodejsappContents
 */
interface INodejsappContents {
    name: string;
    xmlns: string;
    startscript: string;
    profile: string;
    lerunopts: string;
}
/**
 * Class to represent a CICS NODEJSAPP BundlePart.
 *
 * @export
 * @class NodejsappBundlePart
 */
export declare class NodejsappBundlePart extends BundlePart {
    private static MAX_NODEJSAPP_LEN;
    private static MAX_PORT;
    private nodejsappsDir;
    private nodejsappFile;
    private nodejsappProfile;
    private nodejsappProfileLocal;
    private partXML;
    private profile;
    private profileAlreadyExists;
    private partXMLAlreadyExists;
    /**
     * Constructor for creating a NodejsappBundlePart.
     *
     * @param {string} directory - The bundle directory.
     * @param {string} name - The name of the NODEJSAPP BundlePart.
     * @param {string} startscript - The path of the start script for the NODEJSAPP.
     * @param {number} port - An optional port number to be added to the profile for the NODEJSAPP.
     * @param {boolean} overwrite - Can existing files be replaced?
     * @param {IHandlerParameters} params - The current Imperative handler parameters
     * @static
     * @throws ImperativeError
     * @memberof NodejsappBundlePart
     */
    constructor(directory: string, name: string, startscript: string, port: number, overwrite: boolean, params?: IHandlerParameters);
    /**
     * Get the NODEJSAPP BundlePart.
     *
     * @returns {INodejsappType}
     * @throws ImperativeError
     * @memberof NodejsappBundlePart
     */
    getPart(): INodejsappType;
    /**
     * Get the NODEJSAPP BundlePart XML.
     *
     * @returns {string}
     * @throws ImperativeError
     * @memberof NodejsappBundlePart
     */
    getPartXML(): string;
    /**
     * Get the NODEJSAPP Profile text.
     *
     * @returns {string}
     * @throws ImperativeError
     * @memberof NodejsappBundlePart
     */
    getProfile(): string;
    /**
     * Perform whatever validation can be done in advance of attempting to save the
     * Nodejsapp, thereby reducing the possibility of a failure after some of the
     * bundle parts have already been persisted to the file system.
     *
     * @throws ImperativeError
     * @memberof Manifest
     */
    prepareForSave(): void;
    /**
     * Save the NODEJSAPP BundlePart. Any changes that have been made will be persisted.
     *
     * @throws ImperativeError
     * @memberof NodejsappBundlePart
     */
    save(): void;
    private createNodejsappXML;
    private createNodejsappProfile;
    private validatePort;
}
export {};