Package io.smallrye.reactive.messaging.memory

Class InMemoryConnector

java.lang.Object
io.smallrye.reactive.messaging.memory.InMemoryConnector
All Implemented Interfaces:
InboundConnector, OutboundConnector, org.eclipse.microprofile.reactive.messaging.spi.ConnectorFactory
@ApplicationScoped public class InMemoryConnector extends Object implements InboundConnector, OutboundConnector
An implementation of connector used for testing applications without having to use external broker. The idea is to substitute the `connector` of a specific channel to use `smallrye-in-memory`. Then, your test can send message and checked the received messages.

  • Field Details

  • Constructor Details

    • InMemoryConnector

      public InMemoryConnector()

  • Method Details

    • switchIncomingChannelsToInMemory

      public static Map<String,String> switchIncomingChannelsToInMemory(String... channels)
      Switch the given incoming channel to in-memory. It replaces the previously used connector with the in-memory connector.

      This method is generally used before tests to avoid using an external broker for a specific channel. You can then retrieve the InMemorySource using: 

           @Inject @Any
     InMemoryConnector connector;

     //...

     @Before
     public void setup() {
         InMemoryConnector.switchIncomingChannelsToInMemory("my-channel");
     }

     // ..

     InMemorySource<Integer> channel = connector.source("my-channel");
     channel.send(1);
     channel.send(2);

      Parameters:
      channels - the channels to switch, must not be null, must not contain null, must not contain a blank value
      Returns:
      The map of properties that have been defined. The method sets the system properties, but give you this map to pass the properties around if needed.

    • switchOutgoingChannelsToInMemory

      public static Map<String,String> switchOutgoingChannelsToInMemory(String... channels)
      Switch the given outgoing channel to in-memory. It replaces the previously used connector with the in-memory connector.

      This method is generally used before tests to avoid using an external broker for a specific channel. You can then retrieve the InMemorySink using: 

           @Inject @Any
     InMemoryConnector connector;

     //...

     @Before
     public void setup() {
         InMemoryConnector.switchOutgoingChannelsToInMemory("my-channel");
     }

     // ..

     InMemorySink<Integer> channel = connector.sink("my-channel");
     assertThat(channel.received()).hasSize(3).extracting(Message::getPayload).containsExactly(1, 2);

      Parameters:
      channels - the channels to switch, must not be null, must not contain null, must not contain a blank value
      Returns:
      The map of properties that have been defined. The method sets the system properties, but give you this map to pass these properties around if needed.

    • clear

      public static void clear()
      Switch back the channel to their original connector.

      This method is generally used after tests to reset the original configuration.

    • getPublisher

      public Flow.Publisher<? extends org.eclipse.microprofile.reactive.messaging.Message<?>> getPublisher(org.eclipse.microprofile.config.Config config)
      Specified by:
      getPublisher in interface InboundConnector

    • getSubscriber

      public Flow.Subscriber<? extends org.eclipse.microprofile.reactive.messaging.Message<?>> getSubscriber(org.eclipse.microprofile.config.Config config)
      Specified by:
      getSubscriber in interface OutboundConnector

    • source

      public <T> InMemorySource<T> source(String channel)
      Retrieves an InMemorySource associated to the channel named channel. This channel must use the in-memory connected.

      The returned InMemorySource lets you send messages or payloads to the channel, mocking the real interactions.

      Type Parameters:
      T - the type of message or payload sent to the channel
      Parameters:
      channel - the name of the channel, must not be null
      Returns:
      the source
      Throws:
      IllegalArgumentException - if the channel name is null or if the channel is not associated with the in-memory connector.
      See Also:

    • sink

      public <T> InMemorySink<T> sink(String channel)
      Retrieves an InMemorySink associated to the channel named channel. This channel must use the in-memory connected.

      The returned InMemorySink lets you checks the messages sent to the channel.

      Type Parameters:
      T - the type of payload received by the channel
      Parameters:
      channel - the name of the channel, must not be null
      Returns:
      the sink
      Throws:
      IllegalArgumentException - if the channel name is null or if the channel is not associated with the in-memory connector.
      See Also: