ApigeeEdgeManagementCliServiceInterface.php in Apigee Edge 8

Namespace

Drupal\apigee_edge\Command\Util

File

src/Command/Util/ApigeeEdgeManagementCliServiceInterface.php

<?php

/**
 * Copyright 2019 Google Inc.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License version 2 as published by the
 * Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
namespace Drupal\apigee_edge\Command\Util;

use Symfony\Component\Console\Style\StyleInterface;

/**
 * Defines an interface for Edge connection classes.
 */
interface ApigeeEdgeManagementCliServiceInterface {

  // Default role name to create in Apigee Edge.
  const DEFAULT_ROLE_NAME = 'drupalportal';

  /**
   * Create role in Apigee Edge for Drupal to use for Edge connection.
   *
   * @param \Symfony\Component\Console\Style\StyleInterface $io
   *   The IO interface of the CLI tool calling the method.
   * @param callable $t
   *   The translation function akin to t().
   * @param string $org
   *   The organization to connect to.
   * @param string $email
   *   The email of an Edge user with org admin role to make Edge API calls.
   * @param string $password
   *   The password of an Edge user with org admin role to make Edge API calls.
   * @param null|string $base_url
   *   The base url of the Edge API.
   * @param null|string $role_name
   *   The role name to add the permissions to.
   * @param null|bool $force
   *   Force running of permissions on a role that already exists.
   */
  public function createEdgeRoleForDrupal(StyleInterface $io, callable $t, string $org, string $email, string $password, ?string $base_url, ?string $role_name, bool $force);

}

Interfaces

Name	Description
ApigeeEdgeManagementCliServiceInterface	Defines an interface for Edge connection classes.