TokenResult.h

/*
 * Copyright (C) 2019-2024 HERE Europe B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */

#pragma once

#include <chrono>
#include <ctime>
#include <string>

#include <olp/core/porting/optional.h>
#include "AuthenticationApi.h"
#include "ErrorResponse.h"

namespace olp {
namespace authentication {
/**
 * @brief A parsed response received from the OAuth2.0 token endpoint.
 *
 * You can get the following information: the access token issued by
 * the authorization server (`GetAccessToken`), and its expiry time
 * (`GetExpiryTime`).
 */
class AUTHENTICATION_API TokenResult {
 public:
  /**
   * @brief Creates the `TokenResult` instance.
   *
   * @param access_token The access token issued by the authorization server.
   * @param expiry_time The Epoch time when the token expires, or -1 if
   * the token is invalid.
   * @param scope The scope assigned to the access token.
   */
  TokenResult(std::string access_token, time_t expiry_time,
              porting::optional<std::string> scope);

  /**
   * @brief Creates the `TokenResult` instance.
   *
   * @param access_token The access token issued by the authorization server.
   * @param expires_in The expiry time of the access token.
   * @param scope The scope assigned to the access token.
   */
  TokenResult(std::string access_token, std::chrono::seconds expires_in,
              porting::optional<std::string> scope);
  /**
   * @brief Creates the default `TokenResult` instance.
   */
  TokenResult() = default;

  /**
   * @brief Gets the access token issued by the authorization server.
   *
   * @return The access token issued by the authorization server.
   */
  const std::string& GetAccessToken() const;

  /**
   * @brief Gets the Epoch time when the token expires, or -1 if the token is
   * invalid.
   *
   * @return The Epoch time when the token expires, or -1 if the token is
   * invalid.
   */
  time_t GetExpiryTime() const;

  /**
   * @brief Gets the access token expiry time.
   *
   * @return The expiry time of the access token.
   */
  std::chrono::seconds GetExpiresIn() const;

  /**
   * @brief Gets the scope that is assigned to the access token.
   *
   * @return The optional string that contains the scope assigned to the access
   * token.
   */
  const porting::optional<std::string>& GetScope() const;

 private:
  std::string access_token_;
  time_t expiry_time_{};
  std::chrono::seconds expires_in_{};
  porting::optional<std::string> scope_;
};

}  // namespace authentication
}  // namespace olp