Class SimpleBrokerMessageHandler

Constructor Detail

• SimpleBrokerMessageHandler

  public SimpleBrokerMessageHandler​(SubscribableChannel clientInboundChannel,
                                    MessageChannel clientOutboundChannel,
                                    SubscribableChannel brokerChannel,
                                    Collection<String> destinationPrefixes)

  Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes.

  Parameters:

  clientInboundChannel - the channel for receiving messages from clients (e.g. WebSocket clients)

  clientOutboundChannel - the channel for sending messages to clients (e.g. WebSocket clients)

  brokerChannel - the channel for the application to send messages to the broker

  destinationPrefixes - prefixes to use to filter out messages

Method Detail

• setSubscriptionRegistry

  public void setSubscriptionRegistry​(SubscriptionRegistry subscriptionRegistry)

  Configure a custom SubscriptionRegistry to use for storing subscriptions.

  Note that when a custom PathMatcher is configured via setPathMatcher(org.springframework.util.PathMatcher), if the custom registry is not an instance of DefaultSubscriptionRegistry, the provided PathMatcher is not used and must be configured directly on the custom registry.

• getSubscriptionRegistry

  public SubscriptionRegistry getSubscriptionRegistry()

• setSelectorHeaderName

  public void setSelectorHeaderName​(String selectorHeaderName)

  Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription. The header value is expected to be a Spring EL boolean expression to be applied to the headers of messages matched to the subscription.

  For example:

   headers.foo == 'bar'
   

  By default this is set to "selector". You can set it to a different name, or to null to turn off support for a selector header.

  Parameters:

  selectorHeaderName - the name to use for a selector header

  Since:

  4.3.17

  See Also:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setSelectorHeaderName(String)

• setPathMatcher

  public void setPathMatcher​(PathMatcher pathMatcher)

  When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.

  Default is a standard AntPathMatcher.

  Since:

  4.1

  See Also:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setPathMatcher(org.springframework.util.PathMatcher), AntPathMatcher

• setCacheLimit

  public void setCacheLimit​(Integer cacheLimit)

  When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.

  With a standard DefaultSubscriptionRegistry, the default cache limit is 1024.

  Since:

  4.3.2

  See Also:

  setSubscriptionRegistry(org.springframework.messaging.simp.broker.SubscriptionRegistry), DefaultSubscriptionRegistry.setCacheLimit(int), DefaultSubscriptionRegistry.DEFAULT_CACHE_LIMIT

• setTaskScheduler

  public void setTaskScheduler​(TaskScheduler taskScheduler)

  Configure the TaskScheduler to use for providing heartbeat support. Setting this property also sets the heartbeatValue to "10000, 10000".

  By default this is not set.

  Since:

  4.2

• getTaskScheduler

  public TaskScheduler getTaskScheduler()

  Return the configured TaskSchedulans no heartbeats.

  By default this is set to "0, 0" unless the taskScheduler in which case the default becomes "10000,10000" (in milliseconds).

  Since:

  4.2

• getHeartbeatValue

  public long[] getHeartbeatValue()

  The configured value for the heart-beat settings.

  Since:

  4.2

• setHeaderInitializer

  public void setHeaderInitializer​(MessageHeaderInitializer headerInitializer)

  Configure a MessageHeaderInitializer to apply to the headers of all messages sent to the client outbound channel.

  By default this property is not set.

  Since:

  4.1

• getHeaderInitializer

  public MessageHeaderInitializer getHeaderInitializer()

  Return the configured header initializer.

  Since:

  4.1

• startInternal

  public void startInternal()

  Overrides:

  startInternal in class AbstractBrokerMessageHandler

• stopInternal

  public void stopInternal()

  Overrides:

  stopInternal in class AbstractBrokerMessageHandler

• handleMessageInternal

  protected void handleMessageInternal​(Message<?> message)

  Specified by:

  handleMessageInternal in class AbstractBrokerMessageHandler

• sendMessageToSubscribers

  protected void sendMessageToSubscribers​(String destination,
                                          Message<?> message)

• toString

  public String toString()

  Overrides:

  toString in class Object