Oauth2RequestPolicyInterface.php in OAuth2 Server 2.0.x

Namespace

Drupal\oauth2_server\PageCache

File

src/PageCache/Oauth2RequestPolicyInterface.php

<?php

namespace Drupal\oauth2_server\PageCache;

use Drupal\Core\PageCache\RequestPolicyInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * The interface for determining the requests with OAuth data.
 *
 * The service that implements the interface is used to determine whether
 * the page should be served from cache and also if the request contains
 * an access token to proceed to the authentication.
 *
 * @see \Drupal\oauth2_server\PageCache\DisallowOauth2Requests::check()
 * @see \Drupal\oauth2_server\Authentication\Provider\OAuth2DrupalAuthProvider::applies()
 */
interface Oauth2RequestPolicyInterface extends RequestPolicyInterface {

  /**
   * Returns a state whether the request has an OAuth2 access token.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request object.
   *
   * @return bool
   *   A state whether the request has an OAuth2 access token.
   */
  public function isOauth2Request(Request $request);

}

Interfaces

Name	Description
Oauth2RequestPolicyInterface	The interface for determining the requests with OAuth data.