class Oauth2ClientService in OAuth2 Client 8.3

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 14

Namespace

Drupal\oauth2_client\Service

class Oauth2ClientService extends Oauth2ClientServiceBase {

  /**
   * 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\ResourceOwnersCredentialsGrantService $resourceOwnersCredentialsGrantService
   *   The resource owner's credentials grant service.
   */
  public function __construct(Oauth2ClientPluginManagerInterface $oauth2ClientPluginManager, StateInterface $state, Oauth2ClientGrantServiceInterface $authorizationCodeGrantService, Oauth2ClientGrantServiceInterface $clientCredentialsGrantService, Oauth2ClientGrantServiceInterface $refreshTokenGrantService, ResourceOwnersCredentialsGrantService $resourceOwnersCredentialsGrantService) {
    $this->oauth2ClientPluginManager = $oauth2ClientPluginManager;
    $this->state = $state;
    $this->grantServices = [
      'authorization_code' => $authorizationCodeGrantService,
      'client_credentials' => $clientCredentialsGrantService,
      'refresh_token' => $refreshTokenGrantService,
      'resource_owner' => $resourceOwnersCredentialsGrantService,
    ];
  }

  /**
   * Obtains an existing or a new access token.
   *
   * @param string $pluginId
   *   The Oauth2Client plugin id.
   * @param string $username
   *   Optional - The username if needed by the grant type.
   * @param string $password
   *   Optional - The password if needed by the grant type.
   *
   * @return \League\OAuth2\Client\Token\AccessTokenInterface|null
   *   Returns a token or null.
   *
   * @throws \Drupal\oauth2_client\Exception\InvalidOauth2ClientException
   *   Thrown in the upstream League library.
   */
  public function getAccessToken($pluginId, $username = '', $password = '') {
    $accessToken = $this
      ->retrieveAccessToken($pluginId);
    if ($accessToken instanceof AccessTokenInterface) {
      $refreshToken = $accessToken
        ->getRefreshToken();
      $expirationTimestamp = $accessToken
        ->getExpires();
      if (!empty($expirationTimestamp) && $accessToken
        ->hasExpired() && !empty($refreshToken)) {
        $accessToken = $this->grantServices['refresh_token']
          ->getAccessToken($pluginId);
      }
    }
    else {
      $client = $this
        ->getClient($pluginId);
      switch ($client
        ->getGrantType()) {
        case 'authorization_code':
          $this->grantServices['authorization_code']
            ->getAccessToken($pluginId);
          break;
        case 'client_credentials':
          $this->grantServices['client_credentials']
            ->getAccessToken($pluginId);
          $accessToken = $this
            ->retrieveAccessToken($pluginId);
          break;
        case 'resource_owner':
          $this->grantServices['resource_owner']
            ->setUsernamePassword($pluginId, $username, $password);
          $this->grantServices['resource_owner']
            ->getAccessToken($pluginId);
          $accessToken = $this
            ->retrieveAccessToken($pluginId);
          break;
      }
    }
    return $accessToken;
  }

  /**
   * Obtains a Provider from the relevant service.
   *
   * @param string $pluginId
   *   The client for which a provider should be obtained.
   *
   * @return \League\OAuth2\Client\Provider\GenericProvider
   *   The provider of the OAuth2 Server.
   *
   * @throws \Drupal\oauth2_client\Exception\InvalidOauth2ClientException
   *   Thrown in the upstream League library.
   */
  public function getProvider($pluginId) {
    $client = $this
      ->getClient($pluginId);
    return $this->grantServices[$client
      ->getGrantType()]
      ->getGrantProvider($pluginId);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Oauth2ClientService::$grantServices	protected	property	An array of OAuth2 Client grant services.
Oauth2ClientService::$state	protected	property	The Drupal state.
Oauth2ClientService::getAccessToken	public	function	Obtains an existing or a new access token.
Oauth2ClientService::getProvider	public	function	Obtains a Provider from the relevant service.
Oauth2ClientService::__construct	public	function	Constructs an Oauth2ClientService object.
Oauth2ClientServiceBase::$oauth2ClientPluginManager	protected	property	The OAuth2 Client plugin manager.	1
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 storage. Overrides Oauth2ClientServiceInterface::retrieveAccessToken