Class ZeroMqMessageHandlerSpec

java.lang.Object
org.springframework.integration.dsl.IntegrationComponentSpec<ZeroMqMessageHandlerSpec, ReactiveMessageHandlerAdapter>
org.springframework.integration.dsl.MessageHandlerSpec<ZeroMqMessageHandlerSpec, ReactiveMessageHandlerAdapter>
org.springframework.integration.dsl.ReactiveMessageHandlerSpec<ZeroMqMessageHandlerSpec, ZeroMqMessageHandler>
org.springframework.integration.zeromq.dsl.ZeroMqMessageHandlerSpec
All Implemented Interfaces:
DisposableBean, FactoryBean<ReactiveMessageHandlerAdapter>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration
public class ZeroMqMessageHandlerSpec extends ReactiveMessageHandlerSpec<ZeroMqMessageHandlerSpec, ZeroMqMessageHandler>
The ReactiveMessageHandlerSpec extension for ZeroMqMessageHandler.
Since:
5.4
Author:
Artem Bilan, Alessio Matricardi

  • Constructor Details

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, String connectUrl)
      Create an instance based on the provided ZContext and connection string.
      Parameters:
      context - the ZContext to use for creating sockets.
      connectUrl - the URL to connect the socket to.

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context)
      Create an instance based on the provided ZContext. The created socket will be bound to a random port.
      Parameters:
      context - the ZContext to use for creating sockets.
      Since:
      6.4

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, int port)
      Create an instance based on the provided ZContext and binding port.
      Parameters:
      context - the ZContext to use for creating sockets.
      port - the port to bind ZeroMq socket to over TCP.
      Since:
      6.4

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, Supplier<String> connectUrl)
      Create an instance based on the provided ZContext and connection string supplier.
      Parameters:
      context - the ZContext to use for creating sockets.
      connectUrl - the supplier for URL to connect the socket to.
      Since:
      5.5.9

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, String connectUrl, org.zeromq.SocketType socketType)
      Create an instance based on the provided ZContext, connection string and SocketType.
      Parameters:
      context - the ZContext to use for creating sockets.
      connectUrl - the URL to connect the socket to.
      socketType - the SocketType to use; only SocketType.PAIR, SocketType.PUB and SocketType.PUSH are supported.

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, org.zeromq.SocketType socketType)
      Create an instance based on the provided ZContext and SocketType. The created socket will be bound to a random port.
      Parameters:
      context - the ZContext to use for creating sockets.
      socketType - the SocketType to use; only SocketType.PAIR, SocketType.PUB and SocketType.PUSH are supported.
      Since:
      6.4

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, int port, org.zeromq.SocketType socketType)
      Create an instance based on the provided ZContext, binding port and SocketType.
      Parameters:
      context - the ZContext to use for creating sockets.
      port - the port to bind ZeroMq socket to over TCP.
      socketType - the SocketType to use; only SocketType.PAIR, SocketType.PUB and SocketType.PUSH are supported.
      Since:
      6.4

    • ZeroMqMessageHandlerSpec

      protected ZeroMqMessageHandlerSpec(org.zeromq.ZContext context, Supplier<String> connectUrl, org.zeromq.SocketType socketType)
      Create an instance based on the provided ZContext, connection string supplier and SocketType.
      Parameters:
      context - the ZContext to use for creating sockets.
      connectUrl - the supplier for URL to connect the socket to.
      socketType - the SocketType to use; only SocketType.PAIR, SocketType.PUB and SocketType.PUSH are supported.

  • Method Details

    • messageMapper

      public ZeroMqMessageHandlerSpec messageMapper(OutboundMessageMapper<byte[]> messageMapper)
      Provide an OutboundMessageMapper to convert a request message into byte[] for sending into ZeroMq socket.
      Parameters:
      messageMapper - the OutboundMessageMapper to use.
      Returns:
      the spec

    • messageConverter

      public ZeroMqMessageHandlerSpec messageConverter(MessageConverter messageConverter)
      Provide a MessageConverter (as an alternative to messageMapper(org.springframework.integration.mapping.OutboundMessageMapper<byte[]>)) for converting a request message into byte[] for sending into ZeroMq socket.
      Parameters:
      messageConverter - the MessageConverter to use.
      Returns:
      the spec

    • socketConfigurer

      public ZeroMqMessageHandlerSpec socketConfigurer(Consumer<org.zeromq.ZMQ.Socket> socketConfigurer)
      Provide a Consumer to configure a socket with arbitrary options, like security.
      Parameters:
      socketConfigurer - the configurer for socket options.
      Returns:
      the spec

    • topic

      public ZeroMqMessageHandlerSpec topic(String topic)
      Specify a topic the SocketType.PUB socket is going to use for distributing messages into the subscriptions. It is ignored for all other SocketTypes supported.
      Parameters:
      topic - the topic to use.
      Returns:
      the spec

    • wrapTopic

      public ZeroMqMessageHandlerSpec wrapTopic(boolean wrapTopic)
      Specify if the topic that SocketType.PUB socket is going to use for distributing messages into the subscriptions must be wrapped with an additional empty frame. It is ignored for all other SocketTypes supported. This attribute is set to true by default.
      Parameters:
      wrapTopic - true if the topic must be wrapped with an additional empty frame.
      Returns:
      the spec
      Since:
      6.2.6

    • topicFunction

      public ZeroMqMessageHandlerSpec topicFunction(Function<Message<?>, String> topicFunction)
      Specify a Function to evaluate a topic a SocketType.PUB is going to use for distributing messages into the subscriptions.It is ignored for all other SocketTypes supported.
      Parameters:
      topicFunction - the Function to evaluate topic for publishing.
      Returns:
      the spec

    • topicExpression

      public ZeroMqMessageHandlerSpec topicExpression(String topicExpression)
      Specify a SpEL expression to evaluate a topic a SocketType.PUB is going to use for distributing messages into the subscriptions.It is ignored for all other SocketTypes supported.
      Parameters:
      topicExpression - the expression to evaluate topic for publishing.
      Returns:
      the spec

    • topicExpression

      public ZeroMqMessageHandlerSpec topicExpression(Expression topicExpression)
      Specify a SpEL expression to evaluate a topic a SocketType.PUB is going to use for distributing messages into the subscriptions.It is ignored for all other SocketTypes supported.
      Parameters:
      topicExpression - the expression to evaluate topic for publishing.
      Returns:
      the spec