This is an automated email from the ASF dual-hosted git repository. nfilotto pushed a commit to branch CAMEL-17792/doc-message-headers in repository https://gitbox.apache.org/repos/asf/camel.git
commit c6fcd658f0ed8cd3073a894b5860a0677120a608 Author: Nicolas Filotto <[email protected]> AuthorDate: Wed Mar 16 15:55:50 2022 +0100 CAMEL-17792: Add doc about the message headers of camel-aws2-secrets-manager --- .../component/aws/secretsmanager/aws-secrets-manager.json | 10 ++++++++++ .../src/main/docs/aws-secrets-manager-component.adoc | 4 ++++ .../component/aws/secretsmanager/SecretsManagerConstants.java | 10 ++++++++++ .../component/aws/secretsmanager/SecretsManagerEndpoint.java | 3 ++- 4 files changed, 26 insertions(+), 1 deletion(-) diff --git a/components/camel-aws/camel-aws-secrets-manager/src/generated/resources/org/apache/camel/component/aws/secretsmanager/aws-secrets-manager.json b/components/camel-aws/camel-aws-secrets-manager/src/generated/resources/org/apache/camel/component/aws/secretsmanager/aws-secrets-manager.json index 7c1f7a4..2ee00fd 100644 --- a/components/camel-aws/camel-aws-secrets-manager/src/generated/resources/org/apache/camel/component/aws/secretsmanager/aws-secrets-manager.json +++ b/components/camel-aws/camel-aws-secrets-manager/src/generated/resources/org/apache/camel/component/aws/secretsmanager/aws-secrets-manager.json @@ -40,6 +40,16 @@ "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key" }, "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key" } }, + "headers": { + "CamelAwsSecretsManagerOperation": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The operation we want to perform" }, + "CamelAwsSecretsManagerMaxResults": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "Integer", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The number of results to include in the response." }, + "CamelAwsSecretsManagerSecretName": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the secret." }, + "CamelAwsSecretsManagerSecretDescription": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The description of the secret." }, + "CamelAwsSecretsManagerSecretId": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The ARN or name of the secret." }, + "CamelAwsSecretsManagerLambdaRotationFunctionArn": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The ARN of the Lambda rotation function that can rotate the secret." }, + "CamelAwsSecretsManagerSecretVersionId": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The unique identifier of the version of the secret." }, + "CamelAwsSecretsManagerSecretReplicationRegions": { "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "A comma separated list of Regions in which to replicate the secret." } + }, "properties": { "label": { "kind": "path", "displayName": "Label", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration", "configurationField": "configuration", "description": "Logical name" }, "binaryPayload": { "kind": "parameter", "displayName": "Binary Payload", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.aws.secretsmanager.SecretsManagerConfiguration", "configurationField": "configuration", "description": "Set if the secret is binary or not" }, diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc b/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc index 70042ff..0bb1193 100644 --- a/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc +++ b/components/camel-aws/camel-aws-secrets-manager/src/main/docs/aws-secrets-manager-component.adoc @@ -157,6 +157,10 @@ For the moment we are not considering the rotation function, if any will be appl The only requirement is adding the camel-aws-secrets-manager jar to your Camel application. +// component headers: START +include::partial$component-endpoint-headers.adoc[] +// component headers: END + === Secrets Manager Producer operations Camel-AWS-Secrets-manager component provides the following operation on the producer side: diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerConstants.java b/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerConstants.java index 495dd7d..ad3d0e5 100644 --- a/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerConstants.java +++ b/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerConstants.java @@ -16,16 +16,26 @@ */ package org.apache.camel.component.aws.secretsmanager; +import org.apache.camel.spi.Metadata; + /** * Constants used in Camel AWS Secrets Manager module */ public interface SecretsManagerConstants { + @Metadata(description = "The operation we want to perform", javaType = "String") String OPERATION = "CamelAwsSecretsManagerOperation"; + @Metadata(description = "The number of results to include in the response.", javaType = "Integer") String MAX_RESULTS = "CamelAwsSecretsManagerMaxResults"; + @Metadata(description = "The name of the secret.", javaType = "String") String SECRET_NAME = "CamelAwsSecretsManagerSecretName"; + @Metadata(description = "The description of the secret.", javaType = "String") String SECRET_DESCRIPTION = "CamelAwsSecretsManagerSecretDescription"; + @Metadata(description = "The ARN or name of the secret.", javaType = "String") String SECRET_ID = "CamelAwsSecretsManagerSecretId"; + @Metadata(description = "The ARN of the Lambda rotation function that can rotate the secret.", javaType = "String") String LAMBDA_ROTATION_FUNCTION_ARN = "CamelAwsSecretsManagerLambdaRotationFunctionArn"; + @Metadata(description = "The unique identifier of the version of the secret.", javaType = "String") String SECRET_VERSION_ID = "CamelAwsSecretsManagerSecretVersionId"; + @Metadata(description = "A comma separated list of Regions in which to replicate the secret.", javaType = "String") String SECRET_REPLICATION_REGIONS = "CamelAwsSecretsManagerSecretReplicationRegions"; } diff --git a/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerEndpoint.java b/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerEndpoint.java index 327046b..b93c491 100644 --- a/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerEndpoint.java +++ b/components/camel-aws/camel-aws-secrets-manager/src/main/java/org/apache/camel/component/aws/secretsmanager/SecretsManagerEndpoint.java @@ -32,7 +32,8 @@ import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient; * Manage AWS Secrets Manager services using AWS SDK version 2.x. */ @UriEndpoint(firstVersion = "3.9.0", scheme = "aws-secrets-manager", title = "AWS Secrets Manager", - syntax = "aws-secrets-manager:label", producerOnly = true, category = { Category.CLOUD, Category.MANAGEMENT }) + syntax = "aws-secrets-manager:label", producerOnly = true, category = { Category.CLOUD, Category.MANAGEMENT }, + headersClass = SecretsManagerConstants.class) public class SecretsManagerEndpoint extends ScheduledPollEndpoint { private SecretsManagerClient secretsManagerClient;
