AccessTokenProvider.php

<?php
/**
 * Copyright (c) Microsoft Corporation.  All Rights Reserved.
 * Licensed under the MIT License.  See License in the project root
 * for license information.
 */


namespace Microsoft\Kiota\Abstractions\Authentication;

use Microsoft\Kiota\Abstraction\Promise\Promise;

/**
 * Interface AccessTokenProvider
 *
 * Defines a contract for obtaining access tokens for a given url
 *
 * @package Microsoft\Kiota\Abstractions\Authentication
 * @copyright 2022 Microsoft Corporation
 * @license https://opensource.org/licenses/MIT MIT License
 * @link https://developer.microsoft.com/graph
 */
interface AccessTokenProvider
{
    /**
     * Method called by {@link BaseBearerTokenAuthenticationProvider} to get the access token
     * Returns a Promise that is fulfilled with the access token string
     *
     * @param string $url the target URI to get an access token for
     * @param array<string, mixed> $additionalAuthenticationContext
     * @return Promise<string|null>
     */
    public function getAuthorizationTokenAsync(string $url, array $additionalAuthenticationContext = []): Promise;

    /**
     * Returns the {@link AllowedHostsValidator} instance used by the AccessTokenProvider
     * @return AllowedHostsValidator
     */
    public function getAllowedHostsValidator(): AllowedHostsValidator;
}