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

Interface SessionService

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicAuthJcsmpSessionService

public interface SessionService
extends java.io.Serializable

The SessionService interface provides a set of methods for managing a session with the Solace messaging system. It allows for establishing a connection, creating a message-receiver object, checking if the connection is closed or not, and gracefully closing the session.

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.
boolean	isClosed() Checks whether the connection to the service is currently closed.

Method Detail

connect

void connect()

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

close

void close()

Gracefully closes the connection to the service.

isClosed

boolean isClosed()

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.

createReceiver

MessageReceiver createReceiver()

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