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

Class BasicAuthSempClient

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, SempClient

@Internal
public class BasicAuthSempClient
extends java.lang.Object
implements SempClient

A class that manages REST calls to the Solace Element Management Protocol (SEMP) using basic authentication.

This class provides methods to check necessary information, such as if the queue is non-exclusive, remaining backlog bytes of a queue. It can also create and execute calls to create queue for a topic.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicAuthSempClient(java.lang.String host, java.lang.String username, java.lang.String password, java.lang.String vpnName, org.apache.beam.sdk.util.SerializableSupplier<com.google.api.client.http.HttpRequestFactory> httpRequestFactorySupplier)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicAuthSempClient

public BasicAuthSempClient(java.lang.String host,
                           java.lang.String username,
                           java.lang.String password,
                           java.lang.String vpnName,
                           org.apache.beam.sdk.util.SerializableSupplier<com.google.api.client.http.HttpRequestFactory> httpRequestFactorySupplier)

Method Detail

isQueueNonExclusive

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

Description copied from interface: SempClient

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

Specified by:

isQueueNonExclusive in interface SempClient

Throws:

java.io.IOException

createQueueForTopic

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

Description copied from interface: SempClient

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.

Specified by:

createQueueForTopic in interface SempClient

Throws:

java.io.IOException

getBacklogBytes

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

Description copied from interface: SempClient

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.

Specified by:

getBacklogBytes in interface SempClient

Throws:

java.io.IOException