Modifier and Type	Class and Description
private static class	DefaultSimpUserRegistry.LocalSimpSession
private static class	DefaultSimpUserRegistry.LocalSimpSubscription
private static class	DefaultSimpUserRegistry.LocalSimpUser

Modifier and Type	Field and Description
private int	order
private final Object	sessionLock
private final Map<String, DefaultSimpUserRegistry.LocalSimpSession>	sessions
private final Map<String, DefaultSimpUserRegistry.LocalSimpUser>	users

Access	Constructor and Description
public	DefaultSimpUserRegistry()

Method Summary

Modifier and Type	Method and Description
public Set<SimpSubscription>	findSubscriptions(SimpSubscriptionMatcher the matcher to use matcher) Implements org.springframework.messaging.simp.user.SimpUserRegistry.findSubscriptions. Find subscriptions with the given matcher.
public int	getOrder() Overrides default org.springframework.context.event.SmartApplicationListener.getOrder. Determine this listener's order in a set of listeners for the same event.
public SimpUser	getUser(String the name of the user to look up userName) Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUser. Get the user for the given name.
public int	getUserCount() Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUserCount. Return the count of all connected users.
public Set<SimpUser>	getUsers() Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUsers. Return a snapshot of all connected users.
public void	onApplicationEvent(ApplicationEvent the event to respond to event) Implements org.springframework.context.ApplicationListener.onApplicationEvent. Handle an application event.
public void	setOrder(int order) Specify the order value for this registry.
public boolean	supportsEventType(Class<? extends ApplicationEvent> the event type (never `null`) eventType) Implements org.springframework.context.event.SmartApplicationListener.supportsEventType. Determine whether this listener actually supports the given event type.
public boolean	supportsSourceType(Class<?> the source type, or `null` if no source sourceType) Overrides default org.springframework.context.event.SmartApplicationListener.supportsSourceType. Determine whether this listener actually supports the given source type.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

order	back to summary
private int order

sessionLock	back to summary
private final Object sessionLock

sessions	back to summary
private final Map<String, DefaultSimpUserRegistry.LocalSimpSession> sessions

users	back to summary
private final Map<String, DefaultSimpUserRegistry.LocalSimpUser> users

DefaultSimpUserRegistry	back to summary
public DefaultSimpUserRegistry()

Method Detail

findSubscriptions	back to summary
public Set<SimpSubscription> findSubscriptions(SimpSubscriptionMatcher matcher) Implements org.springframework.messaging.simp.user.SimpUserRegistry.findSubscriptions. Doc from org.springframework.messaging.simp.user.SimpUserRegistry.findSubscriptions. Find subscriptions with the given matcher. Parameters matcher:SimpSubscriptionMatcher the matcher to use Returns:Set<SimpSubscription> a set of matching subscriptions, or an empty set if none Annotations @Override

findSubscriptions

back to summary

public Set<SimpSubscription> findSubscriptions(SimpSubscriptionMatcher matcher)

Implements org.springframework.messaging.simp.user.SimpUserRegistry.findSubscriptions.

Doc from org.springframework.messaging.simp.user.SimpUserRegistry.findSubscriptions.

Find subscriptions with the given matcher.

Parameters

matcher:SimpSubscriptionMatcher: the matcher to use

Returns:Set<SimpSubscription>

a set of matching subscriptions, or an empty set if none

Annotations

@Override

getOrder back to summary

getOrder	back to summary
public int getOrder() Overrides default org.springframework.context.event.SmartApplicationListener.getOrder. Doc from org.springframework.context.event.SmartApplicationListener.getOrder. Determine this listener's order in a set of listeners for the same event. The default implementation returns `LOWEST_PRECEDENCE`. Returns:int Doc from org.springframework.core.Ordered.getOrder. the order value Annotations @Override

public int getOrder()

Overrides default org.springframework.context.event.SmartApplicationListener.getOrder.

Doc from org.springframework.context.event.SmartApplicationListener.getOrder.

Determine this listener's order in a set of listeners for the same event.

The default implementation returns LOWEST_PRECEDENCE.

Returns:int

Doc from org.springframework.core.Ordered.getOrder.

the order value

Annotations

@Override

getUser back to summary

getUser	back to summary
public SimpUser getUser(String userName) Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUser. Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUser. Get the user for the given name. Parameters userName:String the name of the user to look up Returns:SimpUser the user, or `null` if not connected Annotations @Override @Nullable

