class EnvironmentVariablesKeyProvider in Apigee Edge 8

Stores Apigee Edge authentication credentials in environment variables.

Plugin annotation


@KeyProvider(
  id = "apigee_edge_environment_variables",
  label = @Translation("Apigee Edge: Environment Variables"),
  description = @Translation("Stores Apigee Edge authentication credentials in the following environment variables:"),
  storage_method = "apigee_edge",
  key_value = {
    "accepted" = FALSE,
    "required" = FALSE
  }
)

View source

class EnvironmentVariablesKeyProvider extends KeyProviderRequirementsBase implements KeyPluginFormInterface {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['environment_variables'] = [
      '#markup' => implode(', ', $this
        ->getEnvironmentVariables($form_state
        ->getFormObject()
        ->getEntity())),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function realGetKeyValue(KeyInterface $key) {
    $key_value = [];
    foreach ($this
      ->getEnvironmentVariables($key) as $id => $variable) {
      if (getenv($variable)) {
        $key_value[$id] = getenv($variable);
      }
    }
    return Json::encode((object) $key_value);
  }

  /**
   * {@inheritdoc}
   */
  public static function obscureKeyValue($key_value, array $options = []) {
    return $key_value;
  }

  /**
   * {@inheritdoc}
   */
  public function checkRequirements(KeyInterface $key) : void {
    $missing_env_variables = [];
    foreach ($this
      ->getEnvironmentVariables($key, TRUE) as $variable) {
      if (!getenv($variable)) {
        $missing_env_variables[] = $variable;
      }
    }
    if (!empty($missing_env_variables)) {
      $missing_env_variables_to_string = implode(', ', $missing_env_variables);
      throw new KeyProviderRequirementsException('The following environment variables are not set: ' . $missing_env_variables_to_string, $this
        ->t('The following environment variables are not set: @missing_env_variables.', [
        '@missing_env_variables' => $missing_env_variables_to_string,
      ]));
    }
  }

  /**
   * Returns an array containing the environment variables by key type.
   *
   * @param \Drupal\key\KeyInterface $key
   *   The key entity.
   * @param bool $required
   *   Returns only the required environment variables.
   *
   * @return array
   *   The environment variables.
   */
  protected function getEnvironmentVariables(KeyInterface $key, bool $required = FALSE) : array {
    $environment_variables = [];
    foreach ($key
      ->getKeyType()
      ->getPluginDefinition()['multivalue']['fields'] as $id => $field) {
      if ($required && isset($field['required']) && !$field['required']) {
        continue;
      }
      $environment_variables[$id] = 'APIGEE_EDGE_' . strtoupper($id);
    }
    return $environment_variables;
  }

}

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
EnvironmentVariablesKeyProvider::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
EnvironmentVariablesKeyProvider::checkRequirements	public	function	Checks the requirements of the key provider. Overrides KeyProviderRequirementsInterface::checkRequirements
EnvironmentVariablesKeyProvider::getEnvironmentVariables	protected	function	Returns an array containing the environment variables by key type.
EnvironmentVariablesKeyProvider::obscureKeyValue	public static	function	Obscures a key value. Overrides KeyProviderBase::obscureKeyValue
EnvironmentVariablesKeyProvider::realGetKeyValue	public	function	The method that returns a key's value after pre-requirements got validated. Overrides KeyProviderRequirementsBase::realGetKeyValue
EnvironmentVariablesKeyProvider::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
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::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::create	public static	function	Creates an instance of the plugin. Overrides KeyPluginBase::create	1
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
KeyProviderRequirementsBase::__construct	public	function	KeyProviderRequirementsBase constructor. Overrides KeyPluginBase::__construct	1
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.
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 EnvironmentVariablesKeyProvider in Apigee Edge 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation