Modifier and Type	Class and Description
private class	DefaultSubscriptionRegistry.DestinationCache Cache for destinations resolved previously via `DefaultSubscriptionRegistry#findSubscriptionsInternal(String, Message)`.
private static class	DefaultSubscriptionRegistry.SessionInfo Container for the subscriptions of a session.
private static class	DefaultSubscriptionRegistry.SessionRegistry Registry for all session and their subscriptions.
private static class	DefaultSubscriptionRegistry.SimpMessageHeaderPropertyAccessor
private static class	DefaultSubscriptionRegistry.Subscription Represents a subscription.

Modifier and Type	Field and Description
private int	cacheLimit
public static final int	DEFAULT_CACHE_LIMIT Default maximum number of entries for the destination cache: 1024.
private final DefaultSubscriptionRegistry.DestinationCache	destinationCache
private final ExpressionParser	expressionParser
private static final EvaluationContext	messageEvalContext Static evaluation context to reuse.
private PathMatcher	pathMatcher
private volatile boolean	selectorHeaderInUse
private String	selectorHeaderName
private final DefaultSubscriptionRegistry.SessionRegistry	sessionRegistry

Access	Constructor and Description
public	DefaultSubscriptionRegistry()

Method Summary

Modifier and Type	Method and Description
protected void	addSubscriptionInternal(String sessionId, String subscriptionId, String destination, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.addSubscriptionInternal.
private boolean	evaluateExpression(Expression expression, Message<?> message)
protected MultiValueMap<String, String>	findSubscriptionsInternal(String destination, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.findSubscriptionsInternal.
public int	getCacheLimit() Return the maximum number of entries for the resolved destination cache.
public PathMatcher	getPathMatcher() Return the configured `PathMatcher`.
private Expression	getSelectorExpression(MessageHeaders headers)
public String	getSelectorHeaderName() Return the name of the selector header.
protected void	removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.removeSubscriptionInternal.
public void	setCacheLimit(int cacheLimit) Specify the maximum number of entries for the resolved destination cache.
public void	setPathMatcher(PathMatcher pathMatcher) Specify the `PathMatcher` to use.
public void	setSelectorHeaderName(String the name to use for a selector header, or `null` or blank to disable selector header support selectorHeaderName) Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.
public void	unregisterAllSubscriptions(String sessionId) Implements org.springframework.messaging.simp.broker.SubscriptionRegistry.unregisterAllSubscriptions. Remove all subscriptions associated with the given sessionId.

Inherited from org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry:: findSubscriptions registerSubscription unregisterSubscription

Field Detail

cacheLimit	back to summary
private int cacheLimit

DEFAULT_CACHE_LIMIT	back to summary
public static final int DEFAULT_CACHE_LIMIT Default maximum number of entries for the destination cache: 1024.

destinationCache	back to summary
private final DefaultSubscriptionRegistry.DestinationCache destinationCache

expressionParser	back to summary
private final ExpressionParser expressionParser

messageEvalContext	back to summary
private static final EvaluationContext messageEvalContext Static evaluation context to reuse.

pathMatcher	back to summary
private PathMatcher pathMatcher

selectorHeaderInUse	back to summary
private volatile boolean selectorHeaderInUse

selectorHeaderName	back to summary
private String selectorHeaderName Annotations @Nullable

sessionRegistry	back to summary
private final DefaultSubscriptionRegistry.SessionRegistry sessionRegistry

DefaultSubscriptionRegistry	back to summary
public DefaultSubscriptionRegistry()

Method Detail

addSubscriptionInternal	back to summary
protected void addSubscriptionInternal(String sessionId, String subscriptionId, String destination, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.addSubscriptionInternal. Annotations @Override

addSubscriptionInternal

back to summary

protected void addSubscriptionInternal(String sessionId, String subscriptionId, String destination, Message<?> message)

Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.addSubscriptionInternal.

Annotations

@Override

evaluateExpression	back to summary
private boolean evaluateExpression(Expression expression, Message<?> message)

findSubscriptionsInternal	back to summary
protected MultiValueMap<String, String> findSubscriptionsInternal(String destination, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.findSubscriptionsInternal. Annotations @Override

findSubscriptionsInternal

back to summary

protected MultiValueMap<String, String> findSubscriptionsInternal(String destination, Message<?> message)

Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.findSubscriptionsInternal.

Annotations

@Override

getCacheLimit	back to summary
public int getCacheLimit() Return the maximum number of entries for the resolved destination cache.

getPathMatcher	back to summary
public PathMatcher getPathMatcher() Return the configured `PathMatcher`.

getSelectorExpression	back to summary
private Expression getSelectorExpression(MessageHeaders headers) Annotations @Nullable

getSelectorHeaderName back to summary

getSelectorHeaderName	back to summary
public String getSelectorHeaderName() Return the name of the selector header. Annotations @Nullable Since 4.2 See Also `setSelectorHeaderName(String)`

public String getSelectorHeaderName()

Return the name of the selector header.

Annotations

@Nullable

Since

4.2

See Also

setSelectorHeaderName(String)

removeSubscriptionInternal	back to summary
protected void removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message) Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.removeSubscriptionInternal. Annotations @Override

removeSubscriptionInternal

back to summary

protected void removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message)

Implements abstract org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry.removeSubscriptionInternal.

Annotations

@Override

setCacheLimit	back to summary
public void setCacheLimit(int cacheLimit) Specify the maximum number of entries for the resolved destination cache. Default is 1024.

setPathMatcher	back to summary
public void setPathMatcher(PathMatcher pathMatcher) Specify the `PathMatcher` to use.

setSelectorHeaderName back to summary

setSelectorHeaderName	back to summary
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 Expression Language (SpEL) boolean expression to be applied to the headers of messages matched to the subscription. For example: headers.foo == 'bar' By default the selector header name is set to `null` which disables this feature. You can set it to `"selector"` or a different name to enable support for a selector header. Parameters selectorHeaderName:String the name to use for a selector header, or `null` or blank to disable selector header support Since 4.2

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 Expression Language (SpEL) boolean expression to be applied to the headers of messages matched to the subscription.

For example:

headers.foo == 'bar'

By default the selector header name is set to null which disables this feature. You can set it to "selector" or a different name to enable support for a selector header.

Parameters

selectorHeaderName:String: the name to use for a selector header, or null or blank to disable selector header support

Since

4.2

unregisterAllSubscriptions	back to summary
public void unregisterAllSubscriptions(String sessionId) Implements org.springframework.messaging.simp.broker.SubscriptionRegistry.unregisterAllSubscriptions. Doc from org.springframework.messaging.simp.broker.SubscriptionRegistry.unregisterAllSubscriptions. Remove all subscriptions associated with the given sessionId. Annotations @Override

unregisterAllSubscriptions

back to summary

public void unregisterAllSubscriptions(String sessionId)

Implements org.springframework.messaging.simp.broker.SubscriptionRegistry.unregisterAllSubscriptions.

Doc from org.springframework.messaging.simp.broker.SubscriptionRegistry.unregisterAllSubscriptions.

Remove all subscriptions associated with the given sessionId.

Annotations

@Override

org.springframework.messaging.simp.broker back to summary

private final Class DefaultSubscriptionRegistry.DestinationCache

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry.DestinationCache

Cache for destinations resolved previously via DefaultSubscriptionRegistry#findSubscriptionsInternal(String, Message).

Field Summary

Modifier and Type	Field and Description
private final Queue<String>	cacheEvictionPolicy
private final AtomicInteger	cacheSize
private final Map<String, LinkedMultiValueMap<String, String>>	destinationCache

Constructor Summary

Access	Constructor and Description
private	DestinationCache()

Method Summary

Modifier and Type	Method and Description
private void	addMatchedSubscriptionId(LinkedMultiValueMap<String, String> sessionIdToSubscriptionIds, String sessionId, String subscriptionId)
private void	addToDestination(String destination, String sessionId, String subscriptionId)
private LinkedMultiValueMap<String, String>	computeMatchingSubscriptions(String destination)
private void	ensureCacheLimit()
public LinkedMultiValueMap<String, String>	getSubscriptions(String destination)
private void	removeInternal(String destination, String sessionId, String subscriptionId)
public void	updateAfterNewSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)
public void	updateAfterRemovedSession(String sessionId, DefaultSubscriptionRegistry.SessionInfo info)
public void	updateAfterRemovedSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)

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

Field Detail

cacheEvictionPolicy	back to summary
private final Queue<String> cacheEvictionPolicy

cacheSize	back to summary
private final AtomicInteger cacheSize

destinationCache	back to summary
private final Map<String, LinkedMultiValueMap<String, String>> destinationCache

Constructor Detail

DestinationCache	back to summary
private DestinationCache()

Method Detail

addMatchedSubscriptionId	back to summary
private void addMatchedSubscriptionId(LinkedMultiValueMap<String, String> sessionIdToSubscriptionIds, String sessionId, String subscriptionId)

addToDestination	back to summary
private void addToDestination(String destination, String sessionId, String subscriptionId)

computeMatchingSubscriptions	back to summary
private LinkedMultiValueMap<String, String> computeMatchingSubscriptions(String destination)

ensureCacheLimit	back to summary
private void ensureCacheLimit()

getSubscriptions	back to summary
public LinkedMultiValueMap<String, String> getSubscriptions(String destination)

removeInternal	back to summary
private void removeInternal(String destination, String sessionId, String subscriptionId)

updateAfterNewSubscription	back to summary
public void updateAfterNewSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)

updateAfterRemovedSession	back to summary
public void updateAfterRemovedSession(String sessionId, DefaultSubscriptionRegistry.SessionInfo info)

updateAfterRemovedSubscription	back to summary
public void updateAfterRemovedSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)

org.springframework.messaging.simp.broker back to summary

private final Class DefaultSubscriptionRegistry.SessionInfo

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry.SessionInfo

Container for the subscriptions of a session.

Field Summary

Modifier and Type	Field and Description
private final Map<String, DefaultSubscriptionRegistry.Subscription>	subscriptionMap

Constructor Summary

Access	Constructor and Description
private	SessionInfo()

Method Summary

Modifier and Type	Method and Description
public void	addSubscription(DefaultSubscriptionRegistry.Subscription subscription)
public DefaultSubscriptionRegistry.Subscription	getSubscription(String subscriptionId)
public Collection<DefaultSubscriptionRegistry.Subscription>	getSubscriptions()
public DefaultSubscriptionRegistry.Subscription	removeSubscription(String subscriptionId)

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

Field Detail

subscriptionMap	back to summary
private final Map<String, DefaultSubscriptionRegistry.Subscription> subscriptionMap

Constructor Detail

SessionInfo	back to summary
private SessionInfo()

Method Detail

addSubscription	back to summary
public void addSubscription(DefaultSubscriptionRegistry.Subscription subscription)

getSubscription	back to summary
public DefaultSubscriptionRegistry.Subscription getSubscription(String subscriptionId) Annotations @Nullable

getSubscriptions	back to summary
public Collection<DefaultSubscriptionRegistry.Subscription> getSubscriptions()

removeSubscription	back to summary
public DefaultSubscriptionRegistry.Subscription removeSubscription(String subscriptionId) Annotations @Nullable

org.springframework.messaging.simp.broker back to summary

private final Class DefaultSubscriptionRegistry.SessionRegistry

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry.SessionRegistry

Registry for all session and their subscriptions.

Field Summary

Modifier and Type	Field and Description
private final ConcurrentMap<String, DefaultSubscriptionRegistry.SessionInfo>	sessions

Constructor Summary

Access	Constructor and Description
private	SessionRegistry()

Method Summary

Modifier and Type	Method and Description
public void	addSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)
public void	forEachSubscription(BiConsumer<String, DefaultSubscriptionRegistry.Subscription> consumer)
public DefaultSubscriptionRegistry.SessionInfo	getSession(String sessionId)
public DefaultSubscriptionRegistry.SessionInfo	removeSubscriptions(String sessionId)

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

Field Detail

sessions	back to summary
private final ConcurrentMap<String, DefaultSubscriptionRegistry.SessionInfo> sessions

Constructor Detail

SessionRegistry	back to summary
private SessionRegistry()

Method Detail

addSubscription	back to summary
public void addSubscription(String sessionId, DefaultSubscriptionRegistry.Subscription subscription)

forEachSubscription	back to summary
public void forEachSubscription(BiConsumer<String, DefaultSubscriptionRegistry.Subscription> consumer)

getSession	back to summary
public DefaultSubscriptionRegistry.SessionInfo getSession(String sessionId) Annotations @Nullable

removeSubscriptions	back to summary
public DefaultSubscriptionRegistry.SessionInfo removeSubscriptions(String sessionId) Annotations @Nullable

org.springframework.messaging.simp.broker back to summary

private Class DefaultSubscriptionRegistry.SimpMessageHeaderPropertyAccessor

Class Inheritance

extends Object
implements PropertyAccessor

java.lang.Object
org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry.SimpMessageHeaderPropertyAccessor

All Implemented Interfaces

org.springframework.expression.PropertyAccessor

Constructor Summary

Access	Constructor and Description
private	SimpMessageHeaderPropertyAccessor()

Method Summary

Modifier and Type	Method and Description
public boolean	canRead(EvaluationContext the evaluation context in which the access is being attempted context, Object the target object upon which the property is being accessed target, String the name of the property being accessed name) Implements org.springframework.expression.PropertyAccessor.canRead. Called to determine if a resolver instance is able to access a specified property on a specified target object.
public boolean	canWrite(EvaluationContext the evaluation context in which the access is being attempted context, Object the target object upon which the property is being accessed target, String the name of the property being accessed name) Implements org.springframework.expression.PropertyAccessor.canWrite. Called to determine if a resolver instance is able to write to a specified property on a specified target object.
public Class<?>[]	getSpecificTargetClasses() Implements org.springframework.expression.PropertyAccessor.getSpecificTargetClasses. Return an array of classes for which this resolver should be called.
public TypedValue	read(EvaluationContext the evaluation context in which the access is being attempted context, Object the target object upon which the property is being accessed target, String the name of the property being accessed name) Implements org.springframework.expression.PropertyAccessor.read. Called to read a property from a specified target object.
public void	write(EvaluationContext the evaluation context in which the access is being attempted context, Object the target object upon which the property is being accessed target, String the name of the property being accessed name, Object the new value for the property value) Implements org.springframework.expression.PropertyAccessor.write. Called to write to a property on a specified target object.

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

