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

Interface SempClient

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicAuthSempClient

public interface SempClient
extends java.io.Serializable

This interface defines methods for interacting with a Solace message broker using the Solace Element Management Protocol (SEMP). SEMP provides a way to manage and monitor various aspects of the broker, including queues and topics.

Method Summary

Modifier and Type	Method and Description
Queue	createQueueForTopic(java.lang.String queueName, java.lang.String topicName) This is only called when a user requests to read data from a topic.
long	getBacklogBytes(java.lang.String queueName) Retrieves the size of the backlog (in bytes) for the specified queue.
boolean	isQueueNonExclusive(java.lang.String queueName) Determines if the specified queue is non-exclusive.

Method Detail

isQueueNonExclusive

boolean isQueueNonExclusive(java.lang.String queueName)
                     throws java.io.IOException

Determines if the specified queue is non-exclusive. In Solace, non-exclusive queues allow multiple consumers to receive messages from the queue.

Throws:

java.io.IOException

createQueueForTopic

Queue createQueueForTopic(java.lang.String queueName,
                          java.lang.String topicName)
                   throws java.io.IOException

This is only called when a user requests to read data from a topic. This method creates a new queue on the Solace broker and associates it with the specified topic. This ensures that messages published to the topic are delivered to the queue, allowing consumers to receive them.

Throws:

java.io.IOException

getBacklogBytes

long getBacklogBytes(java.lang.String queueName)
              throws java.io.IOException

Retrieves the size of the backlog (in bytes) for the specified queue. The backlog represents the amount of data in messages that are waiting to be delivered to consumers.

Throws:

java.io.IOException