minifi-api/include/minifi-cpp/controllers/ProxyConfigurationServiceInterface.h

/**
* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */
#pragma once

#include <string>
#include <optional>

#include "minifi-cpp/core/controller/ControllerServiceHandle.h"
#include "minifi-cpp/core/ControllerServiceTypeDefinition.h"
#include "minifi-cpp/agent/agent_version.h"

namespace org::apache::nifi::minifi::controllers {

enum class ProxyType {
  DIRECT,
  HTTP
};

struct BasicAuthCredentials {
  std::string username;
  std::string password;
};

class ProxyConfigurationServiceInterface : public virtual core::controller::ControllerServiceHandle {
 public:
  static constexpr auto ProvidesApi = core::ControllerServiceTypeDefinition {
    .artifact = "minifi-system",
    .group = "org.apache.nifi.minifi",
    .type = "org.apache.nifi.minifi.controllers.ProxyConfigurationServiceInterface",
    .version = MINIFI_VERSION_STR
  };

  virtual std::string getHost() const = 0;
  virtual uint16_t getPort() const = 0;
  virtual std::optional<BasicAuthCredentials> getProxyCredentials() const = 0;
  virtual ProxyType getProxyType() const = 0;
};

}  // namespace org::apache::nifi::minifi::controllers