com.solace.messaging

Interface MessagingService

All Superinterfaces:

AsyncConnectable, Connectable, ErrorMonitoring, Manageable, UpdatableConfiguration

@ProviderType
public interface MessagingService
extends Connectable, AsyncConnectable, Manageable, ErrorMonitoring, UpdatableConfiguration

An interface that represents a messaging service connector and represents an entry point for entire PubSub+ messaging API.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessagingService.ReconnectionAttemptListener A callback listener for TCP level attempted reconnection.
static interface	MessagingService.ReconnectionListener A callback listener for TCP-level successful reconnection notifications.
static interface	MessagingService.RequestReplyMessagingService An interface for request-reply behavior.
static interface	MessagingService.ServiceEvent An event interface for a messaging service for which applications can listen.
static interface	MessagingService.ServiceInterruptionListener A callback listener for notifications about non-recoverable service interruptions.

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

Manageable.ApiInfo, Manageable.ApiMetrics

Method Summary

Modifier and Type	Method and Description
static MessagingServiceClientBuilder	builder(ConfigurationProfile activeProfile) The entry point to create a service builder.
MessagingService	connect() Connects synchronously with a PubSub+ event broker.
<MessagingService> CompletableFuture<MessagingService>	connectAsync() Connects asynchronously with a PubSub+ event broker.
<MessagingService> void	connectAsync(CompletionListener<MessagingService> connectionListener) Connects asynchronously with a PubSub+ event broker with a callback.
DirectMessagePublisherBuilder	createDirectMessagePublisherBuilder() Creates a new instance of DirectMessagePublisherBuilder, that is used to configure direct message publisher instances.
DirectMessageReceiverBuilder	createDirectMessageReceiverBuilder() Creates a new instance of DirectMessageReceiverBuilder, that is used to configure direct message receiver instances.
MessageQueueBrowserBuilder	createMessageQueueBrowserBuilder() Creates a new instance of MessageQueueBrowserBuilder, that is used to configure persistent message queue browser instances.
PersistentMessagePublisherBuilder	createPersistentMessagePublisherBuilder() Creates a new instance of PersistentMessagePublisherBuilder, that is used to configure persistent message publisher instances.
PersistentMessageReceiverBuilder	createPersistentMessageReceiverBuilder() Creates a new instance of PersistentMessageReceiverBuilder, that is used to configure persistent message receiver instances.
String	getApplicationId() Gets the application identifier.
String	getClientName() Gets the client name identifier.
OutboundMessageBuilder	messageBuilder() Creates an instance of OutboundMessageBuilder that inherits configuration profile defaults from this instance.
MessagingService.RequestReplyMessagingService	requestReply() Creates MessagingService.RequestReplyMessagingService that inherits entire configuration from this * instance.
void	updateProperty(String property, Object value) Sets a modifiable service property once the service has been created.

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

addReconnectionAttemptListener, addReconnectionListener, disconnect, isConnected, removeReconnectionAttemptListener, removeReconnectionListener

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

disconnectAsync, disconnectAsync

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

info, metrics

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

addServiceInterruptionListener, removeServiceInterruptionListener

Method Detail

builder

static MessagingServiceClientBuilder builder(ConfigurationProfile activeProfile)

The entry point to create a service builder.

This method is thread-safe.

Parameters:

activeProfile - the active-versioned configuration profile to be applied

Returns:

a new instance of a ServiceBuilder

Since:

1.0

connect

MessagingService connect()
                  throws PubSubPlusClientException

Description copied from interface: Connectable

Connects synchronously with a PubSub+ event broker. The service is considered off-duty before this method is called.

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

Specified by:

connect in interface Connectable

Returns:

an instance for the synchronous connection

Throws:

PubSubPlusClientException - if the messaging service can't be put in service

connectAsync

<MessagingService> CompletableFuture<MessagingService> connectAsync()
                                                             throws PubSubPlusClientException

Description copied from interface: AsyncConnectable

