org.springframework.cloud.gcp.core.GcpProjectIdProvider Java Examples

public GcpPubSubAutoConfiguration(GcpPubSubProperties gcpPubSubProperties,
		GcpProjectIdProvider gcpProjectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {
	this.gcpPubSubProperties = gcpPubSubProperties;
	this.finalProjectIdProvider = (gcpPubSubProperties.getProjectId() != null)
			? gcpPubSubProperties::getProjectId
			: gcpProjectIdProvider;

	if (gcpPubSubProperties.getEmulatorHost() == null
			|| "false".equals(gcpPubSubProperties.getEmulatorHost())) {
		this.finalCredentialsProvider = gcpPubSubProperties.getCredentials().hasKey()
				? new DefaultCredentialsProvider(gcpPubSubProperties)
				: credentialsProvider;
	}
	else {
		// Since we cannot create a general NoCredentialsProvider if the emulator host is enabled
		// (because it would also be used for the other components), we have to create one here
		// for this particular case.
		this.finalCredentialsProvider = NoCredentialsProvider.create();
	}
}
 

public GoogleConfigPropertySourceLocator(GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider,
		GcpConfigProperties gcpConfigProperties) throws IOException {
	Assert.notNull(gcpConfigProperties, "Google Config properties must not be null");

	if (gcpConfigProperties.isEnabled()) {
		Assert.notNull(credentialsProvider, "Credentials provider cannot be null");
		Assert.notNull(projectIdProvider, "Project ID provider cannot be null");
		this.credentials = gcpConfigProperties.getCredentials().hasKey()
				? new DefaultCredentialsProvider(gcpConfigProperties).getCredentials()
				: credentialsProvider.getCredentials();
		this.projectId = (gcpConfigProperties.getProjectId() != null)
				? gcpConfigProperties.getProjectId()
				: projectIdProvider.getProjectId();
		Assert.notNull(this.credentials, "Credentials must not be null");

		Assert.notNull(this.projectId, "Project ID must not be null");

		this.timeout = gcpConfigProperties.getTimeoutMillis();
		this.name = gcpConfigProperties.getName();
		this.profile = gcpConfigProperties.getProfile();
		this.enabled = gcpConfigProperties.isEnabled();
		Assert.notNull(this.name, "Config name must not be null");
		Assert.notNull(this.profile, "Config profile must not be null");
	}
}
 

CoreSpannerAutoConfiguration(GcpSpannerProperties gcpSpannerProperties,
		GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {
	this.credentials = (gcpSpannerProperties.getCredentials().hasKey()
			? new DefaultCredentialsProvider(gcpSpannerProperties)
			: credentialsProvider).getCredentials();
	this.projectId = (gcpSpannerProperties.getProjectId() != null)
			? gcpSpannerProperties.getProjectId()
			: projectIdProvider.getProjectId();
	this.instanceId = gcpSpannerProperties.getInstanceId();
	this.databaseName = gcpSpannerProperties.getDatabase();
	this.numRpcChannels = gcpSpannerProperties.getNumRpcChannels();
	this.prefetchChunks = gcpSpannerProperties.getPrefetchChunks();
	this.minSessions = gcpSpannerProperties.getMinSessions();
	this.maxSessions = gcpSpannerProperties.getMaxSessions();
	this.maxIdleSessions = gcpSpannerProperties.getMaxIdleSessions();
	this.writeSessionsFraction = gcpSpannerProperties.getWriteSessionsFraction();
	this.keepAliveIntervalMinutes = gcpSpannerProperties
			.getKeepAliveIntervalMinutes();
	this.createInterleavedTableDdlOnDeleteCascade = gcpSpannerProperties
			.isCreateInterleavedTableDdlOnDeleteCascade();
	this.failIfPoolExhausted = gcpSpannerProperties.isFailIfPoolExhausted();
}
 

public StackdriverTraceAutoConfiguration(GcpProjectIdProvider gcpProjectIdProvider,
		CredentialsProvider credentialsProvider,
		GcpTraceProperties gcpTraceProperties) throws IOException {
	this.finalProjectIdProvider = (gcpTraceProperties.getProjectId() != null)
			? gcpTraceProperties::getProjectId
			: gcpProjectIdProvider;
	this.finalCredentialsProvider =
			gcpTraceProperties.getCredentials().hasKey()
					? new DefaultCredentialsProvider(gcpTraceProperties)
					: credentialsProvider;
}
 

@Bean
public static Storage storage(CredentialsProvider credentialsProvider,
		GcpProjectIdProvider projectIdProvider) throws IOException {
	return StorageOptions.newBuilder()
			.setCredentials(credentialsProvider.getCredentials())
			.setProjectId(projectIdProvider.getProjectId()).build().getService();
}
 

/**
 * Get a GCP project ID provider.
 * @return a {@link GcpProjectIdProvider} that returns the project ID in the properties or, if
 * none, the project ID from the GOOGLE_CLOUD_PROJECT envvar and Metadata Server
 */
@Bean
@ConditionalOnMissingBean
public GcpProjectIdProvider gcpProjectIdProvider() {
	GcpProjectIdProvider projectIdProvider =
			(this.gcpProperties.getProjectId() != null)
					? () -> this.gcpProperties.getProjectId()
					: new DefaultGcpProjectIdProvider();

	if (LOGGER.isInfoEnabled()) {
		LOGGER.info("The default project ID is " + projectIdProvider.getProjectId());
	}

	return projectIdProvider;
}
 

@Bean
@ConditionalOnMissingBean(name = "firebaseJwtDelegatingValidator")
public DelegatingOAuth2TokenValidator<Jwt> firebaseJwtDelegatingValidator(JwtIssuerValidator jwtIssuerValidator, GcpProjectIdProvider gcpProjectIdProvider) {
	List<OAuth2TokenValidator<Jwt>> validators = new ArrayList<>();
	validators.add(new JwtTimestampValidator());
	validators.add(jwtIssuerValidator);
	validators.add(new FirebaseTokenValidator(projectId));
	return new DelegatingOAuth2TokenValidator<>(validators);
}
 

public GcpStackdriverMetricsAutoConfiguration(GcpMetricsProperties gcpMetricsProperties,
		StackdriverProperties stackdriverProperties, GcpProjectIdProvider gcpProjectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {
	this.stackdriverProperties = stackdriverProperties;
	this.projectId = (gcpMetricsProperties.getProjectId() != null)
			? gcpMetricsProperties.getProjectId() : gcpProjectIdProvider.getProjectId();
	this.credentialsProvider = gcpMetricsProperties.getCredentials().hasKey()
			? new DefaultCredentialsProvider(gcpMetricsProperties) : credentialsProvider;
}
 

GcpBigQueryAutoConfiguration(
		GcpBigQueryProperties gcpBigQueryProperties,
		GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {

	this.projectId = (gcpBigQueryProperties.getProjectId() != null)
			? gcpBigQueryProperties.getProjectId()
			: projectIdProvider.getProjectId();

	this.credentialsProvider = (gcpBigQueryProperties.getCredentials().hasKey()
			? new DefaultCredentialsProvider(gcpBigQueryProperties)
			: credentialsProvider);

	this.datasetName = gcpBigQueryProperties.getDatasetName();
}
 

GcpDatastoreAutoConfiguration(GcpDatastoreProperties gcpDatastoreProperties,
		GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {

	this.projectId = (gcpDatastoreProperties.getProjectId() != null)
			? gcpDatastoreProperties.getProjectId()
			: projectIdProvider.getProjectId();
	this.namespace = gcpDatastoreProperties.getNamespace();

	String hostToConnect = gcpDatastoreProperties.getHost();
	if (gcpDatastoreProperties.getEmulator().isEnabled()) {
		hostToConnect = "localhost:" + gcpDatastoreProperties.getEmulator().getPort();
		LOGGER.info("Connecting to a local datastore emulator.");
	}

	if (hostToConnect == null) {
		this.credentials = (gcpDatastoreProperties.getCredentials().hasKey()
				? new DefaultCredentialsProvider(gcpDatastoreProperties)
				: credentialsProvider).getCredentials();
	}
	else {
		// Use empty credentials with Datastore Emulator.
		this.credentials = NoCredentials.getInstance();
	}

	this.host = hostToConnect;
}
 

GcpFirestoreAutoConfiguration(GcpFirestoreProperties gcpFirestoreProperties,
		GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {

	this.projectId = (gcpFirestoreProperties.getProjectId() != null)
			? gcpFirestoreProperties.getProjectId()
			: projectIdProvider.getProjectId();

	this.credentialsProvider = (gcpFirestoreProperties.getCredentials().hasKey()
			? new DefaultCredentialsProvider(gcpFirestoreProperties)
			: credentialsProvider);

	this.hostPort = gcpFirestoreProperties.getHostPort();
	this.firestoreRootPath = String.format(ROOT_PATH_FORMAT, this.projectId);
}
 

public SecretManagerPropertySource(
		String propertySourceName,
		SecretManagerTemplate secretManagerTemplate,
		GcpProjectIdProvider projectIdProvider) {
	super(propertySourceName, secretManagerTemplate);

	this.projectIdProvider = projectIdProvider;
}
 

@Override
public void start() {
	super.start();

	// If no Project ID set, then attempt to resolve it with the default project ID provider
	if (StringUtils.isEmpty(this.projectId) || this.projectId.endsWith("_IS_UNDEFINED")) {
		GcpProjectIdProvider projectIdProvider = new DefaultGcpProjectIdProvider();
		this.projectId = projectIdProvider.getProjectId();
	}
}
 

/**
 * Constructor that accepts an {@link TraceIdLoggingWebMvcInterceptor}. If the given
 * interceptor is null, then a default {@link XCloudTraceIdExtractor} is used.
 * @param interceptor the interceptor to use with this configurer. If not provided a
 * {@link TraceIdLoggingWebMvcInterceptor} is used with the trace ID extractor
 * described above.
 * @param projectIdProvider the project ID provider to use
 */
public LoggingWebMvcConfigurer(
		@Autowired(required = false) TraceIdLoggingWebMvcInterceptor interceptor,
		GcpProjectIdProvider projectIdProvider) {
	if (interceptor != null) {
		this.interceptor = interceptor;
	}
	else {
		this.interceptor = new TraceIdLoggingWebMvcInterceptor(
				new XCloudTraceIdExtractor());
	}
}
 

public PubSubAdmin(GcpProjectIdProvider projectIdProvider, TopicAdminClient topicAdminClient,
		SubscriptionAdminClient subscriptionAdminClient) {
	Assert.notNull(projectIdProvider, "The project ID provider can't be null.");
	Assert.notNull(topicAdminClient, "The topic administration client can't be null");
	Assert.notNull(subscriptionAdminClient,
			"The subscription administration client can't be null");

	this.projectId = projectIdProvider.getProjectId();
	Assert.hasText(this.projectId, "The project ID can't be null or empty.");
	this.topicAdminClient = topicAdminClient;
	this.subscriptionAdminClient = subscriptionAdminClient;
}
 

/**
 * This constructor instantiates TopicAdminClient and SubscriptionAdminClient with all their
 * defaults and the provided credentials provider.
 * @param projectIdProvider the project id provider to use
 * @param credentialsProvider the credentials provider to use
 * @throws IOException thrown when there are errors in contacting Google Cloud Pub/Sub
 */
public PubSubAdmin(GcpProjectIdProvider projectIdProvider,
		CredentialsProvider credentialsProvider) throws IOException {
	this(projectIdProvider,
			TopicAdminClient.create(
					TopicAdminSettings.newBuilder()
							.setCredentialsProvider(credentialsProvider)
							.build()),
			SubscriptionAdminClient.create(
					SubscriptionAdminSettings.newBuilder()
					.setCredentialsProvider(credentialsProvider)
					.build()));
}
 

/**
 * Default {@link DefaultSubscriberFactory} constructor.
 * @param projectIdProvider provides the default GCP project ID for selecting the subscriptions
 */
public DefaultSubscriberFactory(GcpProjectIdProvider projectIdProvider) {
	Assert.notNull(projectIdProvider, "The project ID provider can't be null.");

	this.projectId = projectIdProvider.getProjectId();
	Assert.hasText(this.projectId, "The project ID can't be null or empty.");
}
 

/**
 * Create {@link DefaultPublisherFactory} instance based on the provided {@link GcpProjectIdProvider}.
 * <p>The {@link GcpProjectIdProvider} must not be null, neither provide an empty {@code projectId}.
 * @param projectIdProvider provides the default GCP project ID for selecting the topic
 */
public DefaultPublisherFactory(GcpProjectIdProvider projectIdProvider) {
	Assert.notNull(projectIdProvider, "The project ID provider can't be null.");

	this.projectId = projectIdProvider.getProjectId();
	Assert.hasText(this.projectId, "The project ID can't be null or empty.");
}
 

@Test
public void testGetProjectIdProvider_withGcpProperties() {
	this.contextRunner.withPropertyValues("spring.cloud.gcp.projectId=tonberry")
			.run((context) -> {
				GcpProjectIdProvider projectIdProvider =
						context.getBean(GcpProjectIdProvider.class);
				assertThat(projectIdProvider.getProjectId()).isEqualTo("tonberry");
			});
}
 

@Test
public void testGetProjectIdProvider_withoutGcpProperties() {
	this.contextRunner.run((context) -> {
		GcpProjectIdProvider projectIdProvider =
				context.getBean(GcpProjectIdProvider.class);
		assertThat(projectIdProvider).isInstanceOf(DefaultGcpProjectIdProvider.class);
	});
}
 

public GcpStorageAutoConfiguration(
		GcpProjectIdProvider coreProjectIdProvider,
		CredentialsProvider credentialsProvider,
		GcpStorageProperties gcpStorageProperties) throws IOException {

	this.gcpProjectIdProvider =
			gcpStorageProperties.getProjectId() != null
					? gcpStorageProperties::getProjectId
					: coreProjectIdProvider;

	this.credentialsProvider =
			gcpStorageProperties.getCredentials().hasKey()
					? new DefaultCredentialsProvider(gcpStorageProperties)
					: credentialsProvider;
}
 

@Bean
public GcpProjectIdProvider projectIdProvider() {
	return () -> "fake project";
}
 

@Bean
static GcpProjectIdProvider mockProjectIdProvider() {
	return mockProjectIdProvider;
}
 

@Bean
public GcpProjectIdProvider projectIdProvider() {
	return () -> "spring-firebase-test-project";
}
 

@Bean
@ConditionalOnMissingBean
@ConditionalOnGcpEnvironment({GcpEnvironment.APP_ENGINE_FLEXIBLE, GcpEnvironment.APP_ENGINE_STANDARD})
public AudienceProvider appEngineBasedAudienceProvider(GcpProjectIdProvider projectIdProvider) {
	return new AppEngineAudienceProvider(projectIdProvider);
}
 

@Bean
public GcpProjectIdProvider projectIdProvider() {
	return () -> "fake project";
}
 

@Bean
public GcpProjectIdProvider gcpProjectIdProvider() {
	return () -> "project123";
}
 

@Bean
public static GcpProjectIdProvider gcpProjectIdProvider() {
	return () -> "default-project";
}
 

private ContextConsumer<AssertableApplicationContext> checkNumberOfBeansOfTypeGcpProjectIdProvider(int count) {
	return context -> assertThat(context
			.getBeansOfType(GcpProjectIdProvider.class).size())
					.isEqualTo(count);
}
 

public LoggingWebMvcConfigurer(TraceIdLoggingWebMvcInterceptor interceptor,
		GcpProjectIdProvider projectIdProvider) {
	super(interceptor, projectIdProvider);
}