Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MINIFICPP-2221 Auto-generate CONTROLLERS.md #1665

Closed
wants to merge 5 commits into from
Closed

MINIFICPP-2221 Auto-generate CONTROLLERS.md #1665

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3df7c6
MINIFICPP-2221 Auto-generate CONTROLLERS.md
fgerlits Sep 19, 2023
0389e80
use a raw string literal for the license string
fgerlits Sep 22, 2023
820e4ae
use {} instead of = for initialization; VS likes this better
fgerlits Sep 22, 2023
73c477c
change lowercaseFirst() to a function to match the other helper funct…
fgerlits Sep 25, 2023
7af96ad
remove the bugprone-unchecked-optional-access clang-tidy check
fgerlits Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
297 changes: 247 additions & 50 deletions CONTROLLERS.md
View file
Open in desktop

Large diffs are not rendered by default.

244 changes: 122 additions & 122 deletions PROCESSORS.md
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion extensions/aws/controllerservices/AWSCredentialsService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ class AWSCredentialsService : public core::controller::ControllerService {
: ControllerService(name) {
}

EXTENSIONAPI static constexpr const char* Description = "AWS Credentials Management Service";
EXTENSIONAPI static constexpr const char* Description = "Manages the Amazon Web Services (AWS) credentials for an AWS account. This allows for multiple "
"AWS credential services to be defined. This also allows for multiple AWS related processors to reference this single "
"controller service so that AWS credentials can be managed and controlled in a central location.";

EXTENSIONAPI static constexpr auto UseDefaultCredentials = core::PropertyDefinitionBuilder<>::createProperty("Use Default Credentials")
.withDescription("If true, uses the Default Credential chain, including EC2 instance profiles or roles, environment variables, default user credentials, etc.")
Expand Down
3 changes: 2 additions & 1 deletion extensions/azure/controllerservices/AzureStorageCredentialsService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ namespace org::apache::nifi::minifi::azure::controllers {

class AzureStorageCredentialsService : public core::controller::ControllerService {
public:
EXTENSIONAPI static constexpr const char* Description = "Azure Storage Credentials Management Service";
EXTENSIONAPI static constexpr const char* Description = "Manages the credentials for an Azure Storage account. This allows for multiple Azure Storage related processors to reference this single "
"controller service so that Azure storage credentials can be managed and controlled in a central location.";

EXTENSIONAPI static constexpr auto StorageAccountName = core::PropertyDefinitionBuilder<>::createProperty("Storage Account Name")
.withDescription("The storage account name.")
Expand Down
3 changes: 2 additions & 1 deletion extensions/gcp/controllerservices/GCPCredentialsControllerService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ namespace org::apache::nifi::minifi::extensions::gcp {

class GCPCredentialsControllerService : public core::controller::ControllerService {
public:
EXTENSIONAPI static constexpr const char* Description = "Google Cloud Platform Credentials Controller Service";
EXTENSIONAPI static constexpr const char* Description = "Manages the credentials for Google Cloud Platform. This allows for multiple Google Cloud Platform related processors "
"to reference this single controller service so that Google Cloud Platform credentials can be managed and controlled in a central location.";

EXTENSIONAPI static constexpr auto CredentialsLoc = core::PropertyDefinitionBuilder<magic_enum::enum_count<CredentialsLocation>()>::createProperty("Credentials Location")
.withDescription("The location of the credentials.")
Expand Down
10 changes: 5 additions & 5 deletions libminifi/include/controllers/SSLContextService.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,27 +177,27 @@ class SSLContextService : public core::controller::ControllerService {

#ifdef WIN32
MINIFIAPI static constexpr auto CertStoreLocation = core::PropertyDefinitionBuilder<utils::tls::WindowsCertStoreLocation::SIZE>::createProperty("Certificate Store Location")
.withDescription("One of the Windows certificate store locations, eg. LocalMachine or CurrentUser")
.withDescription("One of the Windows certificate store locations, eg. LocalMachine or CurrentUser (Windows only)")
.withAllowedValues(utils::tls::WindowsCertStoreLocation::LOCATION_NAMES)
.isRequired(false)
.withDefaultValue(utils::tls::WindowsCertStoreLocation::DEFAULT_LOCATION)
.build();
MINIFIAPI static constexpr auto ServerCertStore = core::PropertyDefinitionBuilder<>::createProperty("Server Cert Store")
.withDescription("The name of the certificate store which contains the server certificate")
.withDescription("The name of the certificate store which contains the server certificate (Windows only)")
.isRequired(false)
.withDefaultValue("ROOT")
.build();
MINIFIAPI static constexpr auto ClientCertStore = core::PropertyDefinitionBuilder<>::createProperty("Client Cert Store")
.withDescription("The name of the certificate store which contains the client certificate")
.withDescription("The name of the certificate store which contains the client certificate (Windows only)")
.isRequired(false)
.withDefaultValue("MY")
.build();
MINIFIAPI static constexpr auto ClientCertCN = core::PropertyDefinitionBuilder<>::createProperty("Client Cert CN")
.withDescription("The CN that the client certificate is required to match; default: use the first available client certificate in the store")
.withDescription("The CN that the client certificate is required to match; default: use the first available client certificate in the store (Windows only)")
.isRequired(false)
.build();
MINIFIAPI static constexpr auto ClientCertKeyUsage = core::PropertyDefinitionBuilder<>::createProperty("Client Cert Key Usage")
.withDescription("Comma-separated list of enhanced key usage values that the client certificate is required to have")
.withDescription("Comma-separated list of enhanced key usage values that the client certificate is required to have (Windows only)")
.isRequired(false)
.withDefaultValue("Client Authentication")
.build();
Expand Down
4 changes: 2 additions & 2 deletions libminifi/include/core/PropertyDefinition.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ struct PropertyDefinition {
std::array<std::string_view, NumDependentProperties> dependent_properties;
std::array<std::pair<std::string_view, std::string_view>, NumExclusiveOfProperties> exclusive_of_properties;
std::optional<std::string_view> default_value;
gsl::not_null<const PropertyType*> type = gsl::make_not_null(&StandardPropertyTypes::VALID_TYPE);
gsl::not_null<const PropertyType*> type = gsl::make_not_null<const PropertyType*>(&StandardPropertyTypes::VALID_TYPE);
szaszm marked this conversation as resolved.
Show resolved Hide resolved
bool supports_expression_language = false;
};

Expand All @@ -53,7 +53,7 @@ struct PropertyReference {
std::span<const std::string_view> dependent_properties;
std::span<const std::pair<std::string_view, std::string_view>> exclusive_of_properties;
std::optional<std::string_view> default_value;
gsl::not_null<const PropertyType*> type = gsl::make_not_null(&StandardPropertyTypes::VALID_TYPE);
gsl::not_null<const PropertyType*> type = gsl::make_not_null<const PropertyType*>(&StandardPropertyTypes::VALID_TYPE);
bool supports_expression_language = false;

constexpr PropertyReference() = default;
Expand Down
16 changes: 8 additions & 8 deletions libminifi/include/core/PropertyType.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,21 +335,21 @@ inline constexpr auto LISTEN_PORT_TYPE = ListenPortValidator{};

inline gsl::not_null<const PropertyValidator*> getValidator(const std::shared_ptr<minifi::state::response::Value>& input) {
if (std::dynamic_pointer_cast<core::DataSizeValue>(input) != nullptr) {
return gsl::make_not_null(&DATA_SIZE_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&DATA_SIZE_TYPE);
} else if (std::dynamic_pointer_cast<core::TimePeriodValue>(input) != nullptr) {
return gsl::make_not_null(&TIME_PERIOD_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&TIME_PERIOD_TYPE);
} else if (std::dynamic_pointer_cast<minifi::state::response::BoolValue>(input) != nullptr) {
return gsl::make_not_null(&BOOLEAN_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&BOOLEAN_TYPE);
} else if (std::dynamic_pointer_cast<minifi::state::response::IntValue>(input) != nullptr) {
return gsl::make_not_null(&INTEGER_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&INTEGER_TYPE);
} else if (std::dynamic_pointer_cast<minifi::state::response::UInt32Value>(input) != nullptr) {
return gsl::make_not_null(&UNSIGNED_INT_TYPE);;
return gsl::make_not_null<const PropertyValidator*>(&UNSIGNED_INT_TYPE);;
} else if (std::dynamic_pointer_cast<minifi::state::response::Int64Value>(input) != nullptr) {
return gsl::make_not_null(&LONG_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&LONG_TYPE);
} else if (std::dynamic_pointer_cast<minifi::state::response::UInt64Value>(input) != nullptr) {
return gsl::make_not_null(&UNSIGNED_LONG_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&UNSIGNED_LONG_TYPE);
} else {
return gsl::make_not_null(&VALID_TYPE);
return gsl::make_not_null<const PropertyValidator*>(&VALID_TYPE);
}
}
} // namespace StandardPropertyTypes
Expand Down
Loading
Loading