Connects asynchronously with a PubSub+ event broker.

Specified by:

connectAsync in interface AsyncConnectable

Returns:

a future state of a connection request that can succeed or fail

Throws:

PubSubPlusClientException - if the messaging service cannot be connected

connectAsync

<MessagingService> void connectAsync(CompletionListener<MessagingService> connectionListener)
                              throws PubSubPlusClientException

Description copied from interface: AsyncConnectable

Connects asynchronously with a PubSub+ event broker with a callback.

Specified by:

connectAsync in interface AsyncConnectable

Parameters:

connectionListener - the callback for future notifications about completion state of the connection process

Throws:

PubSubPlusClientException - if the messaging service cannot be connected

createDirectMessagePublisherBuilder

DirectMessagePublisherBuilder createDirectMessagePublisherBuilder()

Creates a new instance of DirectMessagePublisherBuilder, that is used to configure direct message publisher instances.

Returns:

a new instance of DirectMessagePublisherBuilder

Since:

1.0

createDirectMessageReceiverBuilder

DirectMessageReceiverBuilder createDirectMessageReceiverBuilder()

Creates a new instance of DirectMessageReceiverBuilder, that is used to configure direct message receiver instances.

Returns:

a new instance of DirectMessageReceiverBuilder

Since:

1.0

createMessageQueueBrowserBuilder

MessageQueueBrowserBuilder createMessageQueueBrowserBuilder()

Creates a new instance of MessageQueueBrowserBuilder, that is used to configure persistent message queue browser instances.

Returns:

a new instance of MessageQueueBrowserBuilder

Since:

1.2.0

createPersistentMessagePublisherBuilder

PersistentMessagePublisherBuilder createPersistentMessagePublisherBuilder()

Creates a new instance of PersistentMessagePublisherBuilder, that is used to configure persistent message publisher instances.

Returns:

a new instance of PersistentMessagePublisherBuilder

Since:

1.0

createPersistentMessageReceiverBuilder

PersistentMessageReceiverBuilder createPersistentMessageReceiverBuilder()

Creates a new instance of PersistentMessageReceiverBuilder, that is used to configure persistent message receiver instances.

Returns:

a new instance of PersistentMessageReceiverBuilder

Since:

1.0

getApplicationId

String getApplicationId()

Gets the application identifier.

Returns:

the configured application id

Since:

1.0

getClientName

String getClientName()

Gets the client name identifier.

Returns:

the configured client name

Since:

1.2.0

messageBuilder

OutboundMessageBuilder messageBuilder()

Creates an instance of OutboundMessageBuilder that inherits configuration profile defaults from this instance.

Each instance can be used concurrently to produce similarly configured messages using variety of build methods.

Returns:

a new instance of OutboundMessageBuilder

Since:

1.0

requestReply

MessagingService.RequestReplyMessagingService requestReply()

Creates MessagingService.RequestReplyMessagingService that inherits entire configuration from this * instance.

Returns:

new instance of MessagingService.RequestReplyMessagingService

Since:

1.1

updateProperty

void updateProperty(String property,
                    Object value)
             throws PubSubPlusClientException

Sets a modifiable service property once the service has been created.

Modifiable properties include:

• SolaceProperties.AuthenticationProperties.SCHEME_OAUTH2_ACCESS_TOKEN to update expiring access token
• SolaceProperties.AuthenticationProperties.SCHEME_OAUTH2_OIDC_ID_TOKEN to update expiring id token

Modification of a service property may or may not occur instantly or may occur during the next session reconnection. Modification of a service property during ongoing session reconnection may apply to the next reconnection attempt.

Specified by:

updateProperty in interface UpdatableConfiguration

Parameters:

property - The name of the property to modify.

value - The new value of the property. null values should be avoided.

Throws:

IllegalStateException - If the specified property cannot be modified in the current service state

IllegalArgumentException - If the specified property value is invalid or the property is not modifiable property

PubSubPlusClientException - If other transport or communication related errors occur

Since:

1.1