public SimpUser getUser(String userName)

Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUser.

Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUser.

Get the user for the given name.

Parameters

userName:String: the name of the user to look up

Returns:SimpUser

the user, or null if not connected

Annotations

@Override
@Nullable

getUserCount	back to summary
public int getUserCount() Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUserCount. Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUserCount. Return the count of all connected users. Returns:int the number of connected users Annotations @Override

getUserCount

back to summary

public int getUserCount()

Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUserCount.

Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUserCount.

Return the count of all connected users.

Returns:int

the number of connected users

Annotations

@Override

getUsers	back to summary
public Set<SimpUser> getUsers() Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUsers. Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUsers. Return a snapshot of all connected users. The returned set is a copy and will not reflect further changes. Returns:Set<SimpUser> the connected users, or an empty set if none Annotations @Override

getUsers

back to summary

public Set<SimpUser> getUsers()

Implements org.springframework.messaging.simp.user.SimpUserRegistry.getUsers.

Doc from org.springframework.messaging.simp.user.SimpUserRegistry.getUsers.

Return a snapshot of all connected users.

The returned set is a copy and will not reflect further changes.

Returns:Set<SimpUser>

the connected users, or an empty set if none

Annotations

@Override

onApplicationEvent	back to summary
public void onApplicationEvent(ApplicationEvent event) Implements org.springframework.context.ApplicationListener.onApplicationEvent. Doc from org.springframework.context.ApplicationListener.onApplicationEvent. Handle an application event. Parameters event:ApplicationEvent the event to respond to Annotations @Override

onApplicationEvent

back to summary

public void onApplicationEvent(ApplicationEvent event)

Implements org.springframework.context.ApplicationListener.onApplicationEvent.

Doc from org.springframework.context.ApplicationListener.onApplicationEvent.

Handle an application event.

Parameters

event:ApplicationEvent: the event to respond to

Annotations

@Override

setOrder back to summary

setOrder	back to summary
public void setOrder(int order) Specify the order value for this registry. Default is `Ordered#LOWEST_PRECEDENCE`. Since 5.0.8

public void setOrder(int order)

Specify the order value for this registry.

Default is Ordered#LOWEST_PRECEDENCE.

Since: 5.0.8

supportsEventType back to summary

supportsEventType	back to summary
public boolean supportsEventType(Class<? extends ApplicationEvent> eventType) Implements org.springframework.context.event.SmartApplicationListener.supportsEventType. Doc from org.springframework.context.event.SmartApplicationListener.supportsEventType. Determine whether this listener actually supports the given event type. Parameters eventType:Class<? extends ApplicationEvent> the event type (never `null`) Annotations @Override

public boolean supportsEventType(Class<? extends ApplicationEvent> eventType)

Implements org.springframework.context.event.SmartApplicationListener.supportsEventType.

Doc from org.springframework.context.event.SmartApplicationListener.supportsEventType.

Determine whether this listener actually supports the given event type.

Parameters

eventType:Class<? extends ApplicationEvent>: the event type (never null)

Annotations

@Override

supportsSourceType back to summary

supportsSourceType	back to summary
public boolean supportsSourceType(Class<?> sourceType) Overrides default org.springframework.context.event.SmartApplicationListener.supportsSourceType. Doc from org.springframework.context.event.SmartApplicationListener.supportsSourceType. Determine whether this listener actually supports the given source type. The default implementation always returns `true`. Parameters sourceType:Class<?> the source type, or `null` if no source Annotations @Override

public boolean supportsSourceType(Class<?> sourceType)

Overrides default org.springframework.context.event.SmartApplicationListener.supportsSourceType.

Doc from org.springframework.context.event.SmartApplicationListener.supportsSourceType.

Determine whether this listener actually supports the given source type.

The default implementation always returns true.

Parameters

sourceType:Class<?>: the source type, or null if no source

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.web.socket.messaging back to summary

private Class DefaultSimpUserRegistry.LocalSimpSession

Class Inheritance

extends Object
implements SimpSession

java.lang.Object
org.springframework.web.socket.messaging.DefaultSimpUserRegistry.LocalSimpSession

All Implemented Interfaces

org.springframework.messaging.simp.user.SimpSession

Field Summary

Modifier and Type	Field and Description
private final String	id
private final Map<String, SimpSubscription>	subscriptions
private final DefaultSimpUserRegistry.LocalSimpUser	user

