Module io.helidon.messaging.connectors.jms

Package io.helidon.messaging.connectors.jms

Class JmsConnector

java.lang.Object

io.helidon.messaging.connectors.jms.JmsConnector

All Implemented Interfaces:

Stoppable, ConnectorFactory, IncomingConnectorFactory, OutgoingConnectorFactory

Direct Known Subclasses:

AqConnectorImpl

@ApplicationScoped
public class JmsConnector
extends Object
implements IncomingConnectorFactory, OutgoingConnectorFactory, Stoppable

MicroProfile Reactive Messaging JMS connector.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsConnector.JmsConnectorBuilder	Builder for JmsConnector.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CLIENT_ID_ATTRIBUTE	Client identifier for JMS connection.
static final String	CONNECTOR_NAME	Microprofile messaging JMS connector name.
protected static final String	DURABLE_ATTRIBUTE	True for creating durable consumer (only for topic).
protected static final String	NAMED_FACTORY_ATTRIBUTE	Select in case factory is injected as a named bean or configured with name.
protected static final String	NON_LOCAL_ATTRIBUTE	If true then any messages published to the topic using this session's connection, or any other connection with the same client identifier, will not be added to the durable subscription.
protected static final String	PASSWORD_ATTRIBUTE	Password used with ConnectionFactory.
protected static final String	SUBSCRIBER_NAME_ATTRIBUTE	Subscriber name for durable consumer used to identify subscription.
protected static final String	USERNAME_ATTRIBUTE	User name used with ConnectionFactory.

Fields inherited from interface org.eclipse.microprofile.reactive.messaging.spi.ConnectorFactory

CHANNEL_NAME_ATTRIBUTE, CONNECTOR_ATTRIBUTE, CONNECTOR_PREFIX, INCOMING_PREFIX, OUTGOING_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JmsConnector(Config config, Instance<jakarta.jms.ConnectionFactory> connectionFactories)	Create new JmsConnector.
protected	JmsConnector(Map<String,jakarta.jms.ConnectionFactory> connectionFactoryMap, ScheduledExecutorService scheduler, ExecutorService executor)	Create new JmsConnector.

Method Summary

Modifier and Type	Method	Description
static JmsConnector.JmsConnectorBuilder	builder()	Provides a JmsConnector.JmsConnectorBuilder for creating a JmsConnector instance.
static JmsConfigBuilder	configBuilder()	Custom config builder for JMS connector.
static JmsConnector	create()	Creates a new instance of JmsConnector with empty configuration.
protected JmsMessage<?>	createMessage(jakarta.jms.Message message, Executor executor, SessionMetadata sessionMetadata)	Create reactive messaging message from JMS message.
protected Optional<? extends jakarta.jms.ConnectionFactory>	getFactory(ConnectionContext ctx)	Find correct ConnectionFactory for channel.
PublisherBuilder<? extends Message<?>>	getPublisherBuilder(Config mpConfig)
SubscriberBuilder<? extends Message<?>,Void>	getSubscriberBuilder(Config mpConfig)
protected BiConsumer<Message<?>,jakarta.jms.JMSException>	sendingErrorHandler(Config config)	Customizable handler for errors during sending.
void	stop()	Invoked during Messaging.stop().

Methods inherited from class java.lang.Object

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

Field Details

CONNECTOR_NAME

public static final String CONNECTOR_NAME

Microprofile messaging JMS connector name.

See Also:

• Constant Field Values

NAMED_FACTORY_ATTRIBUTE

protected static final String NAMED_FACTORY_ATTRIBUTE

Select in case factory is injected as a named bean or configured with name.

See Also:

• Constant Field Values

USERNAME_ATTRIBUTE

protected static final String USERNAME_ATTRIBUTE

User name used with ConnectionFactory.

See Also:

• Constant Field Values

PASSWORD_ATTRIBUTE

protected static final String PASSWORD_ATTRIBUTE

Password used with ConnectionFactory.

See Also:

• Constant Field Values

CLIENT_ID_ATTRIBUTE

protected static final String CLIENT_ID_ATTRIBUTE

Client identifier for JMS connection.

See Also:

• Constant Field Values

DURABLE_ATTRIBUTE

protected static final String DURABLE_ATTRIBUTE

True for creating durable consumer (only for topic).

See Also:

• Constant Field Values

SUBSCRIBER_NAME_ATTRIBUTE

protected static final String SUBSCRIBER_NAME_ATTRIBUTE

Subscriber name for durable consumer used to identify subscription.

See Also:

• Constant Field Values

NON_LOCAL_ATTRIBUTE

protected static final String NON_LOCAL_ATTRIBUTE

If true then any messages published to the topic using this session's connection, or any other connection with the same client identifier, will not be added to the durable subscription.

See Also:

• Constant Field Values

Constructor Details

JmsConnector

@Inject
protected JmsConnector(Config config,
 Instance<jakarta.jms.ConnectionFactory> connectionFactories)

Create new JmsConnector.

Parameters:

connectionFactories - connection factory beans

config - root config for thread context

JmsConnector

protected JmsConnector(Map<String,jakarta.jms.ConnectionFactory> connectionFactoryMap,
 ScheduledExecutorService scheduler,
 ExecutorService executor)

Create new JmsConnector.

Parameters:

connectionFactoryMap - custom connection factories

scheduler - custom scheduler for polling

executor - custom executor for async tasks

Method Details

builder

public static JmsConnector.JmsConnectorBuilder builder()

Provides a JmsConnector.JmsConnectorBuilder for creating a JmsConnector instance.

Returns:

new Builder instance

create

public static JmsConnector create()

Creates a new instance of JmsConnector with empty configuration.

Returns:

the new instance

configBuilder

public static JmsConfigBuilder configBuilder()

Custom config builder for JMS connector.

Returns:

new JMS specific config builder

stop

public void stop()

Description copied from interface: Stoppable

Invoked during Messaging.stop().

Specified by:

stop in interface Stoppable

createMessage

protected JmsMessage<?> createMessage(jakarta.jms.Message message,
 Executor executor,
 SessionMetadata sessionMetadata)

Create reactive messaging message from JMS message.

Parameters:

message - JMS message

executor - executor used for async execution of ack

sessionMetadata - JMS session metadata

Returns:

reactive messaging message extended with custom JMS features

getFactory

protected Optional<? extends jakarta.jms.ConnectionFactory> getFactory(ConnectionContext ctx)

Find correct ConnectionFactory for channel.

Parameters:

ctx - Channel's context

Returns:

appropriate connection factory

getPublisherBuilder

public PublisherBuilder<? extends Message<?>> getPublisherBuilder(Config mpConfig)

Specified by:

getPublisherBuilder in interface IncomingConnectorFactory

getSubscriberBuilder

public SubscriberBuilder<? extends Message<?>,Void> getSubscriberBuilder(Config mpConfig)

Specified by:

getSubscriberBuilder in interface OutgoingConnectorFactory

sendingErrorHandler

protected BiConsumer<Message<?>,jakarta.jms.JMSException> sendingErrorHandler(Config config)

Customizable handler for errors during sending.

Parameters:

config - channel's config

Returns:

consumer of errors