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

Class BasicAuthJcsmpSessionService

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

public abstract class BasicAuthJcsmpSessionService
extends SessionService

A class that manages a connection to a Solace broker using basic authentication.

This class provides a way to connect to a Solace broker and receive messages from a queue. The connection is established using basic authentication.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicAuthJcsmpSessionService.Builder

Field Summary

Fields inherited from class org.apache.beam.sdk.io.solace.broker.SessionService

DEFAULT_VPN_NAME

Constructor Summary

Constructors

Constructor and Description
BasicAuthJcsmpSessionService()

Method Summary

Modifier and Type	Method and Description
static BasicAuthJcsmpSessionService.Builder	builder()
void	close() Gracefully closes the connection to the service.
void	connect() Establishes a connection to the service.
MessageProducer	getInitializedProducer(SolaceIO.SubmissionMode submissionMode) Returns a MessageProducer object for publishing messages to Solace.
java.util.Queue<Solace.PublishResult>	getPublishedResultsQueue() Returns the Queue instance associated with this session, with the asynchronously received callbacks from Solace for message publications.
MessageReceiver	getReceiver() Returns a MessageReceiver object for receiving messages from Solace.
abstract java.lang.String	host() The host name or IP address of the Solace broker.
JCSMPProperties	initializeSessionProperties(JCSMPProperties baseProps) Override this method and provide your specific properties, including all those related to authentication, and possibly others too.
boolean	isClosed() Checks whether the connection to the service is currently closed.
abstract java.lang.String	password() The password to use for authentication.
abstract java.lang.String	queueName() The name of the queue to receive messages from.
abstract java.lang.String	username() The username to use for authentication.
abstract java.lang.String	vpnName() The name of the VPN to connect to.

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

equals, hashCode, initializeWriteSessionProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthJcsmpSessionService

public BasicAuthJcsmpSessionService()

Method Detail

queueName

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

The name of the queue to receive messages from.

host

public abstract java.lang.String host()

The host name or IP address of the Solace broker. Format: Host[:Port]

username

public abstract java.lang.String username()

The username to use for authentication.

password

public abstract java.lang.String password()

The password to use for authentication.

vpnName

public abstract java.lang.String vpnName()

The name of the VPN to connect to.

builder

public static BasicAuthJcsmpSessionService.Builder builder()

connect

public void connect()

Description copied from class: SessionService

Establishes a connection to the service. This could involve providing connection details like host, port, VPN name, username, and password.

Specified by:

connect in class SessionService

close

public void close()

Description copied from class: SessionService

Gracefully closes the connection to the service.

Specified by:

close in class SessionService

getReceiver

public MessageReceiver getReceiver()

Description copied from class: SessionService

Returns a MessageReceiver object for receiving messages from Solace. If it is the first time this method is used, the receiver is created from the session instance, otherwise it returns the receiver created initially.

Specified by:

getReceiver in class SessionService

getInitializedProducer

public MessageProducer getInitializedProducer(SolaceIO.SubmissionMode submissionMode)

Description copied from class: SessionService

Returns a MessageProducer object for publishing messages to Solace. If it is the first time this method is used, the producer is created from the session instance, otherwise it returns the producer created initially.

Specified by:

getInitializedProducer in class SessionService

getPublishedResultsQueue

public java.util.Queue<Solace.PublishResult> getPublishedResultsQueue()

Description copied from class: SessionService

Returns the Queue instance associated with this session, with the asynchronously received callbacks from Solace for message publications. The queue implementation has to be thread-safe for production use-cases.

Specified by:

getPublishedResultsQueue in class SessionService

isClosed

public boolean isClosed()

Description copied from class: SessionService

Checks whether the connection to the service is currently closed. This method is called when an `UnboundedSolaceReader` is starting to read messages - a session will be created if this returns true.

Specified by:

isClosed in class SessionService

initializeSessionProperties

public JCSMPProperties initializeSessionProperties(JCSMPProperties baseProps)

Description copied from class: SessionService

Override this method and provide your specific properties, including all those related to authentication, and possibly others too. The baseProperties parameter sets the Solace VPN to "default" if none is specified.

You should add your properties to the parameter baseProperties, and return the result.

The method will be used whenever the session needs to be created or refreshed. If you are setting credentials with expiration, just make sure that the latest available credentials (e.g. renewed token) are set when the method is called.

For a list of all the properties that can be set, please check the following link:

• https://docs.solace.com/API-Developer-Online-Ref-Documentation/java/com/solacesystems/jcsmp/JCSMPProperties.html

Specified by:

initializeSessionProperties in class SessionService