class OAuth2 in Migrate Plus 8.2

Provides OAuth2 authentication for the HTTP resource.

@link https://packagist.org/packages/sainsburys/guzzle-oauth2-plugin

Plugin annotation

@Authentication(
  id = "oauth2",
  title = @Translation("OAuth2")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate_plus\AuthenticationPluginBase implements AuthenticationPluginInterface
      • class \Drupal\migrate_plus\Plugin\migrate_plus\authentication\OAuth2 implements ContainerFactoryPluginInterface

File

src/Plugin/migrate_plus/authentication/OAuth2.php, line 27

Namespace

Drupal\migrate_plus\Plugin\migrate_plus\authentication

class OAuth2 extends AuthenticationPluginBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public function getAuthenticationOptions() {
    $handlerStack = HandlerStack::create();
    $client = new Client([
      'handler' => $handlerStack,
      'base_uri' => $this->configuration['base_uri'],
      'auth' => 'oauth2',
    ]);
    switch ($this->configuration['grant_type']) {
      case 'authorization_code':
        $grant_type = new AuthorizationCode($client, $this->configuration);
        break;
      case 'client_credentials':
        $grant_type = new ClientCredentials($client, $this->configuration);
        break;
      case 'urn:ietf:params:oauth:grant-type:jwt-bearer':
        $grant_type = new JwtBearer($client, $this->configuration);
        break;
      case 'password':
        $grant_type = new PasswordCredentials($client, $this->configuration);
        break;
      case 'refresh_token':
        $grant_type = new RefreshToken($client, $this->configuration);
        break;
      default:
        throw new MigrateException("Unrecognized grant_type {$this->configuration['grant_type']}.");
        break;
    }
    $middleware = new OAuthMiddleware($client, $grant_type);
    return [
      'headers' => [
        'Authorization' => 'Bearer ' . $middleware
          ->getAccessToken()
          ->getToken(),
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AuthenticationPluginBase::create	public static	function
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OAuth2::getAuthenticationOptions	public	function	Performs authentication, returning any options to be added to the request. Overrides AuthenticationPluginInterface::getAuthenticationOptions
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.