class PrivateFileKeyProvider in Apigee Edge 8

Stores Apigee Edge authentication credentials in a private file.

Plugin annotation


@KeyProvider(
  id = "apigee_edge_private_file",
  label = @Translation("Apigee Edge: Private File"),
  description = @Translation("Stores Apigee Edge authentication credentials in a private file.</p>"),
  storage_method = "apigee_edge",
  key_value = {
    "accepted" = TRUE,
    "required" = FALSE
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\key\Plugin\KeyPluginBase implements KeyPluginInterface
    class \Drupal\key\Plugin\KeyProviderBase implements KeyProviderInterface
    class \Drupal\apigee_edge\Plugin\KeyProvider\KeyProviderRequirementsBase implements KeyProviderRequirementsInterface
    class \Drupal\apigee_edge\Plugin\KeyProvider\PrivateFileKeyProvider implements KeyPluginFormInterface, KeyProviderSettableValueInterface

Expanded class hierarchy of PrivateFileKeyProvider

File

src/Plugin/KeyProvider/PrivateFileKeyProvider.php, line 47

Namespace

Drupal\apigee_edge\Plugin\KeyProvider

View source

class PrivateFileKeyProvider extends KeyProviderRequirementsBase implements KeyPluginFormInterface, KeyProviderSettableValueInterface {

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  private $fileSystem;

  /**
   * PrivateFileKeyProvider constructor.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Psr\Log\LoggerInterface $logger
   *   The logger.
   * @param \Drupal\Core\File\FileSystemInterface $file_system
   *   The file system service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, LoggerInterface $logger, FileSystemInterface $file_system) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $logger);
    $this->fileSystem = $file_system;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('logger.channel.apigee_edge'), $container
      ->get('file_system'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this
      ->setConfiguration($form_state
      ->getValues());
  }

  /**
   * {@inheritdoc}
   */
  public function realGetKeyValue(KeyInterface $key) {

    // If the key is new then the file does not exist in the filesystem yet
    // so do not try to read it.
    if ($key
      ->isNew()) {
      return NULL;
    }
    return file_get_contents($this
      ->getFileUri($key)) ?: NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function setKeyValue(KeyInterface $key, $key_value) {

    // Throwing an exception would be better than returning FALSE but the key
    // module's design does not allow this.
    // Related issue: https://www.drupal.org/project/key/issues/3038212
    try {
      $this
        ->checkRequirements($key);
    } catch (KeyProviderRequirementsException $exception) {
      $context = [
        '@message' => (string) $exception,
      ];
      $context += Error::decodeException($exception);
      $this
        ->getLogger()
        ->error('Could not save Apigee Edge authentication key value in the private file storage: @message %function (line %line of %file). <pre>@backtrace_string</pre>', $context);
      return FALSE;
    }
    $file_uri = $this
      ->getFileUri($key);
    $file_path = $this
      ->getFileSystem()
      ->dirname($file_uri);

    // Make sure the folder exists.
    $this
      ->getFileSystem()
      ->prepareDirectory($file_path, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS);
    try {

      // Save the token data.
      return $this
        ->getFileSystem()
        ->saveData($key_value, $file_uri, FileSystemInterface::EXISTS_REPLACE);
    } catch (FileException $e) {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function deleteKeyValue(KeyInterface $key) {
    try {
      $this
        ->getFileSystem()
        ->delete($this
        ->getFileUri($key));
    } catch (FileException $e) {

      // Do nothing.
    }
  }

  /**
   * {@inheritdoc}
   */
  public function checkRequirements(KeyInterface $key) : void {

    // Validate private file path is set.
    $file_private_path = $this
      ->getFileSystem()
      ->realpath('private://');
    if (!(bool) $file_private_path) {
      throw new KeyProviderRequirementsException('Private filesystem has not been configured yet.', $this
        ->t("Private filesystem has not been configured yet. <a href=':file_docs_uri' target='_blank'>Learn more</a>", [
        ':file_docs_uri' => 'https://www.drupal.org/docs/8/modules/apigee-edge/configure-the-connection-to-apigee-edge#configure-private-file',
      ]));
    }

    // Validate private file path is writable.
    if (!is_writable($file_private_path)) {
      throw new KeyProviderRequirementsException('The private file path is not writable.', $this
        ->t('The private file path is not writable.'));
    }

    // Validate private file path is a directory.
    if (!is_dir($file_private_path)) {
      throw new KeyProviderRequirementsException('The private file path does not exist.', $this
        ->t('The private file path does not exist.'));
    }
  }

  /**
   * Gets the URI of the file that contains the key value.
   *
   * @param \Drupal\key\KeyInterface $key
   *   The key entity.
   *
   * @return string
   *   The file URI.
   */
  protected function getFileUri(KeyInterface $key) : string {
    return "private://.apigee_edge/{$key->id()}.json";
  }

  /**
   * Gets the file system service.
   *
   * @return \Drupal\Core\File\FileSystemInterface
   *   The file system service.
   */
  protected function getFileSystem() : FileSystemInterface {

    // This fallback is needed when the plugin instance is serialized and the
    // property is null.
    return $this->fileSystem ?? \Drupal::service('file_system');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
KeyPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
KeyPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	8
KeyPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
KeyPluginBase::getPluginType	public	function	Returns the type of plugin. Overrides KeyPluginInterface::getPluginType
KeyPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
KeyProviderBase::obscureKeyValue	public static	function	Obscures a key value. Overrides KeyProviderInterface::obscureKeyValue	1
KeyProviderBase::obscureValue	protected static	function	Helper method to obscure a value.
KeyProviderBase::postSave	public	function	Allows a key provider to perform actions after a key entity is saved. Overrides KeyProviderInterface::postSave
KeyProviderRequirementsBase::$logger	private	property	The logger.
KeyProviderRequirementsBase::getKeyValue	final public	function	Returns the value of a key. Overrides KeyProviderInterface::getKeyValue
KeyProviderRequirementsBase::getLogger	protected	function	Gets the logger service.
KeyProviderRequirementsBase::validateConfigurationForm	public	function
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PrivateFileKeyProvider::$fileSystem	private	property	The file system service.
PrivateFileKeyProvider::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
PrivateFileKeyProvider::checkRequirements	public	function	Checks the requirements of the key provider. Overrides KeyProviderRequirementsInterface::checkRequirements
PrivateFileKeyProvider::create	public static	function	Creates an instance of the plugin. Overrides KeyProviderRequirementsBase::create
PrivateFileKeyProvider::deleteKeyValue	public	function	Deletes the value of a key. Overrides KeyProviderSettableValueInterface::deleteKeyValue
PrivateFileKeyProvider::getFileSystem	protected	function	Gets the file system service.
PrivateFileKeyProvider::getFileUri	protected	function	Gets the URI of the file that contains the key value.
PrivateFileKeyProvider::realGetKeyValue	public	function	The method that returns a key's value after pre-requirements got validated. Overrides KeyProviderRequirementsBase::realGetKeyValue
PrivateFileKeyProvider::setKeyValue	public	function	Sets the value of a key. Overrides KeyProviderSettableValueInterface::setKeyValue
PrivateFileKeyProvider::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
PrivateFileKeyProvider::__construct	public	function	PrivateFileKeyProvider constructor. Overrides KeyProviderRequirementsBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class PrivateFileKeyProvider in Apigee Edge 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation