org.springframework.messaging.simp.user

Class UserRegistryMessageHandler

java.lang.Object

org.springframework.messaging.simp.user.UserRegistryMessageHandler

All Implemented Interfaces:

java.util.EventListener, ApplicationListener<BrokerAvailabilityEvent>, MessageHandler

public class UserRegistryMessageHandler
extends java.lang.Object
implements MessageHandler, ApplicationListener<BrokerAvailabilityEvent>

A MessageHandler that is subscribed to listen to broadcasts of user registry information from other application servers as well as to periodically broadcast the content of the local user registry. The aggregated information is maintained in a MultiServerUserRegistry.

Since:

4.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	UserRegistryMessageHandler.UserRegistryTask

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	broadcastDestination
private SimpMessagingTemplate	brokerTemplate
private long	registryExpirationPeriod
private java.util.concurrent.ScheduledFuture<?>	scheduledFuture
private TaskScheduler	scheduler
private UserRegistryMessageHandler.UserRegistryTask	schedulerTask
private MultiServerUserRegistry	userRegistry

Constructor Summary

Constructors

Constructor and Description
UserRegistryMessageHandler(SimpUserRegistry userRegistry, SimpMessagingTemplate brokerTemplate, java.lang.String broadcastDestination, TaskScheduler scheduler)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBroadcastDestination() Return the destination for broadcasting user registry information to.
long	getRegistryExpirationPeriod() Return the configured registry expiration period.
void	handleMessage(Message<?> message) Handle the given message.
void	onApplicationEvent(BrokerAvailabilityEvent event) Handle an application event.
void	setRegistryExpirationPeriod(long expirationPeriod) Configure how long before a remote registry snapshot expires.

Methods inherited from class java.lang.Object

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

Field Detail

userRegistry

private final MultiServerUserRegistry userRegistry

brokerTemplate

private final SimpMessagingTemplate brokerTemplate

broadcastDestination

private final java.lang.String broadcastDestination

scheduler

private final TaskScheduler scheduler

schedulerTask

private final UserRegistryMessageHandler.UserRegistryTask schedulerTask

scheduledFuture

private volatile java.util.concurrent.ScheduledFuture<?> scheduledFuture

registryExpirationPeriod

private long registryExpirationPeriod

Constructor Detail

UserRegistryMessageHandler

public UserRegistryMessageHandler(SimpUserRegistry userRegistry,
                                  SimpMessagingTemplate brokerTemplate,
                                  java.lang.String broadcastDestination,
                                  TaskScheduler scheduler)

Method Detail

getBroadcastDestination

public java.lang.String getBroadcastDestination()

Return the destination for broadcasting user registry information to.

setRegistryExpirationPeriod

public void setRegistryExpirationPeriod(long expirationPeriod)

Configure how long before a remote registry snapshot expires.

By default this is set to 20000 (20 seconds).

Parameters:

expirationPeriod - the expiration period in milliseconds

getRegistryExpirationPeriod

public long getRegistryExpirationPeriod()

Return the configured registry expiration period.

onApplicationEvent

public void onApplicationEvent(BrokerAvailabilityEvent event)

Description copied from interface: ApplicationListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationListener<BrokerAvailabilityEvent>

Parameters:

event - the event to respond to

handleMessage

public void handleMessage(Message<?> message)
                   throws MessagingException

Description copied from interface: MessageHandler

Handle the given message.

Specified by:

handleMessage in interface MessageHandler

Parameters:

message - the message to be handled

Throws:

MessagingException