cloud_discovery_delegate.h

Go to the documentation of this file.

/*
 *
 * Copyright (c) Microsoft Corporation.
 * All rights reserved.
 *
 * This code is licensed under the MIT License.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files(the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions :
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */
/**
 * @brief Defines CouldDiscoveryDelegate interface
 * 
 * @file cloud_discovery_delegate.h
 */
 
#ifndef API_MIP_CLOUD_DISCOVERY_DELEGATE_H_
#define API_MIP_CLOUD_DISCOVERY_DELEGATE_H_
 
#include <functional>
#include <string>
#include <vector>
 
#include "mip/common_types.h"
#include "mip/mip_namespace.h"
 
MIP_NAMESPACE_BEGIN
 
/**
 * @brief Service information returned by cloud discovery
 * 
 */
class ServiceInfo {
public:
  ServiceInfo() 
    : mServiceType(ServiceType::Telemetry), 
      mUrl(""), 
      mResource(""), 
      mAuthority("") {
  }
 
  ServiceInfo(ServiceType serviceType, std::string url)
    : ServiceInfo(serviceType, url, "", "") {
  } 
 
  ServiceInfo(ServiceType serviceType, std::string url, std::string resource, std::string authority) 
    : mServiceType(serviceType), 
      mUrl(url), 
      mResource(resource), 
      mAuthority(authority) {
  }
 
  /**
   * @brief Gets the service type of this ServiceInfo, like Protection, Policy, Telemetry, etc.
   *
   * @return service type
   */
  ServiceType GetServiceType() const { return mServiceType; }
 
  /**
   * @brief Gets the service URL like https://api.aadrm.com
   * 
   * @return service URL
   */
  std::string GetUrl() const { return mUrl; } 
 
  /**
   * @brief Gets the resource string for authentication
   * 
   * @return resource string
   */
  std::string GetResource() const { return mResource; }
 
  /**
   * @brief Gets the authority string for authentication
   * 
   * @return authority string
   */
  std::string GetAuthority() const { return mAuthority; }
 
private:
  ServiceType mServiceType;
  std::string mUrl;
  std::string mResource;
  std::string mAuthority;
};
 
typedef std::vector<ServiceInfo> ServicesInfo;
 
/**
 * @brief Interface for the result of cloud discovery
 */
class CloudDiscoveryResult {
public:
  /**
   * @brief Get the services information #ServicesInfo
   *
   * @return a set of service information #ServicesInfo for the given domain info.
   * Throws a #NetworkError if the cloud discovery service returned an invalid or unexpected response.
   * Throws a #OperationCancelledError if the operation was cancelled.
   * Throws a #Error if some other error is encountered.
   */
  virtual ServicesInfo GetServicesInfo() const = 0;
 
  /**
   * @brief detect if the given domain info is a sovereign cloud.
   *
   * @return true if the given domain info is a sovereign cloud, false otherwise.
   * Throws a #NetworkError if the cloud discovery service returned an invalid or unexpected response.
   * Throws a #OperationCancelledError if the operation was cancelled.
   * Throws a #Error if some other error is encountered.
   */
  virtual bool IsSovereignCloud() const = 0;
};
 
/**
* @brief Interface for overriding cloud discovery
*/
class CloudDiscoveryDelegate {
public:
  /**
   * @brief Get all services information for the given domain info
   * 
   * @param domainInfo domain name or tenant Id.
   * @param context opaque client context.
   * 
   * @return a set of service information #ServicesInfo for the given domain info.
   */
  virtual ServicesInfo GetServicesInfo(
      const std::string& domainInfo, 
      const std::shared_ptr<void>& context) = 0;
 
  /**
   * @brief Asynchronously get all services information for the given domain info.
   * 
   * @param domainInfo domain name or tenant Id.
   * @param context opaque client context.
   * @param callbackFn Function that will be executed upon completion.
   */
  virtual void GetServicesInfoAsync(
      const std::string& domainInfo,
      const std::shared_ptr<void>& context,
      const std::function<void(const std::shared_ptr<CloudDiscoveryResult>& )>& callbackFn) = 0;
  
  /**
   * @brief Get all services information for the given cloud and data boundary.
   * 
   * @param cloud Azure cloud identifier #Cloud.
   * @param dataBoundary Diagnostic region identifier #DataBoundary.
   * @param context opaque client context.
   * 
   * @return a set of service information for the given cloud and data boundary.
   */
  virtual ServicesInfo GetServicesInfo(
      const mip::Cloud cloud, 
      const mip::DataBoundary dataBoundary,
      const std::shared_ptr<void>& context) = 0;
 
  /**
   * @brief Asynchronously get all services information for the given cloud and data boundary.
   * 
   * @param cloud Azure cloud identifier #Cloud.
   * @param dataBoundary Diagnostic region identifier #DataBoundary.
   * @param context opaque client context.
   * @param callbackFn Function that will be executed upon completion.
   */
  virtual void GetServicesInfoAsync(
      const mip::Cloud cloud,
      const mip::DataBoundary dataBoundary,
      const std::shared_ptr<void>& context,
      const std::function<void(const std::shared_ptr<CloudDiscoveryResult>& )>& callbackFn) = 0;
 
  /**
   * @brief detect if the given domain info is a sovereign cloud.
   *
   * @param domainInfo domain name or tenant Id.
   * @param context opaque client context.
   *
   * @return true if the given domain info is a sovereign cloud, false otherwise.
   */
  virtual bool IsSovereignCloud(
      const std::string& domainInfo,
      const std::shared_ptr<void>& context) = 0;
 
  /**
   * @brief Asynchronously detect if the given domain info is a sovereign cloud.
   *
   * @param domainInfo domain name or tenant Id.
   * @param context opaque client context.
   * @param callbackFn Function that will be executed upon completion.
   */
  virtual void IsSovereignCloudAsync(
      const std::string& domainInfo,
      const std::shared_ptr<void>& context,
      const std::function<void(const std::shared_ptr<CloudDiscoveryResult>& )>& callbackFn) = 0;
 
  /**
   * @brief if this cloud discovery delegate is offline only.
   * 
   * @return false if this cloud discovery delegate requires a network call, otherwise true.
   */
  virtual bool IsOffline() const = 0;
 
/** @cond DOXYGEN_HIDE */
 
  virtual ~CloudDiscoveryDelegate() {}
 
protected:
  CloudDiscoveryDelegate() {}
 
/** @endcond */
};
 
MIP_NAMESPACE_END
#endif // API_MIP_CLOUD_DISCOVERY_DELEGATE_H_