szaszm commented on code in PR #2045: URL: https://github.com/apache/nifi-minifi-cpp/pull/2045#discussion_r2523491692
########## minifi-api/include/minifi-cpp/controllers/ProxyConfigurationServiceInterface.h: ########## @@ -0,0 +1,42 @@ +/** +* 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 "minifi-cpp/core/controller/ControllerService.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" + +namespace org::apache::nifi::minifi::controllers { + +struct ProxyConfiguration { + std::string proxy_host; + std::optional<uint16_t> proxy_port; + std::optional<std::string> proxy_user; + std::optional<std::string> proxy_password; +}; Review Comment: details like this should not be on the API. username/password can be optional and replaced by other auth methods in some other proxy protocols. Possibly even hostname and port can vary. ########## CONTROLLERS.md: ########## @@ -244,6 +245,24 @@ In the list below, the names of required properties appear in bold. Any other pr | **File** | | | Path to a file to store state | +## ProxyConfigurationService + +### Description + +Provides a set of configurations for different MiNiFi C++ components to use a proxy server. Review Comment: The proxy protocol is not specified anywhere. Typical options include http, https, socks4, socks4a, socks5. We should document what this service uses and leave the door open for more protocols in the future. -- 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]
