com.solace.messaging

Class MessagingServiceClientBuilder

java.lang.Object

com.solace.messaging.MessagingServiceClientBuilder

All Implemented Interfaces:

AuthenticationConfiguration, CustomServiceConfiguration, DeclarativeServiceConfiguration, LocalServiceConfiguration, PropertyBasedConfiguration, TransportProtocolConfiguration

@ProviderType
public final class MessagingServiceClientBuilder
extends Object
implements LocalServiceConfiguration, CustomServiceConfiguration, DeclarativeServiceConfiguration, TransportProtocolConfiguration, AuthenticationConfiguration

A class to configure and build MessagingService instances.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
MessagingService	build() Creates a PubSub+ messaging service connector based on the provided configuration.
MessagingService	build(String clientName) Creates a PubSub+ messaging service connector based on the provided configuration to expose the identity of the application using the provided configuration to fulfill the messaging needs.
MessagingServiceClientBuilder	fromConfigurationProvider(ServiceConfigurationProvider configProvider) Creates custom source service-access configurations for the broker
MessagingServiceClientBuilder	fromProperties(Properties properties) Enables property-based configuration.
MessagingServiceClientBuilder	local() Creates a service configuration for connection to default VPN on a local-hosted broker, using non-secure TCP port 55555.
MessagingServiceClientBuilder	local(int port) Creates a service configuration for connection to default VPN on a local-hosted broker, using given non-secure TCP port.
MessagingServiceClientBuilder	local(String vpnName, int port) Creates a service configuration for connection to defined VPN on a local hosted broker, using given non-secure TCP port.
MessagingServiceClientBuilder	local(String protocol, String vpnName) Creates a service configuration for connection to defined VPN on a local-hosted broker, using given non-secure TCP port.
MessagingServiceClientBuilder	localTLS() Creates a service configuration for connection to default VPN on a local-hosted broker, using secure TCP port 55443.
MessagingServiceClientBuilder	localTLS(int port) Creates a service configuration for connection to default VPN on a local-hosted broker, using given secure TCP port.
MessagingServiceClientBuilder	localTLS(String vpnName, int port) Creates a service configuration for connection to defined VPN on a local-hosted broker, using given secure TCP port.
MessagingServiceClientBuilder	localTLS(String protocol, String vpnName) Creates a service configuration for connection to defined VPN on a local-hosted broker, using protocol default port.
MessagingServiceClientBuilder	withAuthenticationStrategy(AuthenticationStrategy authenticationProvider) Enables/overrides the existing authentication strategy using given AuthenticationStrategy.
MessagingServiceClientBuilder	withConnectionRetryStrategy(RetryStrategy strategy) Configures the connection-retry behavior.
MessagingServiceClientBuilder	withMessageCompression(int compressionFactor) Configures/enables the message compression factor.
MessagingServiceClientBuilder	withReconnectionRetryStrategy(RetryStrategy strategy) Configures the reconnection retry behavior.
MessagingServiceClientBuilder	withTransportSecurityStrategy(TransportSecurityStrategy transportLayerSecurityStrategy) Configures transport-layer security if desired, default is to use plain-text for transport.

Methods inherited from class java.lang.Object

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

Method Detail

build

public MessagingService build()
                       throws PubSubPlusClientException

Creates a PubSub+ messaging service connector based on the provided configuration.

Since the application identifier is not specified, a random new value per service instance is generated.

This method can be considered to be thread-safe.

Returns:

a messaging service connector instance

Throws:

PubSubPlusClientException - if the service instance cannot be built due to invalid properties or invalid configuration

Since:

1.0

build

public MessagingService build(String clientName)
                       throws PubSubPlusClientException

Creates a PubSub+ messaging service connector based on the provided configuration to expose the identity of the application using the provided configuration to fulfill the messaging needs.

It is important to remember that when client runs in a clustered environment and multiple instances of the client running in parallel usage of static application ID is required.

The default alias is used to retrieve configuration if more then a single configuration set is available.

Parameters:

clientName - the identity of the application connected to the broker, given value overrides corresponding value when such one set using for example system properties, env. variables etc. When this value is not specified, then a random generated value per service instance is used.

Returns:

a messaging service connector instance

Throws:

PubSubPlusClientException - if the service instance cannot be built due to invalid properties or invalid configuration

Since:

1.0

fromConfigurationProvider

public MessagingServiceClientBuilder fromConfigurationProvider(ServiceConfigurationProvider configProvider)

Description copied from interface: CustomServiceConfiguration

Creates custom source service-access configurations for the broker

Specified by:

fromConfigurationProvider in interface CustomServiceConfiguration

Parameters:

configProvider - customizable configuration provider

Returns:

an instance of itself

fromProperties

public MessagingServiceClientBuilder fromProperties(Properties properties)

Enables property-based configuration.

Specified by:

fromProperties in interface DeclarativeServiceConfiguration

Specified by:

fromProperties in interface PropertyBasedConfiguration

Parameters:

properties - the properties (key of type String and value of type String) for configuration and fine-tuning. Common properties can be found in SolaceProperties and its sub-interfaces. Refer the SolaceProperties.ServiceProperties, SolaceProperties.AuthenticationProperties, SolaceProperties.TransportLayerProperties, SolaceProperties.TransportLayerSecurityProperties and SolaceProperties.ClientProperties for the list of MessagingService properties configurable through this MessagingServiceClientBuilder

