@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/commands/create/create-connection/CreateConnection.definition.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var EBGSession = require('../../../sessions/EBGSession.js');
var EndevorSession = require('../../../sessions/EndevorSession.js');
var EndevorOptions = require('../../../options/EndevorOptions.js');
var EBGOptions = require('../../../options/EBGOptions.js');
var EndevorConnectionOptions = require('../../../options/EndevorConnectionOptions.js');

/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
const CreateConnectionDefinition = {
    name: "endevor-connection",
    aliases: ["connection", "con"],
    type: "command",
    handler: __dirname + "/CreateConnection.handler",
    description: "Create new Endevor connection for Endevor Bridge for Git.",
    summary: "Create new Endevor connection",
    positionals: [EBGOptions.EBGOptions.CONNECTION],
    profile: {
        optional: [EBGSession.EBGSession.PROFILE_TYPE, EndevorSession.EndevorSession.PROFILE_TYPE],
    },
    options: [EndevorOptions.EndevorOptions.ENDEVOR_INSTANCE].concat(EndevorSession.EndevorSession.ENDEVOR_CONNECTION_OPTIONS, EndevorConnectionOptions.EndevorConnectionOptions.LOGIN_METHOD),
    examples: [
        {
            description: "Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile",
            options: "MY-CONNECTION --endevor-instance INSTANCE",
        },
        {
            description: "Create the Endevor connection 'MY-CONNECTION' using the default EBG profile and store credentials login method",
            options: "MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345" +
                " --endevor-instance INSTANCE --login-method STORE_CREDENTIALS",
        },
        {
            description: "Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile",
            options: "MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE",
        },
    ],
};

exports.CreateConnectionDefinition = CreateConnectionDefinition;