Constructor Summary

Access	Constructor and Description
public	LocalSimpSession(String id, DefaultSimpUserRegistry.LocalSimpUser user)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addSubscription(String id, String destination)
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getId() Implements org.springframework.messaging.simp.user.SimpSession.getId. Return the session id.
public Set<SimpSubscription>	getSubscriptions() Implements org.springframework.messaging.simp.user.SimpSession.getSubscriptions. Return the subscriptions for this session.
public DefaultSimpUserRegistry.LocalSimpUser	getUser() Implements org.springframework.messaging.simp.user.SimpSession.getUser. Return the user associated with the session.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv void	removeSubscription(String id)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

id	back to summary
private final String id

subscriptions	back to summary
private final Map<String, SimpSubscription> subscriptions

user	back to summary
private final DefaultSimpUserRegistry.LocalSimpUser user

Constructor Detail

LocalSimpSession	back to summary
public LocalSimpSession(String id, DefaultSimpUserRegistry.LocalSimpUser user)

Method Detail

addSubscription	back to summary
pack-priv void addSubscription(String id, String destination)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.messaging.simp.user.SimpSession.getId. Doc from org.springframework.messaging.simp.user.SimpSession.getId. Return the session id. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.messaging.simp.user.SimpSession.getId.

Doc from org.springframework.messaging.simp.user.SimpSession.getId.

Return the session id.

Annotations

@Override

getSubscriptions	back to summary
public Set<SimpSubscription> getSubscriptions() Implements org.springframework.messaging.simp.user.SimpSession.getSubscriptions. Doc from org.springframework.messaging.simp.user.SimpSession.getSubscriptions. Return the subscriptions for this session. Annotations @Override

getSubscriptions

back to summary

public Set<SimpSubscription> getSubscriptions()

Implements org.springframework.messaging.simp.user.SimpSession.getSubscriptions.

Doc from org.springframework.messaging.simp.user.SimpSession.getSubscriptions.

Return the subscriptions for this session.

Annotations

@Override

getUser	back to summary
public DefaultSimpUserRegistry.LocalSimpUser getUser() Implements org.springframework.messaging.simp.user.SimpSession.getUser. Doc from org.springframework.messaging.simp.user.SimpSession.getUser. Return the user associated with the session. Annotations @Override

getUser

back to summary

public DefaultSimpUserRegistry.LocalSimpUser getUser()

Implements org.springframework.messaging.simp.user.SimpSession.getUser.

Doc from org.springframework.messaging.simp.user.SimpSession.getUser.

Return the user associated with the session.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

removeSubscription	back to summary
pack-priv void removeSubscription(String id)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.web.socket.messaging back to summary

private Class DefaultSimpUserRegistry.LocalSimpSubscription

Class Inheritance

extends Object
implements SimpSubscription

java.lang.Object
org.springframework.web.socket.messaging.DefaultSimpUserRegistry.LocalSimpSubscription

All Implemented Interfaces

org.springframework.messaging.simp.user.SimpSubscription

Field Summary

Modifier and Type	Field and Description
private final String	destination
private final String	id
private final DefaultSimpUserRegistry.LocalSimpSession	session

Constructor Summary

Access	Constructor and Description
public	LocalSimpSubscription(String id, String destination, DefaultSimpUserRegistry.LocalSimpSession session)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getDestination() Implements org.springframework.messaging.simp.user.SimpSubscription.getDestination. Return the subscription's destination.
public String	getId() Implements org.springframework.messaging.simp.user.SimpSubscription.getId. Return the id associated of the subscription.
public DefaultSimpUserRegistry.LocalSimpSession	getSession() Implements org.springframework.messaging.simp.user.SimpSubscription.getSession. Return the session of the subscription.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

destination	back to summary
private final String destination

id	back to summary
private final String id

session	back to summary
private final DefaultSimpUserRegistry.LocalSimpSession session

Constructor Detail

LocalSimpSubscription	back to summary
public LocalSimpSubscription(String id, String destination, DefaultSimpUserRegistry.LocalSimpSession session)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters other:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getDestination	back to summary
public String getDestination() Implements org.springframework.messaging.simp.user.SimpSubscription.getDestination. Doc from org.springframework.messaging.simp.user.SimpSubscription.getDestination. Return the subscription's destination. Annotations @Override