Returns:

instance of itself

Throws:

IllegalArgumentException - if invalid properties were specified

Since:

1.0

local

public MessagingServiceClientBuilder local()

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to default VPN on a local-hosted broker, using non-secure TCP port 55555.

Specified by:

local in interface LocalServiceConfiguration

Returns:

an instance of itself

local

public MessagingServiceClientBuilder local(int port)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to default VPN on a local-hosted broker, using given non-secure TCP port.

Specified by:

local in interface LocalServiceConfiguration

Parameters:

port - the port to connect to

Returns:

an instance of itself

local

public MessagingServiceClientBuilder local(String vpnName,
                                           int port)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to defined VPN on a local hosted broker, using given non-secure TCP port.

Specified by:

local in interface LocalServiceConfiguration

Parameters:

vpnName - the name of the Message VPN to attempt to join when connecting to the appliance

port - the port to connect to

Returns:

an instance of itself

local

public MessagingServiceClientBuilder local(String protocol,
                                           String vpnName)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to defined VPN on a local-hosted broker, using given non-secure TCP port.

Specified by:

local in interface LocalServiceConfiguration

Parameters:

protocol - the protocol to connect to, valid values are "tcp" and "ws"

vpnName - the name of the Message VPN to attempt to join when connecting to the appliance

Returns:

an instance of itself

localTLS

public MessagingServiceClientBuilder localTLS()

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to default VPN on a local-hosted broker, using secure TCP port 55443.

Specified by:

localTLS in interface LocalServiceConfiguration

Returns:

an instance of itself

localTLS

public MessagingServiceClientBuilder localTLS(int port)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to default VPN on a local-hosted broker, using given secure TCP port.

Specified by:

localTLS in interface LocalServiceConfiguration

Parameters:

port - the port to connect to

Returns:

an instance of itself

localTLS

public MessagingServiceClientBuilder localTLS(String vpnName,
                                              int port)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to defined VPN on a local-hosted broker, using given secure TCP port.

Specified by:

localTLS in interface LocalServiceConfiguration

Parameters:

vpnName - the name of the Message VPN to attempt to join when connecting to the appliance

port - the port to connect to

Returns:

an instance of itself

localTLS

public MessagingServiceClientBuilder localTLS(String protocol,
                                              String vpnName)

Description copied from interface: LocalServiceConfiguration

Creates a service configuration for connection to defined VPN on a local-hosted broker, using protocol default port.

Specified by:

localTLS in interface LocalServiceConfiguration

Parameters:

protocol - the protocol to connect to, valid values are "tcp" and "ws"

vpnName - the name of the Message VPN to attempt to join when connecting to the appliance

Returns:

an instance of itself

withAuthenticationStrategy

public MessagingServiceClientBuilder withAuthenticationStrategy(AuthenticationStrategy authenticationProvider)

Description copied from interface: AuthenticationConfiguration

Enables/overrides the existing authentication strategy using given AuthenticationStrategy.

Specified by:

withAuthenticationStrategy in interface AuthenticationConfiguration

Parameters:

authenticationProvider - the provider to be used for connections to the messaging broker

Returns:

an instance of itself

withConnectionRetryStrategy

public MessagingServiceClientBuilder withConnectionRetryStrategy(RetryStrategy strategy)

Description copied from interface: TransportProtocolConfiguration

Configures the connection-retry behavior.

Specified by:

withConnectionRetryStrategy in interface TransportProtocolConfiguration

Parameters:

strategy - configuration strategy

Returns:

an instance of itself

withMessageCompression

public MessagingServiceClientBuilder withMessageCompression(int compressionFactor)

Description copied from interface: TransportProtocolConfiguration

Configures/enables the message compression factor.

In order to use compression, target remote message broker port may need to be changed.

By default port 55003 used for compressed SMF without TLS

By default port 55443 used for compressed SMF over TLS

Specified by:

withMessageCompression in interface TransportProtocolConfiguration

Parameters:

compressionFactor - A compression factor in a valid range of 1-9 controls the ZLIB compression level. The value 1 gives best speed, 9 gives best compression. Note: If using compression on a session, the configured KeepAlive interval should be longer than the maximum time required to compress the largest message likely ever to be published to prevent service disconnections.

Returns:

an instance of itself

withReconnectionRetryStrategy

public MessagingServiceClientBuilder withReconnectionRetryStrategy(RetryStrategy strategy)

Description copied from interface: TransportProtocolConfiguration

Configures the reconnection retry behavior.

Specified by:

withReconnectionRetryStrategy in interface TransportProtocolConfiguration

Parameters:

strategy - the configuration strategy

Returns:

an instance of itself

withTransportSecurityStrategy

public MessagingServiceClientBuilder withTransportSecurityStrategy(TransportSecurityStrategy transportLayerSecurityStrategy)

Description copied from interface: TransportProtocolConfiguration

Configures transport-layer security if desired, default is to use plain-text for transport.

Specified by:

withTransportSecurityStrategy in interface TransportProtocolConfiguration

Parameters:

transportLayerSecurityStrategy - the transport layer strategy

Returns:

an instance of itself