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 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

Field Summary

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

DEFAULT_VPN_NAME

Constructor Summary

Constructors

Constructor and Description
BasicAuthJcsmpSessionService(java.lang.String queueName, java.lang.String host, java.lang.String username, java.lang.String password, java.lang.String vpnName) Creates a new BasicAuthJcsmpSessionService with the given parameters.

Method Summary

Modifier and Type	Method and Description
void	close() Gracefully closes the connection to the service.
void	connect() Establishes a connection to the service.
MessageReceiver	createReceiver() Creates a MessageReceiver object for receiving messages from Solace.
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.

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

initializeWriteSessionProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthJcsmpSessionService

public BasicAuthJcsmpSessionService(java.lang.String queueName,
                                    java.lang.String host,
                                    java.lang.String username,
                                    java.lang.String password,
                                    java.lang.String vpnName)

Creates a new BasicAuthJcsmpSessionService with the given parameters.

Parameters:

queueName - The name of the queue to receive messages from.

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

username - The username to use for authentication.

password - The password to use for authentication.

vpnName - The name of the VPN to connect to.

Method Detail

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

createReceiver

public MessageReceiver createReceiver()

Description copied from class: SessionService

Creates a MessageReceiver object for receiving messages from Solace. Typically, this object is created from the session instance.

Specified by:

createReceiver 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