class Oauth2ClientService in OAuth2 Client 8.2

The OAuth2 Client service.

Hierarchy

• class \Drupal\oauth2_client\Service\Oauth2ClientServiceBase implements Oauth2ClientServiceInterface
  • class \Drupal\oauth2_client\Service\Oauth2ClientService

1 string reference to 'Oauth2ClientService'

oauth2_client.services.yml in ./oauth2_client.services.yml

oauth2_client.services.yml

File

src/Service/Oauth2ClientService.php, line 12

Namespace

Drupal\oauth2_client\Service

class Oauth2ClientService extends Oauth2ClientServiceBase {

  /**
   * The OAuth2 Client plugin manager.
   *
   * @var \Drupal\oauth2_client\PluginManager\Oauth2ClientPluginManagerInterface
   */
  protected $oauth2ClientPluginManager;

  /**
   * The Drupal state.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * An array of OAuth2 Client grant services.
   *
   * @var array
   */
  protected $grantServices = [];

  /**
   * Constructs an Oauth2ClientService object.
   *
   * @param \Drupal\oauth2_client\PluginManager\Oauth2ClientPluginManagerInterface $oauth2ClientPluginManager
   *   The Oauth2 Client plugin manager.
   * @param \Drupal\Core\State\StateInterface $state
   *   The Drupal state.
   * @param \Drupal\oauth2_client\Service\Grant\Oauth2ClientGrantServiceInterface $authorizationCodeGrantService
   *   The authorization code grant service.
   * @param \Drupal\oauth2_client\Service\Grant\Oauth2ClientGrantServiceInterface $clientCredentialsGrantService
   *   The client credentials grant service.
   * @param \Drupal\oauth2_client\Service\Grant\Oauth2ClientGrantServiceInterface $refreshTokenGrantService
   *   The refresh token grant service.
   * @param \Drupal\oauth2_client\Service\Grant\Oauth2ClientGrantServiceInterface $resourceOwnersCredentialsGrantService
   *   The resource owner's credentials grant service.
   */
  public function __construct(Oauth2ClientPluginManagerInterface $oauth2ClientPluginManager, StateInterface $state, Oauth2ClientGrantServiceInterface $authorizationCodeGrantService, Oauth2ClientGrantServiceInterface $clientCredentialsGrantService, Oauth2ClientGrantServiceInterface $refreshTokenGrantService, Oauth2ClientGrantServiceInterface $resourceOwnersCredentialsGrantService) {
    $this->oauth2ClientPluginManager = $oauth2ClientPluginManager;
    $this->state = $state;
    $this->grantServices = [
      'authorization_code' => $authorizationCodeGrantService,
      'client_credentials' => $clientCredentialsGrantService,
      'refresh_token' => $refreshTokenGrantService,
      'resource_owner' => $resourceOwnersCredentialsGrantService,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getAccessToken($clientId) {
    $access_token = $this
      ->retrieveAccessToken($clientId);
    if (!$access_token || $access_token
      ->getExpires() && $access_token
      ->hasExpired()) {
      $client = $this
        ->getClient($clientId);
      switch ($client
        ->getGrantType()) {
        case 'authorization_code':
          $access_token = $this
            ->getAuthorizationCodeAccessToken($clientId);
          break;
        case 'client_credentials':
          $access_token = $this
            ->getClientCredentialsAccessToken($clientId);
          break;
        case 'resource_owner':
          $access_token = $this
            ->getResourceOwnersCredentialsAccessToken($clientId);
          break;
      }
    }
    return $access_token;
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider($clientId) {
    $client = $this
      ->getClient($clientId);
    switch ($client
      ->getGrantType()) {
      case 'client_credentials':
        $provider = $this
          ->getClientCredentialsProvider($clientId);
        break;
      case 'resource_owner':
        $provider = $this
          ->getResourceOwnersCredentialsProvider($clientId);
        break;
      case 'authorization_code':
      default:
        $provider = $this
          ->getAuthorizationCodeProvider($clientId);
        break;
    }
    return $provider;
  }

  /**
   * Retrieves an access token for the 'authorization_code' grant type.
   *
   * @return \League\OAuth2\Client\Token\AccessTokenInterface
   *   The Access Token for the given client ID.
   */
  private function getAuthorizationCodeAccessToken($clientId) {
    $stored_token = $this
      ->retrieveAccessToken($clientId);
    if ($stored_token) {
      if ($stored_token
        ->getExpires() && $stored_token
        ->hasExpired()) {
        if (empty($stored_token
          ->getRefreshToken())) {

          # Token is expired but we have no refresh_token. Just get a new one.
          $access_token = NULL;
        }
        else {
          $access_token = $this->grantServices['refresh_token']
            ->getAccessToken($clientId);
        }
      }
      else {
        $access_token = $stored_token;
      }
    }
    if (empty($access_token)) {
      $access_token = $this->grantServices['authorization_code']
        ->getAccessToken($clientId);
    }
    return $access_token;
  }

  /**
   * Retrieves the league/oauth2-client provider for the 'authorization_code'
   * grant type.
   *
   * @return \League\OAuth2\Client\Provider\AbstractProvider
   *   The Provider for the given client ID.
   */
  private function getAuthorizationCodeProvider($clientId) {
    return $this->grantServices['authorization_code']
      ->getGrantProvider($clientId);
  }

  /**
   * Retrieves an access token for the 'client_credentials' grant type.
   *
   * @return \League\OAuth2\Client\Token\AccessTokenInterface
   *   The Access Token for the given client ID.
   */
  private function getClientCredentialsAccessToken($clientId) {
    $access_token = $this
      ->retrieveAccessToken($clientId);
    if (!$access_token) {
      $access_token = $this->grantServices['client_credentials']
        ->getAccessToken($clientId);
    }
    return $access_token;
  }

  /**
   * Retrieves the league/oauth2-client provider for the 'client_credentials'
   * grant type.
   *
   * @return \League\OAuth2\Client\Provider\AbstractProvider
   *   The Provider for the given client ID.
   */
  private function getClientCredentialsProvider($clientId) {
    return $this->grantServices['client_credentials']
      ->getGrantProvider($clientId);
  }

  /**
   * Retrieves an access token for the 'resource_owner' grant type.
   *
   * @return \League\OAuth2\Client\Token\AccessTokenInterface
   *   The Access Token for the given client ID.
   */
  private function getResourceOwnersCredentialsAccessToken($clientId) {
    $access_token = $this
      ->retrieveAccessToken($clientId);
    if (!$access_token) {
      $access_token = $this->grantServices['resource_owner']
        ->getAccessToken($clientId);
    }
    return $access_token;
  }

  /**
   * Retrieves the league/oauth2-client provider for the 'resource_owner' grant
   * type.
   *
   * @return \League\OAuth2\Client\Provider\AbstractProvider
   *   The Provider for the given client ID.
   */
  private function getResourceOwnersCredentialsProvider($clientId) {
    return $this->grantServices['resource_owner']
      ->getGrantProvider($clientId);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Oauth2ClientService::$grantServices	protected	property	An array of OAuth2 Client grant services.
Oauth2ClientService::$oauth2ClientPluginManager	protected	property	The OAuth2 Client plugin manager.
Oauth2ClientService::$state	protected	property	The Drupal state.
Oauth2ClientService::getAccessToken	public	function
Oauth2ClientService::getAuthorizationCodeAccessToken	private	function	Retrieves an access token for the 'authorization_code' grant type.
Oauth2ClientService::getAuthorizationCodeProvider	private	function	Retrieves the league/oauth2-client provider for the 'authorization_code' grant type.
Oauth2ClientService::getClientCredentialsAccessToken	private	function	Retrieves an access token for the 'client_credentials' grant type.
Oauth2ClientService::getClientCredentialsProvider	private	function	Retrieves the league/oauth2-client provider for the 'client_credentials' grant type.
Oauth2ClientService::getProvider	public	function
Oauth2ClientService::getResourceOwnersCredentialsAccessToken	private	function	Retrieves an access token for the 'resource_owner' grant type.
Oauth2ClientService::getResourceOwnersCredentialsProvider	private	function	Retrieves the league/oauth2-client provider for the 'resource_owner' grant type.
Oauth2ClientService::__construct	public	function	Constructs an Oauth2ClientService object.
Oauth2ClientServiceBase::clearAccessToken	public	function	Clears the access token for the given client. Overrides Oauth2ClientServiceInterface::clearAccessToken
Oauth2ClientServiceBase::getClient	public	function	Retrieve an OAuth2 Client Plugin. Overrides Oauth2ClientServiceInterface::getClient
Oauth2ClientServiceBase::retrieveAccessToken	public	function	Retrieve an access token from the Drupal state. Overrides Oauth2ClientServiceInterface::retrieveAccessToken