getDestination

back to summary

public String getDestination()

Implements org.springframework.messaging.simp.user.SimpSubscription.getDestination.

Doc from org.springframework.messaging.simp.user.SimpSubscription.getDestination.

Return the subscription's destination.

Annotations

@Override

getId	back to summary
public String getId() Implements org.springframework.messaging.simp.user.SimpSubscription.getId. Doc from org.springframework.messaging.simp.user.SimpSubscription.getId. Return the id associated of the subscription. Annotations @Override

getId

back to summary

public String getId()

Implements org.springframework.messaging.simp.user.SimpSubscription.getId.

Doc from org.springframework.messaging.simp.user.SimpSubscription.getId.

Return the id associated of the subscription.

Annotations

@Override

getSession	back to summary
public DefaultSimpUserRegistry.LocalSimpSession getSession() Implements org.springframework.messaging.simp.user.SimpSubscription.getSession. Doc from org.springframework.messaging.simp.user.SimpSubscription.getSession. Return the session of the subscription. Annotations @Override

getSession

back to summary

public DefaultSimpUserRegistry.LocalSimpSession getSession()

Implements org.springframework.messaging.simp.user.SimpSubscription.getSession.

Doc from org.springframework.messaging.simp.user.SimpSubscription.getSession.

Return the session of the subscription.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.springframework.web.socket.messaging back to summary

private Class DefaultSimpUserRegistry.LocalSimpUser

Class Inheritance

extends Object
implements SimpUser

java.lang.Object
org.springframework.web.socket.messaging.DefaultSimpUserRegistry.LocalSimpUser

All Implemented Interfaces

org.springframework.messaging.simp.user.SimpUser

Field Summary

Modifier and Type	Field and Description
private final String	name
private final Principal	user
private final Map<String, SimpSession>	userSessions

Constructor Summary

Access	Constructor and Description
public	LocalSimpUser(String userName, Principal user)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addSession(SimpSession session)
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getName() Implements org.springframework.messaging.simp.user.SimpUser.getName. The unique user name.
public Principal	getPrincipal() Implements org.springframework.messaging.simp.user.SimpUser.getPrincipal. Return the user associated with the session, if available.
public SimpSession	getSession(String the session id sessionId) Implements org.springframework.messaging.simp.user.SimpUser.getSession. Look up the session for the given id.
public Set<SimpSession>	getSessions() Implements org.springframework.messaging.simp.user.SimpUser.getSessions. Return the sessions for the user.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasSessions() Implements org.springframework.messaging.simp.user.SimpUser.hasSessions. Whether the user has any sessions.
pack-priv void	removeSession(String sessionId)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

name	back to summary
private final String name

user	back to summary
private final Principal user

userSessions	back to summary
private final Map<String, SimpSession> userSessions

Constructor Detail

LocalSimpUser	back to summary
public LocalSimpUser(String userName, Principal user)

Method Detail

addSession	back to summary
pack-priv void addSession(SimpSession session)

equals back to summary

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

other:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getName

back to summary

public String getName()

Implements org.springframework.messaging.simp.user.SimpUser.getName.

Doc from org.springframework.messaging.simp.user.SimpUser.getName.

The unique user name.

Annotations

@Override

getPrincipal

back to summary

public Principal getPrincipal()

Implements org.springframework.messaging.simp.user.SimpUser.getPrincipal.

Doc from org.springframework.messaging.simp.user.SimpUser.getPrincipal.

Return the user associated with the session, if available. Typically, the user information is available unless the user is connected to a different server in a multi-server user registry scenario.

Annotations

@Nullable
@Override

getSession back to summary

public SimpSession getSession(String sessionId)

Implements org.springframework.messaging.simp.user.SimpUser.getSession.

Doc from org.springframework.messaging.simp.user.SimpUser.getSession.

Look up the session for the given id.

Parameters

sessionId:String: the session id

Returns:SimpSession

the matching session, or null if none found

Annotations

@Override
@Nullable

getSessions

back to summary

public Set<SimpSession> getSessions()

Implements org.springframework.messaging.simp.user.SimpUser.getSessions.

Doc from org.springframework.messaging.simp.user.SimpUser.getSessions.

Return the sessions for the user. The returned set is a copy and will never be modified.

Returns:Set<SimpSession>

a set of session ids, or an empty set if none

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations