lordgamez commented on code in PR #2065:
URL: https://github.com/apache/nifi-minifi-cpp/pull/2065#discussion_r2891064372
##########
minifi-api/include/minifi-cpp/core/controller/ControllerServiceInterface.h:
##########
@@ -28,27 +28,15 @@
namespace org::apache::nifi::minifi::core::controller {
-enum ControllerServiceState {
- DISABLED,
- DISABLING,
- ENABLING,
- ENABLED
-};
-
/**
* Controller Service base class that contains some pure virtual methods.
*
* Design: OnEnable is executed when the controller service is being enabled.
* Note that keeping state here must be protected in this function.
*/
Review Comment:
This comment is not valid anymore. For this interface it would be beneficial
to explain what the purpose of this class is and how is it used.
##########
core-framework/include/core/controller/ControllerServiceBase.h:
##########
@@ -0,0 +1,113 @@
+/**
+ *
+ * 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 <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "minifi-cpp/properties/Configure.h"
+#include "core/Core.h"
+#include "core/ConfigurableComponentImpl.h"
+#include "core/Connectable.h"
+#include "minifi-cpp/core/controller/ControllerServiceApi.h"
+#include "minifi-cpp/core/controller/ControllerServiceInterface.h"
+#include "minifi-cpp/core/ControllerServiceApiDefinition.h"
+#include "minifi-cpp/core/controller/ControllerServiceMetadata.h"
+
+namespace org::apache::nifi::minifi::core::controller {
+
+// A base class that helps with controller service development, contains
common functionalities.
Review Comment:
I don't think this comment is useful, the name of the class implies all of
this.
##########
minifi-api/include/minifi-cpp/core/controller/ControllerServiceApi.h:
##########
@@ -0,0 +1,39 @@
+/**
+* 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 <memory>
+#include <vector>
+
+#include "ControllerServiceInterface.h"
+#include "ControllerServiceContext.h"
+#include "ControllerServiceDescriptor.h"
+#include "minifi-cpp/properties/Configure.h"
+
+namespace org::apache::nifi::minifi::core::controller {
+
+class ControllerServiceApi {
+ public:
+ virtual ~ControllerServiceApi() = default;
+
+ virtual void initialize(ControllerServiceDescriptor& descriptor) = 0;
+ virtual void onEnable(ControllerServiceContext& context, const
std::shared_ptr<Configure>& configuration, const
std::vector<std::shared_ptr<ControllerServiceInterface>>& linked_services) = 0;
+ virtual void notifyStop() = 0;
+ virtual ControllerServiceInterface* getControllerServiceInterface() = 0;
Review Comment:
I see the reason behind this, but it is a bit convoluted. It should get a
comment explaining it and how to implement it.
##########
core-framework/include/core/controller/ControllerServiceBase.h:
##########
@@ -0,0 +1,113 @@
+/**
+ *
+ * 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 <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "minifi-cpp/properties/Configure.h"
+#include "core/Core.h"
+#include "core/ConfigurableComponentImpl.h"
+#include "core/Connectable.h"
+#include "minifi-cpp/core/controller/ControllerServiceApi.h"
+#include "minifi-cpp/core/controller/ControllerServiceInterface.h"
+#include "minifi-cpp/core/ControllerServiceApiDefinition.h"
+#include "minifi-cpp/core/controller/ControllerServiceMetadata.h"
+
+namespace org::apache::nifi::minifi::core::controller {
+
+// A base class that helps with controller service development, contains
common functionalities.
+class ControllerServiceBase : public ControllerServiceApi {
+ public:
+ explicit ControllerServiceBase(ControllerServiceMetadata metadata)
+ : name_(std::move(metadata.name)),
+ uuid_(metadata.uuid),
+ logger_(std::move(metadata.logger)) {}
+
+ virtual void initialize() {}
+
+ void initialize(ControllerServiceDescriptor& descriptor) final {
+ gsl_Expects(!descriptor_);
+ descriptor_ = &descriptor;
+ auto guard = gsl::finally([&] {descriptor_ = nullptr;});
+ initialize();
+ }
+
+ void setSupportedProperties(std::span<const PropertyReference> properties) {
+ gsl_Expects(descriptor_);
+ descriptor_->setSupportedProperties(properties);
+ }
+
+ ~ControllerServiceBase() override {}
+
+ virtual void onEnable() {}
+
+ /**
+ * Function is called when Controller Services are enabled and being run
+ */
Review Comment:
This also seems redundant
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