Constructor Detail

SimpMessageHeaderPropertyAccessor	back to summary
private SimpMessageHeaderPropertyAccessor()

Method Detail

canRead

back to summary

public boolean canRead(EvaluationContext context, Object target, String name)

Implements org.springframework.expression.PropertyAccessor.canRead.

Doc from org.springframework.expression.PropertyAccessor.canRead.

Called to determine if a resolver instance is able to access a specified property on a specified target object.

Parameters

context:EvaluationContext: the evaluation context in which the access is being attempted
target:Object: the target object upon which the property is being accessed
name:String: the name of the property being accessed

Returns:boolean

true if this resolver is able to read the property

Annotations

@Override

canWrite

back to summary

public boolean canWrite(EvaluationContext context, Object target, String name)

Implements org.springframework.expression.PropertyAccessor.canWrite.

Doc from org.springframework.expression.PropertyAccessor.canWrite.

Called to determine if a resolver instance is able to write to a specified property on a specified target object.

Parameters

context:EvaluationContext: the evaluation context in which the access is being attempted
target:Object: the target object upon which the property is being accessed
name:String: the name of the property being accessed

Returns:boolean

true if this resolver is able to write to the property

Annotations

@Override

getSpecificTargetClasses back to summary

public Class<?>[] getSpecificTargetClasses()

Implements org.springframework.expression.PropertyAccessor.getSpecificTargetClasses.

Doc from org.springframework.expression.PropertyAccessor.getSpecificTargetClasses.

Return an array of classes for which this resolver should be called.

Returning null indicates this is a general resolver that can be called in an attempt to resolve a property on any type.

Returns:Class<?>[]

an array of classes that this resolver is suitable for (or null if a general resolver)

Annotations

@Override

read back to summary

public TypedValue read(EvaluationContext context, Object target, String name)

Implements org.springframework.expression.PropertyAccessor.read.

Doc from org.springframework.expression.PropertyAccessor.read.

Called to read a property from a specified target object. Should only succeed if canRead also returns true.

Parameters

context:EvaluationContext: the evaluation context in which the access is being attempted
target:Object: the target object upon which the property is being accessed
name:String: the name of the property being accessed

Returns:TypedValue

a TypedValue object wrapping the property value read and a type descriptor for it

Annotations

@Override
@SuppressWarnings:rawtypes

write back to summary

public void write(EvaluationContext context, Object target, String name, Object value)

Implements org.springframework.expression.PropertyAccessor.write.

Doc from org.springframework.expression.PropertyAccessor.write.

Called to write to a property on a specified target object. Should only succeed if canWrite also returns true.

Parameters

context:EvaluationContext: the evaluation context in which the access is being attempted
target:Object: the target object upon which the property is being accessed
name:String: the name of the property being accessed
value:Object: the new value for the property

Annotations

@Override

org.springframework.messaging.simp.broker back to summary

private final Class DefaultSubscriptionRegistry.Subscription

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry.Subscription

Represents a subscription.

Field Summary

Modifier and Type	Field and Description
private final String	destination
private final String	id
private final boolean	isPattern
private final Expression	selector

Constructor Summary

Access	Constructor and Description
public	Subscription(String id, String destination, boolean isPattern, Expression selector)

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()
public String	getId()
public Expression	getSelector()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isPattern()
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

isPattern	back to summary
private final boolean isPattern

selector	back to summary
private final Expression selector Annotations @Nullable

Constructor Detail

Subscription	back to summary
public Subscription(String id, String destination, boolean isPattern, Expression selector)

Method Detail

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

getDestination	back to summary
public String getDestination()

getId	back to summary
public String getId()

getSelector	back to summary
public Expression getSelector() Annotations @Nullable

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

isPattern	back to summary
public boolean isPattern()

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 Class DefaultSubscriptionRegistry

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultSubscriptionRegistry.DestinationCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultSubscriptionRegistry.SessionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class DefaultSubscriptionRegistry.SessionRegistry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DefaultSubscriptionRegistry.SimpMessageHeaderPropertyAccessor

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class DefaultSubscriptionRegistry.Subscription

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail