Package org.apache.nifi.parameter.gcp

Class GcpSecretManagerParameterProvider

java.lang.Object
org.apache.nifi.components.AbstractConfigurableComponent
org.apache.nifi.parameter.AbstractParameterProvider
org.apache.nifi.parameter.gcp.GcpSecretManagerParameterProvider
All Implemented Interfaces:
org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.parameter.ParameterProvider, org.apache.nifi.parameter.VerifiableParameterProvider
@Tags({"gcp","secret","manager"}) @CapabilityDescription("Fetches parameters from GCP Secret Manager. Each secret becomes a Parameter, which can be mapped to a Parameter Group by adding a GCP label named \'group-name\'.") public class GcpSecretManagerParameterProvider extends org.apache.nifi.parameter.AbstractParameterProvider implements org.apache.nifi.parameter.VerifiableParameterProvider
Reads secrets from GCP Secret Manager to provide parameter values. Secrets must be created similar to the following GCP cli command:

gcp secretsmanager create-secret --name "[Context]" --secret-string '{ "[Param]": "[secretValue]", "[Param2]": "[secretValue2]" }'

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.nifi.components.PropertyDescriptor
    GCP_CREDENTIALS_PROVIDER_SERVICE
    Links to the GCPCredentialsService which provides credentials for this particular processor.
    private static final String
    GROUP_NAME_LABEL
     
    static final org.apache.nifi.components.PropertyDescriptor
    GROUP_NAME_PATTERN
     
    private static final org.slf4j.Logger
    logger
     
    static final org.apache.nifi.components.PropertyDescriptor
    PROJECT_ID
     
    private static final List<org.apache.nifi.components.PropertyDescriptor>
    PROPERTY_DESCRIPTORS
     
    private static final String
    SECRETS_PATH
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    GcpSecretManagerParameterProvider()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) com.google.cloud.secretmanager.v1.SecretManagerServiceClient
    configureClient(org.apache.nifi.controller.ConfigurationContext context)
     
    private org.apache.nifi.parameter.Parameter
    createParameter(String parameterName, String parameterValue)
     
    List<org.apache.nifi.parameter.ParameterGroup>
    fetchParameters(org.apache.nifi.controller.ConfigurationContext context)
     
    private void
    fetchSecret(com.google.cloud.secretmanager.v1.SecretManagerServiceClient secretsManager, org.apache.nifi.controller.ConfigurationContext context, String secretName, String groupName, Map<String,org.apache.nifi.parameter.ParameterGroup> providedParameterGroups)
     
    protected List<org.apache.nifi.components.PropertyDescriptor>
    getSupportedPropertyDescriptors()
     
    List<org.apache.nifi.components.ConfigVerificationResult>
    verify(org.apache.nifi.controller.ConfigurationContext context, org.apache.nifi.logging.ComponentLog verificationLogger)
     

    Methods inherited from class org.apache.nifi.parameter.AbstractParameterProvider

    getIdentifier, getLogger, getName, getNodeTypeProvider, init, initialize

    Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

    customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

    getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

  • Field Details

    • logger

      private static final org.slf4j.Logger logger

    • GROUP_NAME_PATTERN

      public static final org.apache.nifi.components.PropertyDescriptor GROUP_NAME_PATTERN

    • PROJECT_ID

      public static final org.apache.nifi.components.PropertyDescriptor PROJECT_ID

    • GCP_CREDENTIALS_PROVIDER_SERVICE

      public static final org.apache.nifi.components.PropertyDescriptor GCP_CREDENTIALS_PROVIDER_SERVICE
      Links to the GCPCredentialsService which provides credentials for this particular processor.

    • GROUP_NAME_LABEL

      private static final String GROUP_NAME_LABEL
      See Also:

    • SECRETS_PATH

      private static final String SECRETS_PATH
      See Also:

    • PROPERTY_DESCRIPTORS

      private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

  • Constructor Details

    • GcpSecretManagerParameterProvider

      public GcpSecretManagerParameterProvider()

  • Method Details

    • getSupportedPropertyDescriptors

      protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()
      Overrides:
      getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

    • fetchParameters

      public List<org.apache.nifi.parameter.ParameterGroup> fetchParameters(org.apache.nifi.controller.ConfigurationContext context) throws IOException
      Specified by:
      fetchParameters in interface org.apache.nifi.parameter.ParameterProvider
      Throws:
      IOException

    • verify

      public List<org.apache.nifi.components.ConfigVerificationResult> verify(org.apache.nifi.controller.ConfigurationContext context, org.apache.nifi.logging.ComponentLog verificationLogger)
      Specified by:
      verify in interface org.apache.nifi.parameter.VerifiableParameterProvider

    • fetchSecret

      private void fetchSecret(com.google.cloud.secretmanager.v1.SecretManagerServiceClient secretsManager, org.apache.nifi.controller.ConfigurationContext context, String secretName, String groupName, Map<String,org.apache.nifi.parameter.ParameterGroup> providedParameterGroups)

    • createParameter

      private org.apache.nifi.parameter.Parameter createParameter(String parameterName, String parameterValue)

    • configureClient

      com.google.cloud.secretmanager.v1.SecretManagerServiceClient configureClient(org.apache.nifi.controller.ConfigurationContext context) throws IOException
      Throws:
      IOException