apigee_edge-8.x-1.17/src/OauthTokenStorageInterface.php

<?php

/**
 * Copyright 2018 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;

use Apigee\Edge\HttpClient\Plugin\Authentication\OauthTokenStorageInterface as EdgeOauthTokenStorageInterface;

/**
 * Base definition of the OAuth token storage service implementations.
 *
 * @todo move to \Drupal\apigee_edge\Connector namespace.
 */
interface OauthTokenStorageInterface extends EdgeOauthTokenStorageInterface {

  /**
   * Checks requirements of the token storage.
   *
   * If a requirement does not fulfilled it throws an exception.
   *
   * @throws \Drupal\apigee_edge\Exception\OauthTokenStorageException
   *   Exception with the unfulfilled requirement.
   */
  public function checkRequirements(): void;

}