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

Class SessionServiceFactory

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BasicAuthJcsmpSessionServiceFactory, GCPSecretSessionServiceFactory

public abstract class SessionServiceFactory
extends Object
implements Serializable

This abstract class serves as a blueprint for creating `SessionServiceFactory` objects. It introduces a queue property and mandates the implementation of a create() method in concrete subclasses.

For basic authentication, use BasicAuthJcsmpSessionServiceFactory.

For other situations, you need to extend this class. Classes extending from this abstract class must implement the `equals` method so two instances can be compared by value, and not by reference. We recommend using AutoValue for that.

 {@literal @}AutoValue
 public abstract class MyFactory implements SessionServiceClientFactory {

   abstract String value1();

   abstract String value2();

   public static MyFactory create(String value1, String value2) {
     return new AutoValue_MyFactory.Builder(value1, value2);
   }

   ...

   {@literal @}Override
   public SessionService create() {
     ...
   }
 }
 

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SessionServiceFactory()

Method Summary

Modifier and Type	Method	Description
abstract SessionService	create()	This is the core method that subclasses must implement.
abstract boolean	equals(@Nullable Object other)	You need to override this method to be able to compare these objects by value.
final @Nullable Queue	getQueue()	Getter for the queue.
@Nullable SolaceIO.SubmissionMode	getSubmissionMode()
abstract int	hashCode()	You need to override this method to be able to compare these objects by value.
final void	setQueue(Queue queue)	This method is called in the SolaceIO.Read.expand(org.apache.beam.sdk.values.PBegin) method to set the Queue reference based on SolaceIO.Read.from(Solace.Queue) or SolaceIO.Read.from(Solace.Topic).
void	setSubmissionMode(SolaceIO.SubmissionMode submissionMode)	Called by the write connector to set the submission mode used to create the message producers.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionServiceFactory

public SessionServiceFactory()

Method Details

create

public abstract SessionService create()

This is the core method that subclasses must implement. It defines how to construct and return a SessionService object.

setQueue

public final void setQueue(Queue queue)

This method is called in the SolaceIO.Read.expand(org.apache.beam.sdk.values.PBegin) method to set the Queue reference based on SolaceIO.Read.from(Solace.Queue) or SolaceIO.Read.from(Solace.Topic). The queue can be retrieved in the classes that inherit SessionServiceFactory with the getter method getQueue()

getQueue

public final @Nullable Queue getQueue()

Getter for the queue. This is nullable, because at the construction time this reference is null. Once the pipeline is compiled and the SolaceIO.Read.expand(org.apache.beam.sdk.values.PBegin) method is called, this reference is valid.

Returns:

a reference to the queue which is set with the SolaceIO.Read.from(Solace.Queue) or SolaceIO.Read.from(Solace.Topic)

equals

public abstract boolean equals(@Nullable Object other)

You need to override this method to be able to compare these objects by value. We recommend using AutoValue for that.

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

You need to override this method to be able to compare these objects by value. We recommend using AutoValue for that.

Overrides:

hashCode in class Object

setSubmissionMode

public void setSubmissionMode(SolaceIO.SubmissionMode submissionMode)

Called by the write connector to set the submission mode used to create the message producers.

getSubmissionMode

public @Nullable SolaceIO.SubmissionMode getSubmissionMode()