org.apache.beam.sdk.io.solace.broker

Class GCPSecretSessionServiceFactory

java.lang.Object

org.apache.beam.sdk.io.solace.broker.SessionServiceFactory

org.apache.beam.sdk.io.solace.broker.GCPSecretSessionServiceFactory

All Implemented Interfaces:

java.io.Serializable

public abstract class GCPSecretSessionServiceFactory
extends SessionServiceFactory

This class implements a SessionServiceFactory that retrieve the basic authentication credentials from a Google Cloud Secret Manager secret.

It can be used to avoid having to pass the password as an option of your pipeline. For this provider to work, the worker where the job runs needs to have the necessary credentials to access the secret. In Dataflow, this implies adding the necessary permissions to the worker service account. For other runners, set the credentials in the pipeline options using GcpOptions.

It also shows how to implement a SessionServiceFactory that depends on using external resources to retrieve the Solace session properties. In this case, using the Google Cloud Secrete Manager client.

Example of how to create the provider object:

 GCPSecretSessionServiceFactory factory =
     GCPSecretSessionServiceFactory.builder()
         .username("user")
         .host("host:port")
         .passwordSecretName("secret-name")
         .build();

 SessionService serviceUsingGCPSecret = factory.create();
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GCPSecretSessionServiceFactory.Builder

Constructor Summary

Constructors

Constructor and Description
GCPSecretSessionServiceFactory()

Method Summary

Modifier and Type	Method and Description
static GCPSecretSessionServiceFactory.Builder	builder()
SessionService	create() This is the core method that subclasses must implement.
abstract java.lang.String	host()
abstract java.lang.String	passwordSecretName()
abstract java.lang.String	passwordSecretVersion()
abstract @Nullable java.lang.String	secretManagerProjectId()
abstract java.lang.String	username()
abstract java.lang.String	vpnName()

Methods inherited from class org.apache.beam.sdk.io.solace.broker.SessionServiceFactory

setQueue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GCPSecretSessionServiceFactory

public GCPSecretSessionServiceFactory()

Method Detail

username

public abstract java.lang.String username()

host

public abstract java.lang.String host()

passwordSecretName

public abstract java.lang.String passwordSecretName()

vpnName

public abstract java.lang.String vpnName()

secretManagerProjectId

public abstract @Nullable java.lang.String secretManagerProjectId()

passwordSecretVersion

public abstract java.lang.String passwordSecretVersion()

builder

public static GCPSecretSessionServiceFactory.Builder builder()

create

public SessionService create()

Description copied from class: SessionServiceFactory

This is the core method that subclasses must implement. It defines how to construct and return a SessionService object.

Specified by:

create in class SessionServiceFactory