OlpClientSettings.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 <functional>
#include <memory>
#include <string>
 
#include <boost/optional.hpp>
 
#include <olp/core/client/CancellationContext.h>
#include <olp/core/client/CancellationToken.h>
#include <olp/core/client/DefaultLookupEndpointProvider.h>
#include <olp/core/client/HRN.h>
#include <olp/core/client/HttpResponse.h>
#include <olp/core/client/OauthToken.h>
#include <olp/core/client/RetrySettings.h>
#include <olp/core/http/Network.h>
 
namespace olp {
namespace cache {
class KeyValueCache;
}  // namespace cache
 
namespace thread {
class TaskScheduler;
}  // namespace thread
 
namespace http {
class Network;
}  // namespace http
 
namespace client {
using NetworkAsyncCallback = std::function<void(HttpResponse)>;
 
using NetworkAsyncCancel = std::function<void()>;
 
struct CORE_API AuthenticationSettings {
  using ApiKeyProviderType = std::function<std::string()>;
 
  using TokenProviderCancellableCallback =
      std::function<OauthTokenResponse(CancellationContext&)>;
 
  TokenProviderCancellableCallback token_provider = nullptr;
 
  ApiKeyProviderType api_key_provider = nullptr;
};
 
struct CORE_API ApiLookupSettings {
  using LookupEndpointProvider = std::function<std::string(const std::string&)>;
 
  using CatalogEndpointProvider = std::function<std::string(const HRN&)>;
 
  LookupEndpointProvider lookup_endpoint_provider =
      DefaultLookupEndpointProvider();
 
  CatalogEndpointProvider catalog_endpoint_provider = nullptr;
};
 
struct CORE_API OlpClientSettings {
  RetrySettings retry_settings;
 
  ApiLookupSettings api_lookup_settings;
 
  boost::optional<http::NetworkProxySettings> proxy_settings = boost::none;
 
  boost::optional<AuthenticationSettings> authentication_settings = boost::none;
 
  std::shared_ptr<thread::TaskScheduler> task_scheduler = nullptr;
 
  std::shared_ptr<http::Network> network_request_handler = nullptr;
 
  std::shared_ptr<cache::KeyValueCache> cache = nullptr;
 
  std::chrono::seconds default_cache_expiration = std::chrono::seconds::max();
 
  bool propagate_all_cache_errors = false;
};
 
}  // namespace client
}  // namespace olp