com.solace.messaging.publisher

Interface DirectMessagePublisher

All Superinterfaces:

AsyncLifecycleControl, LifecycleControl, ManageablePublisher, MessagePublisher, PublisherHealthCheck

@ProviderType
public interface DirectMessagePublisher
extends MessagePublisher

An interface to create and interact with direct (non-persistent) message publishers.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DirectMessagePublisher.FailedPublishEvent A class that encapsulates the details of a failed attempt to publish a message.
static interface	DirectMessagePublisher.PublishFailureListener An interface that provides an abstraction for listeners of failed message publishing attempts.

Nested classes/interfaces inherited from interface com.solace.messaging.util.LifecycleControl

LifecycleControl.TerminationEvent, LifecycleControl.TerminationNotificationListener

Nested classes/interfaces inherited from interface com.solace.messaging.publisher.PublisherHealthCheck

PublisherHealthCheck.PublisherReadinessListener

Nested classes/interfaces inherited from interface com.solace.messaging.util.ManageablePublisher

ManageablePublisher.DirectPublisherInfo, ManageablePublisher.PersistentPublisherInfo, ManageablePublisher.PublisherInfo

Method Summary

Modifier and Type	Method and Description
void	publish(byte[] message, Topic destination) Sends a byte-array message to the given destination using defaults This method is non-blocking.
void	publish(OutboundMessage message, Topic destination) Sends an OutboundMessage to the given destination, non blocking.
void	publish(OutboundMessage message, Topic destination, Properties additionalMessageProperties) Sends OutboundMessage to the given destination, extendedMessageProperties can be included into the message, non blocking.
void	publish(String message, Topic destination) Sends a UTF-8 encoded-text message (payload) to the specified destination using defaults This method is non-blocking.
ManageablePublisher.DirectPublisherInfo	publisherInfo() Provides access to the publisher information.
void	setPublishFailureListener(DirectMessagePublisher.PublishFailureListener listener) Sets the callback for the instance of the publisher.
DirectMessagePublisher	start() Enables service regular duties.
<DirectMessagePublisher> CompletableFuture<DirectMessagePublisher>	startAsync() Asynchronously starts service for consuming/publishing operations.
<DirectMessagePublisher> void	startAsync(CompletionListener<DirectMessagePublisher> startListener) Asynchronously starts service for consuming/publishing operations using a callback for completion notification.

Methods inherited from interface com.solace.messaging.util.LifecycleControl

isRunning, isTerminated, isTerminating, setTerminationNotificationListener, terminate

Methods inherited from interface com.solace.messaging.util.AsyncLifecycleControl

terminateAsync, terminateAsync

Methods inherited from interface com.solace.messaging.publisher.PublisherHealthCheck

isReady, notifyWhenReady, setPublisherReadinessListener

Method Detail

publish

void publish(byte[] message,
             Topic destination)
      throws PubSubPlusClientException,
             IllegalStateException,
             IllegalArgumentException,
             PubSubPlusClientException.PublisherOverflowException

Sends a byte-array message to the given destination using defaults This method is non-blocking.

Parameters:

message - the byte payload

destination - the message destination (topic)

Throws:

PubSubPlusClientException - if the message can't be sent

PubSubPlusClientException.PublisherOverflowException - if the publisher sends a message faster then the I/O capabilities allow to send or the internal message buffering capabilities are exceeded

IllegalStateException - if the message publisher has not started or has been terminated

IllegalArgumentException - if the message or the destination was null

Since:

1.0

publish

void publish(OutboundMessage message,
             Topic destination)
      throws PubSubPlusClientException,
             IllegalStateException,
             IllegalArgumentException,
             PubSubPlusClientException.PublisherOverflowException

Sends an OutboundMessage to the given destination, non blocking.

The OutboundMessageBuilder class can be used to create a new message instance. For example:

OutboundMessageBuilder messageBuilder = messagePublisher.createMessageBuilder();

Parameters:

message - the entire message, payload, and additional message properties that can be defined in the message; a null value is not allowed

destination - destination the destination (topic)

Throws:

PubSubPlusClientException - if the message can't be sent

PubSubPlusClientException.PublisherOverflowException - if the publisher sends a message faster then the I/O capabilities allow to send or the internal message buffering capabilities are exceeded

IllegalStateException - if the message publisher was not started or has been terminated

IllegalArgumentException - if the message or the destination was null

Since:

1.0

publish

void publish(OutboundMessage message,
             Topic destination,
             Properties additionalMessageProperties)
      throws PubSubPlusClientException,
             IllegalStateException,
             IllegalArgumentException,
             PubSubPlusClientException.PublisherOverflowException

Sends OutboundMessage to the given destination, extendedMessageProperties can be included into the message, non blocking.

OutboundMessageBuilder can be used to create a new message instance.

Parameters:

message - the entire message, payload, and additional message properties can be defined in the message; a null value is not permitted

destination - destination the destination for the message specified as a topic

additionalMessageProperties - the additional properties (Key of type String and Value of type String) to customize a particular message where each key can be customer-provided, or it can be a key from a SolaceProperties.MessageProperties instance

Throws:

PubSubPlusClientException - if the message can't be sent

PubSubPlusClientException.PublisherOverflowException - if the publisher sends a message faster then the I/O capabilities allow to send or the internal message buffering capabilities are exceeded

IllegalStateException - if the message publisher is not started or has been terminated

IllegalArgumentException - if the message or the destination is null

Since:

1.0

publish

void publish(String message,
             Topic destination)
      throws PubSubPlusClientException,
             IllegalStateException,
             IllegalArgumentException,
             PubSubPlusClientException.PublisherOverflowException

Sends a UTF-8 encoded-text message (payload) to the specified destination using defaults This method is non-blocking.

Parameters:

message - the UTF-8 encoded-text string representing the payload

destination - destination the destination (topic)

Throws:

PubSubPlusClientException - if the message can't be sent

PubSubPlusClientException.PublisherOverflowException - if the publisher sends a message faster then the I/O capabilities allow to send or the internal message buffering capabilities are exceeded

IllegalStateException - if the message publisher is not started or has been terminated

IllegalArgumentException - if the message or the destination was null

Since:

1.0

publisherInfo

ManageablePublisher.DirectPublisherInfo publisherInfo()

Description copied from interface: ManageablePublisher

Provides access to the publisher information.

Specified by:

publisherInfo in interface ManageablePublisher

Returns:

the publisher information as a PublisherInfo object

setPublishFailureListener

void setPublishFailureListener(DirectMessagePublisher.PublishFailureListener listener)

Sets the callback for the instance of the publisher. Use this method to register a callback that provides a notification about failed message publishing attempts.

Parameters:

listener - the callback that listens for message publishing failures

Since:

1.0

start

DirectMessagePublisher start()

Description copied from interface: LifecycleControl

Enables service regular duties. Before this method is called, the service is considered off-duty. To operate normally, this method needs to be called on a receiver or publisher instance. This method is idempotent.

Specified by:

start in interface LifecycleControl

Returns:

an instance of class on which the method was called to support chaining

startAsync

<DirectMessagePublisher> CompletableFuture<DirectMessagePublisher> startAsync()
                                                                       throws PubSubPlusClientException

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

This method is an idempotent operation when no another connect/disconnect operation is ongoing.

Specified by:

startAsync in interface AsyncLifecycleControl

Returns:

a future state of the start request that can complete successfully or fail.

Throws:

PubSubPlusClientException - if the messaging service will not start in the future

startAsync

<DirectMessagePublisher> void startAsync(CompletionListener<DirectMessagePublisher> startListener)
                                  throws PubSubPlusClientException,
                                         IllegalStateException

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations using a callback for completion notification. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

Specified by:

startAsync in interface AsyncLifecycleControl

Type Parameters:

DirectMessagePublisher - the type of response returned on a successful start operation

Parameters:

startListener - the callback for future notifications about the completion of the start process

Throws:

PubSubPlusClientException - if the messaging service will not start in the future

IllegalStateException - if the method has been invoked at an illegal or inappropriate time