minifi-api/include/minifi-cpp/core/ProcessorApi.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 <chrono>
#include <memory>
#include <mutex>
#include <string>
#include <unordered_set>
#include <unordered_map>

#include "ConfigurableComponent.h"
#include "Connectable.h"
#include "Property.h"
#include "DynamicProperty.h"
#include "Core.h"
#include "minifi-cpp/core/Annotation.h"
#include "Scheduling.h"
#include "minifi-cpp/core/state/nodes/MetricsBase.h"
#include "ProcessorMetrics.h"
#include "utils/gsl.h"
#include "core/logging/Logger.h"

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

class Connection;

namespace core {

class ProcessContext;
class ProcessSession;
class ProcessSessionFactory;
class ProcessorDescriptor;

class ProcessorApi {
 public:
  virtual ~ProcessorApi() = default;

  virtual bool isWorkAvailable() = 0;

  virtual void restore(const std::shared_ptr<FlowFile>& file) = 0;


  [[nodiscard]] virtual bool supportsDynamicProperties() const = 0;
  [[nodiscard]] virtual bool supportsDynamicRelationships() const = 0;

  virtual void initialize(ProcessorDescriptor& descriptor) = 0;
  virtual bool isSingleThreaded() const = 0;
  virtual std::string getProcessorType() const = 0;
  virtual bool getTriggerWhenEmpty() const = 0;
  virtual void onTrigger(ProcessContext&, ProcessSession&) = 0;
  virtual void onSchedule(ProcessContext&, ProcessSessionFactory&) = 0;
  virtual void onUnSchedule() = 0;
  virtual void notifyStop() = 0;
  virtual annotation::Input getInputRequirement() const = 0;
  virtual gsl::not_null<std::shared_ptr<ProcessorMetrics>> getMetrics() const = 0;
  virtual void setLoggerCallback(const std::function<void(logging::LOG_LEVEL level, const std::string& message)>& callback) = 0;
};

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