com.google.cloud.spring.autoconfigure.secretmanager.GcpSecretManagerProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-gcp-autoconfigure Show documentation

Spring Framework on Google Cloud

There is a newer version: 5.6.1

Show newest version

/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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.
 */

package com.google.cloud.spring.autoconfigure.secretmanager;

import static com.google.cloud.spring.autoconfigure.secretmanager.GcpSecretManagerProperties.PREFIX;

import com.google.cloud.spring.core.Credentials;
import com.google.cloud.spring.core.CredentialsSupplier;
import com.google.cloud.spring.core.GcpScope;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.NestedConfigurationProperty;

@ConfigurationProperties(PREFIX)
public class GcpSecretManagerProperties implements CredentialsSupplier {

  /**
   * Configuration prefix for Secret Manager properties.
   */
  public static final String PREFIX = "spring.cloud.gcp.secretmanager";

  /**
   * Overrides the GCP OAuth2 credentials specified in the Core module.
   */
  @NestedConfigurationProperty
  private final Credentials credentials = new Credentials(GcpScope.CLOUD_PLATFORM.getUrl());

  /**
   * Overrides the GCP Project ID specified in the Core module.
   */
  private String projectId;

  /**
   * Whether the secret manager will allow a default secret value when accessing a non-existing
   * secret.
   *
   * When set to false, the secret manager will throw a {@link
   * com.google.api.gax.rpc.NotFoundException}.
   */
  private boolean allowDefaultSecret;

  public Credentials getCredentials() {
    return credentials;
  }

  public String getProjectId() {
    return projectId;
  }

  public void setProjectId(String projectId) {
    this.projectId = projectId;
  }

  public boolean isAllowDefaultSecret() {
    return allowDefaultSecret;
  }

  public void setAllowDefaultSecret(boolean allowDefaultSecret) {
    this.allowDefaultSecret = allowDefaultSecret;
  }
}