class SalesforceAuthTokenStorage in Salesforce Suite 8.3

Salesforce auth token storage.

Hierarchy

• class \Drupal\salesforce\Storage\SalesforceAuthTokenStorage implements SalesforceAuthTokenStorageInterface

1 string reference to 'SalesforceAuthTokenStorage'

salesforce.services.yml in ./salesforce.services.yml

salesforce.services.yml

1 service uses SalesforceAuthTokenStorage

salesforce.auth_token_storage in ./salesforce.services.yml

Drupal\salesforce\Storage\SalesforceAuthTokenStorage

File

src/Storage/SalesforceAuthTokenStorage.php, line 14

Namespace

Drupal\salesforce\Storage

class SalesforceAuthTokenStorage implements SalesforceAuthTokenStorageInterface {
  const TOKEN_STORAGE_PREFIX = "salesforce.auth_tokens";
  const AUTH_STATE_STORAGE_PREFIX = "salesforce.auth_state";
  const IDENTITY_STORAGE_PREFIX = "salesforce.auth_identity";

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

  /**
   * SalesforceAuthTokenStorage constructor.
   *
   * @param \Drupal\Core\State\StateInterface $state
   *   State service.
   */
  public function __construct(StateInterface $state) {
    $this->state = $state;
  }

  /**
   * Backwards-compatibility for legacy singleton auth.
   *
   * @return string
   *   Id of the active oauth.
   *
   * @deprecated BC legacy auth scheme only, do not use, will be removed.
   */
  private function service() {
    $oauth = SalesforceAuthProviderPluginManager::getAuthConfig();
    return $oauth
      ->id();
  }

  /**
   * Backwards-compatibility for legacy singleton auth.
   *
   * @deprecated BC legacy auth scheme only, do not use, will be removed.
   */
  public function updateToken() {
    $this
      ->storeAccessToken($this
      ->service(), new SalesforceToken($this->state
      ->get('salesforce.access_token'), $this->state
      ->get('salesforce.refresh_token')));
    return $this;
  }

  /**
   * Backwards-compatibility for legacy singleton auth.
   *
   * @deprecated BC legacy auth scheme only, do not use, will be removed.
   */
  public function updateIdentity() {
    $this
      ->storeIdentity($this
      ->service(), $this->state
      ->get('salesforce.identity'));
    return $this;
  }

  /**
   * Token storage key for given service.
   *
   * @return string
   *   Token storage key for given service.
   */
  protected static function getTokenStorageId($service) {
    return self::TOKEN_STORAGE_PREFIX . '.' . $service;
  }

  /**
   * Auth state storage key for given service.
   *
   * @return string
   *   Auth state storage key for given service.
   */
  protected static function getAuthStateStorageId($service) {
    return self::AUTH_STATE_STORAGE_PREFIX . '.' . $service;
  }

  /**
   * Identity storage key for given service.
   *
   * @return string
   *   Identity storage key for given service.
   */
  protected static function getIdentityStorageId($service) {
    return self::IDENTITY_STORAGE_PREFIX . '.' . $service;
  }

  /**
   * {@inheritdoc}
   */
  public function retrieveAccessToken($service) {
    if ($token = $this->state
      ->get(self::getTokenStorageId($service))) {
      return $token;
    }
    throw new TokenNotFoundException();
  }

  /**
   * {@inheritdoc}
   */
  public function storeAccessToken($service, TokenInterface $token) {
    $this->state
      ->set(self::getTokenStorageId($service), $token);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAccessToken($service) {
    try {
      return !empty($this
        ->retrieveAccessToken($service));
    } catch (TokenNotFoundException $e) {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function clearToken($service) {
    $this->state
      ->delete(self::getTokenStorageId($service));
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function clearAllTokens() {

    // noop. We don't do this. Only here to satisfy interface.
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function storeAuthorizationState($service, $state) {
    $this->state
      ->set(self::getAuthStateStorageId($service), $state);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasAuthorizationState($service) {
    return !empty($this
      ->retrieveAuthorizationState($service));
  }

  /**
   * {@inheritdoc}
   */
  public function retrieveAuthorizationState($service) {
    return $this->state
      ->get(self::getAuthStateStorageId($service));
  }

  /**
   * {@inheritdoc}
   */
  public function clearAuthorizationState($service) {
    $this->state
      ->delete(self::getAuthStateStorageId($service));
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function clearAllAuthorizationStates() {

    // noop. only here to satisfy interface. Use clearAuthorizationState().
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function storeIdentity($service, $identity) {
    $this->state
      ->set(self::getIdentityStorageId($service), $identity);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function hasIdentity($service) {
    return !empty($this
      ->retrieveIdentity($service));
  }

  /**
   * {@inheritdoc}
   */
  public function retrieveIdentity($service) {
    return $this->state
      ->get(self::getIdentityStorageId($service));
  }

  /**
   * {@inheritdoc}
   */
  public function clearIdentity($service) {
    $this->state
      ->delete(self::getIdentityStorageId($service));
    return $this;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SalesforceAuthTokenStorage::$state	protected	property	State kv storage.
SalesforceAuthTokenStorage::AUTH_STATE_STORAGE_PREFIX		constant
SalesforceAuthTokenStorage::clearAllAuthorizationStates	public	function
SalesforceAuthTokenStorage::clearAllTokens	public	function
SalesforceAuthTokenStorage::clearAuthorizationState	public	function
SalesforceAuthTokenStorage::clearIdentity	public	function	Clear identity for service. Overrides SalesforceAuthTokenStorageInterface::clearIdentity
SalesforceAuthTokenStorage::clearToken	public	function
SalesforceAuthTokenStorage::getAuthStateStorageId	protected static	function	Auth state storage key for given service.
SalesforceAuthTokenStorage::getIdentityStorageId	protected static	function	Identity storage key for given service.
SalesforceAuthTokenStorage::getTokenStorageId	protected static	function	Token storage key for given service.
SalesforceAuthTokenStorage::hasAccessToken	public	function
SalesforceAuthTokenStorage::hasAuthorizationState	public	function
SalesforceAuthTokenStorage::hasIdentity	public	function	Return boolean indicating whether this service has an identity. Overrides SalesforceAuthTokenStorageInterface::hasIdentity
SalesforceAuthTokenStorage::IDENTITY_STORAGE_PREFIX		constant
SalesforceAuthTokenStorage::retrieveAccessToken	public	function
SalesforceAuthTokenStorage::retrieveAuthorizationState	public	function
SalesforceAuthTokenStorage::retrieveIdentity	public	function	Identity for the given service. Overrides SalesforceAuthTokenStorageInterface::retrieveIdentity
SalesforceAuthTokenStorage::service Deprecated	private	function	Backwards-compatibility for legacy singleton auth.
SalesforceAuthTokenStorage::storeAccessToken	public	function
SalesforceAuthTokenStorage::storeAuthorizationState	public	function
SalesforceAuthTokenStorage::storeIdentity	public	function	Setter for identity storage. Overrides SalesforceAuthTokenStorageInterface::storeIdentity
SalesforceAuthTokenStorage::TOKEN_STORAGE_PREFIX		constant
SalesforceAuthTokenStorage::updateIdentity Deprecated	public	function	Backwards-compatibility for legacy singleton auth.
SalesforceAuthTokenStorage::updateToken Deprecated	public	function	Backwards-compatibility for legacy singleton auth.
SalesforceAuthTokenStorage::__construct	public	function	SalesforceAuthTokenStorage constructor.