libminifi/include/core/controller/ControllerServiceLookup.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.
 */
#ifndef LIBMINIFI_INCLUDE_CORE_CONTROLLER_CONTROLLERSERVICELOOKUP_H_
#define LIBMINIFI_INCLUDE_CORE_CONTROLLER_CONTROLLERSERVICELOOKUP_H_

#include <map>
#include "core/Core.h"
#include "core/ConfigurableComponent.h"
#include "ControllerService.h"

namespace org {
namespace apache {
namespace nifi {
namespace minifi {
namespace core {
namespace controller {

/**
 * Controller Service Lookup pure virtual class.
 *
 * Purpose: Provide a mechanism that controllers can lookup information about
 * controller services.
 *
 */
class ControllerServiceLookup {
 public:

  ControllerServiceLookup() {

  }

  virtual ~ControllerServiceLookup() {

  }

  /**
   * Gets the controller service via the provided identifier.
   * @param identifier reference string for controller service.
   * @return controller service reference.
   */
  virtual std::shared_ptr<ControllerService> getControllerService(const std::string &identifier) = 0;

  /**
   * Detects if controller service is enabled.
   * @param identifier reference string for controller service.
   * @return true if controller service is enabled.
   */
  virtual bool isControllerServiceEnabled(const std::string &identifier) = 0;

  /**
   * Detects if controller service is being enabled.
   * @param identifier reference string for controller service.
   * @return true if controller service is enabled.
   */
  virtual bool isControllerServiceEnabling(const std::string &identifier) = 0;

  /**
   * Gets the controller service name for the provided reference identifier
   * @param identifier reference string for the controller service.
   */
  virtual const std::string getControllerServiceName(const std::string &identifier) = 0;

};

} /* namespace controller */
} /* namespace core */
} /* namespace minifi */
} /* namespace nifi */
} /* namespace apache */
} /* namespace org */

#endif /* LIBMINIFI_INCLUDE_CORE_CONTROLLER_CONTROLLERSERVICELOOKUP_H_ */