Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ABORT - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- AbstractAsyncReturnValueHandler - Class in org.springframework.messaging.handler.invocation
-
Convenient base class for
AsyncHandlerMethodReturnValueHandler
implementations that support only asynchronous (Future-like) return values and merely serve as adapters of such types to Spring'sListenableFuture
. - AbstractAsyncReturnValueHandler() - Constructor for class org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler
- AbstractBrokerMessageHandler - Class in org.springframework.messaging.simp.broker
-
Abstract base class for a
MessageHandler
that broker messages to registered subscribers. - AbstractBrokerMessageHandler(SubscribableChannel, MessageChannel, SubscribableChannel) - Constructor for class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Constructor with no destination prefixes (matches all destinations).
- AbstractBrokerMessageHandler(SubscribableChannel, MessageChannel, SubscribableChannel, Collection<String>) - Constructor for class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Constructor with destination prefixes to match to destinations of messages.
- AbstractBrokerRegistration - Class in org.springframework.messaging.simp.config
-
Base class for message broker registration classes.
- AbstractBrokerRegistration(SubscribableChannel, MessageChannel, String[]) - Constructor for class org.springframework.messaging.simp.config.AbstractBrokerRegistration
-
Create a new broker registration.
- AbstractDestinationResolvingMessagingTemplate<D> - Class in org.springframework.messaging.core
-
An extension of
AbstractMessagingTemplate
that adds operations for sending messages to a resolvable destination name. - AbstractDestinationResolvingMessagingTemplate() - Constructor for class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- AbstractEncoderMethodReturnValueHandler - Class in org.springframework.messaging.handler.invocation.reactive
-
Base class for a return value handler that encodes return values to
Flux<DataBuffer>
through the configuredEncoder
s. - AbstractEncoderMethodReturnValueHandler(List<Encoder<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
- AbstractExceptionHandlerMethodResolver - Class in org.springframework.messaging.handler.invocation
-
Cache exception handling method mappings and provide options to look up a method that should handle an exception.
- AbstractExceptionHandlerMethodResolver(Map<Class<? extends Throwable>, Method>) - Constructor for class org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver
-
Protected constructor accepting exception-to-method mappings.
- AbstractHeaderMapper<T> - Class in org.springframework.messaging.support
-
A base
HeaderMapper
implementation. - AbstractHeaderMapper() - Constructor for class org.springframework.messaging.support.AbstractHeaderMapper
- AbstractJsonMessageConverter - Class in org.springframework.messaging.converter
-
Common base class for plain JSON converters, e.g.
- AbstractJsonMessageConverter() - Constructor for class org.springframework.messaging.converter.AbstractJsonMessageConverter
- AbstractMessageBrokerConfiguration - Class in org.springframework.messaging.simp.config
-
Provides essential configuration for handling messages with simple messaging protocols such as STOMP.
- AbstractMessageBrokerConfiguration() - Constructor for class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Protected constructor.
- AbstractMessageChannel - Class in org.springframework.messaging.support
-
Abstract base class for
MessageChannel
implementations. - AbstractMessageChannel() - Constructor for class org.springframework.messaging.support.AbstractMessageChannel
- AbstractMessageChannel.ChannelInterceptorChain - Class in org.springframework.messaging.support
-
Assists with the invocation of the configured channel interceptors.
- AbstractMessageCondition<T extends AbstractMessageCondition<T>> - Class in org.springframework.messaging.handler
-
Base class for
MessageCondition's
that pre-declares abstract methodsAbstractMessageCondition.getContent()
andAbstractMessageCondition.getToStringInfix()
in order to provide implementations ofAbstractMessageCondition.equals(Object)
,AbstractMessageCondition.hashCode()
, andAbstractMessageCondition.toString()
. - AbstractMessageCondition() - Constructor for class org.springframework.messaging.handler.AbstractMessageCondition
- AbstractMessageConverter - Class in org.springframework.messaging.converter
-
Abstract base class for
SmartMessageConverter
implementations including support for common properties and a partial implementation of the conversion methods, mainly to check if the converter supports the conversion based on the payload class and MIME type. - AbstractMessageConverter(Collection<MimeType>) - Constructor for class org.springframework.messaging.converter.AbstractMessageConverter
-
Constructor with Collection of MIME types.
- AbstractMessageConverter(MimeType) - Constructor for class org.springframework.messaging.converter.AbstractMessageConverter
-
Constructor with a single MIME type.
- AbstractMessageConverter(MimeType...) - Constructor for class org.springframework.messaging.converter.AbstractMessageConverter
-
Constructor with multiple MIME types.
- AbstractMessageReceivingTemplate<D> - Class in org.springframework.messaging.core
-
An extension of
AbstractMessageSendingTemplate
that adds support for receive style operations as defined byMessageReceivingOperations
. - AbstractMessageReceivingTemplate() - Constructor for class org.springframework.messaging.core.AbstractMessageReceivingTemplate
- AbstractMessageSendingTemplate<D> - Class in org.springframework.messaging.core
-
Abstract base class for implementations of
MessageSendingOperations
. - AbstractMessageSendingTemplate() - Constructor for class org.springframework.messaging.core.AbstractMessageSendingTemplate
- AbstractMessagingTemplate<D> - Class in org.springframework.messaging.core
-
An extension of
AbstractMessageReceivingTemplate
that adds support for request-reply style operations as defined byMessageRequestReplyOperations
. - AbstractMessagingTemplate() - Constructor for class org.springframework.messaging.core.AbstractMessagingTemplate
- AbstractMethodMessageHandler<T> - Class in org.springframework.messaging.handler.invocation
-
Abstract base class for HandlerMethod-based message handling.
- AbstractMethodMessageHandler<T> - Class in org.springframework.messaging.handler.invocation.reactive
-
Abstract base class for reactive HandlerMethod-based message handling.
- AbstractMethodMessageHandler() - Constructor for class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- AbstractMethodMessageHandler() - Constructor for class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- AbstractNamedValueMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
Abstract base class to resolve method arguments from a named value, e.g.
- AbstractNamedValueMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
Abstract base class to resolve method arguments from a named value, e.g.
- AbstractNamedValueMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver
-
Constructor with a
ConversionService
and aBeanFactory
. - AbstractNamedValueMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
-
Constructor with a
ConversionService
and aBeanFactory
. - AbstractNamedValueMethodArgumentResolver.NamedValueInfo - Class in org.springframework.messaging.handler.annotation.reactive
-
Represents a named value declaration.
- AbstractNamedValueMethodArgumentResolver.NamedValueInfo - Class in org.springframework.messaging.handler.annotation.support
-
Represents a named value declaration.
- AbstractNioBufferReactorNettyCodec<P> - Class in org.springframework.messaging.tcp.reactor
-
Convenient base class for
ReactorNettyCodec
implementations that need to work with NIOByteBuffers
. - AbstractNioBufferReactorNettyCodec() - Constructor for class org.springframework.messaging.tcp.reactor.AbstractNioBufferReactorNettyCodec
- AbstractSubscribableChannel - Class in org.springframework.messaging.support
-
Abstract base class for
SubscribableChannel
implementations. - AbstractSubscribableChannel() - Constructor for class org.springframework.messaging.support.AbstractSubscribableChannel
- AbstractSubscriptionRegistry - Class in org.springframework.messaging.simp.broker
-
Abstract base class for implementations of
SubscriptionRegistry
that looks up information in messages but delegates to abstract methods for the actual storage and retrieval. - AbstractSubscriptionRegistry() - Constructor for class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- ACCEPT_VERSION - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- ACK - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- ACK - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- acknowledge(String, boolean) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- acknowledge(String, boolean) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Send an acknowledgement whether a message was consumed or not resulting in an ACK or NACK frame respectively.
- acknowledge(StompHeaders, boolean) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- acknowledge(StompHeaders, boolean) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
An overloaded version of
StompSession.acknowledge(String, boolean)
with fullStompHeaders
instead of just amessageId
. - add(String, String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Add the given, single header value under the given name.
- addAll(String, List<? extends String>) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- addAll(MultiValueMap<String, String>) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- addArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- addCustomHandler(HandlerMethodReturnValueHandler...) - Method in class org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer
-
Configure custom return value handlers for handler methods.
- addCustomResolver(HandlerMethodArgumentResolver...) - Method in class org.springframework.messaging.handler.invocation.reactive.ArgumentResolverConfigurer
-
Configure resolvers for custom handler method arguments.
- addHandler(HandlerMethodReturnValueHandler) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandler
. - addHandler(HandlerMethodReturnValueHandler) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandler
. - addHandlers(List<? extends HandlerMethodReturnValueHandler>) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandlers
. - addHandlers(List<? extends HandlerMethodReturnValueHandler>) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
-
Add the given
HandlerMethodReturnValueHandlers
. - addInterceptor(int, ChannelInterceptor) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- addInterceptor(int, ChannelInterceptor) - Method in class org.springframework.messaging.support.ExecutorSubscribableChannel
- addInterceptor(int, ChannelInterceptor) - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Add a channel interceptor at the specified index.
- addInterceptor(ChannelInterceptor) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- addInterceptor(ChannelInterceptor) - Method in class org.springframework.messaging.support.ExecutorSubscribableChannel
- addInterceptor(ChannelInterceptor) - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Add a channel interceptor to the end of the list.
- addMetadata(Object) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Add a metadata entry.
- addMimeType(MimeType) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Set the mime type for a metadata entry.
- addNativeHeader(String, String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Add the specified native header value to existing values.
- addNativeHeaders(MultiValueMap<String, String>) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Add the specified native headers to existing values.
- addReceiptLostTask(Runnable) - Method in interface org.springframework.messaging.simp.stomp.StompSession.Receiptable
-
Task to invoke when a receipt is not received in the configured time.
- addReceiptTask(Runnable) - Method in interface org.springframework.messaging.simp.stomp.StompSession.Receiptable
-
Task to invoke when a receipt is received.
- addReceiptTask(Consumer<StompHeaders>) - Method in interface org.springframework.messaging.simp.stomp.StompSession.Receiptable
-
Variant of
StompSession.Receiptable.addReceiptTask(Runnable)
with aConsumer
of the headers from theRECEIPT
frame. - addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolver
. - addResolver(HandlerMethodArgumentResolver) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolver
. - addResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addResolvers(List<? extends HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addResolvers(HandlerMethodArgumentResolver...) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addResolvers(HandlerMethodArgumentResolver...) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Add the given
HandlerMethodArgumentResolvers
. - addReturnValueHandlers(List<HandlerMethodReturnValueHandler>) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- addRouteVariable(Object) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Add a route variable.
- addSubscriptionInternal(String, String, String, Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- addSubscriptionInternal(String, String, String, Message<?>) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
- addSupportedMimeTypes(MimeType...) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Allows subclasses to add more supported mime types.
- afterConnected(StompSession, StompHeaders) - Method in interface org.springframework.messaging.simp.stomp.StompSessionHandler
-
Invoked when the session is ready to use, i.e.
- afterConnected(StompSession, StompHeaders) - Method in class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
-
This implementation is empty.
- afterConnected(TcpConnection<byte[]>) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- afterConnected(TcpConnection<P>) - Method in interface org.springframework.messaging.tcp.TcpConnectionHandler
-
Invoked after a connection is successfully established.
- afterConnectFailure(Throwable) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- afterConnectFailure(Throwable) - Method in interface org.springframework.messaging.tcp.TcpConnectionHandler
-
Invoked on failure to connect.
- afterConnectionClosed() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- afterConnectionClosed() - Method in interface org.springframework.messaging.tcp.TcpConnectionHandler
-
Invoked after the connection is closed.
- afterMessageHandled(Message<?>, MessageChannel, MessageHandler, Exception) - Method in interface org.springframework.messaging.support.ExecutorChannelInterceptor
-
Invoked inside the
Runnable
submitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e. - afterPropertiesSet() - Method in class org.springframework.messaging.core.CachingDestinationResolverProxy
- afterPropertiesSet() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- afterPropertiesSet() - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
- afterPropertiesSet() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- afterPropertiesSet() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- afterPropertiesSet() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- afterReceiveCompletion(Message<?>, MessageChannel, Exception) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.
- afterSendCompletion(Message<?>, MessageChannel, boolean, Exception) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.
- AnnotationExceptionHandlerMethodResolver - Class in org.springframework.messaging.handler.annotation.support
-
A subclass of
AbstractExceptionHandlerMethodResolver
that looks forMessageExceptionHandler
-annotated methods in a given class. - AnnotationExceptionHandlerMethodResolver(Class<?>) - Constructor for class org.springframework.messaging.handler.annotation.support.AnnotationExceptionHandlerMethodResolver
-
A constructor that finds
MessageExceptionHandler
methods in the given type. - apply(Consumer<RSocketRequester.Builder>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Configure this builder through a
Consumer
. - applyPostReceive(Message<?>, MessageChannel) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- applyPostSend(Message<?>, MessageChannel, boolean) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- applyPreReceive(MessageChannel) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- applyPreSend(Message<?>, MessageChannel) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- ArgumentResolverConfigurer - Class in org.springframework.messaging.handler.invocation.reactive
-
Assist with configuration for handler method argument resolvers.
- ArgumentResolverConfigurer() - Constructor for class org.springframework.messaging.handler.invocation.reactive.ArgumentResolverConfigurer
- assertTargetBean(Method, Object, Object[]) - Method in class org.springframework.messaging.handler.HandlerMethod
-
Assert that the target bean class is an instance of the class where the given method is declared.
- AsyncHandlerMethodReturnValueHandler - Interface in org.springframework.messaging.handler.invocation
-
An extension of
HandlerMethodReturnValueHandler
for handling async, Future-like return value types that support success and error callbacks.
B
- BeanFactoryMessageChannelDestinationResolver - Class in org.springframework.messaging.core
-
An implementation of
DestinationResolver
that interprets a destination name as the bean name of aMessageChannel
and looks up the bean in the configuredBeanFactory
. - BeanFactoryMessageChannelDestinationResolver() - Constructor for class org.springframework.messaging.core.BeanFactoryMessageChannelDestinationResolver
-
A default constructor that can be used when the resolver itself is configured as a Spring bean and will have the
BeanFactory
injected as a result of ing having implementedBeanFactoryAware
. - BeanFactoryMessageChannelDestinationResolver(BeanFactory) - Constructor for class org.springframework.messaging.core.BeanFactoryMessageChannelDestinationResolver
-
A constructor that accepts a
BeanFactory
useful if instantiating this resolver manually rather than having it defined as a Spring-managed bean. - beforeHandle(Message<?>, MessageChannel, MessageHandler) - Method in interface org.springframework.messaging.support.ExecutorChannelInterceptor
-
Invoked inside the
Runnable
submitted to the Executor just before calling the target MessageHandler to handle the message. - BEGIN - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- blockTimeout(Duration) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Configure how long to block for the response of an RSocket service method with a synchronous (blocking) method signature.
- broadcast() - Element in annotation interface org.springframework.messaging.simp.annotation.SendToUser
-
Whether messages should be sent to all sessions associated with the user or only to the session of the input message being handled.
- BrokerAvailabilityEvent - Class in org.springframework.messaging.simp.broker
-
Event raised when a broker's availability changes.
- BrokerAvailabilityEvent(boolean, Object) - Constructor for class org.springframework.messaging.simp.broker.BrokerAvailabilityEvent
-
Creates a new
BrokerAvailabilityEvent
. - brokerChannel(AbstractSubscribableChannel, AbstractSubscribableChannel, TaskExecutor) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- brokerChannelExecutor(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- brokerMessageConverter() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- brokerMessagingTemplate(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, CompositeMessageConverter) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- BufferingStompDecoder - Class in org.springframework.messaging.simp.stomp
-
An extension of
StompDecoder
that buffers content remaining in the input ByteBuffer after the parent class has read all (complete) STOMP frames from it. - BufferingStompDecoder(StompDecoder, int) - Constructor for class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Create a new
BufferingStompDecoder
wrapping the givenStompDecoder
. - build() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Build the
RSocketStrategies
instance. - build() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Build the
RSocketRequestValues
instance. - build() - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Build the
RSocketServiceProxyFactory
instance. - build() - Method in class org.springframework.messaging.support.MessageBuilder
- builder() - Static method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Obtain a builder to create a client
RSocketRequester
by connecting to an RSocket server. - builder() - Static method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return a builder to prepare a new
RSocketStrategies
instance. - builder() - Static method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory
-
Return an
RSocketServiceProxyFactory
builder. - builder(String) - Static method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
- builder(RSocketRequester) - Static method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory
-
Return an
RSocketServiceProxyFactory
builder, initialized with the given client. - ByteArrayMessageConverter - Class in org.springframework.messaging.converter
-
A
MessageConverter
that supports MIME type "application/octet-stream" with the payload converted to and from a byte[]. - ByteArrayMessageConverter() - Constructor for class org.springframework.messaging.converter.ByteArrayMessageConverter
C
- CachingDestinationResolverProxy<D> - Class in org.springframework.messaging.core
-
DestinationResolver
implementation that proxies a target DestinationResolver, caching itsCachingDestinationResolverProxy.resolveDestination(java.lang.String)
results. - CachingDestinationResolverProxy() - Constructor for class org.springframework.messaging.core.CachingDestinationResolverProxy
-
Create a new CachingDestinationResolverProxy, setting the target DestinationResolver through the
CachingDestinationResolverProxy.setTargetDestinationResolver(org.springframework.messaging.core.DestinationResolver<D>)
bean property. - CachingDestinationResolverProxy(DestinationResolver<D>) - Constructor for class org.springframework.messaging.core.CachingDestinationResolverProxy
-
Create a new CachingDestinationResolverProxy using the given target DestinationResolver to actually resolve destinations.
- canConvertFrom(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- canConvertFrom(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
- canConvertFrom(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
- canConvertTo(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- canConvertTo(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
- canConvertTo(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
- canConvertTo(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.ProtobufMessageConverter
- ChannelInterceptor - Interface in org.springframework.messaging.support
-
Interface for interceptors that are able to view and/or modify the
Messages
being sent-to and/or received-from aMessageChannel
. - ChannelInterceptorChain() - Constructor for class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- ChannelRegistration - Class in org.springframework.messaging.simp.config
-
A registration class for customizing the configuration for a
MessageChannel
. - ChannelRegistration() - Constructor for class org.springframework.messaging.simp.config.ChannelRegistration
- checkDestination(String, String) - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
- checkDestinationPrefix(String) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Whether a message with the given destination should be processed.
- clear() - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Clear the list of configured resolvers and the resolver cache.
- clear() - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Clear the list of configured handlers.
- clear() - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Clear the list of configured resolvers and the resolver cache.
- clear() - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
-
Clear the list of configured handlers.
- clear() - Method in class org.springframework.messaging.MessageHeaders
-
Since MessageHeaders are immutable, the call to this method will result in
UnsupportedOperationException
. - clear() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- clientInboundChannel(TaskExecutor) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- clientInboundChannelExecutor() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- clientOutboundChannel(TaskExecutor) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- clientOutboundChannelExecutor() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- close() - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- close() - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- close() - Method in interface org.springframework.messaging.tcp.TcpConnection
-
Close the connection.
- combine(CompositeMessageCondition) - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- combine(DestinationPatternsMessageCondition) - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Returns a new instance with URL patterns from the current instance ("this") and the "other" instance as follows: If there are patterns in both instances, combine the patterns in "this" with the patterns in "other" using
PathMatcher.combine(String, String)
. - combine(RSocketFrameTypeMessageCondition) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- combine(SimpMessageMappingInfo) - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- combine(SimpMessageTypeMessageCondition) - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- combine(T) - Method in interface org.springframework.messaging.handler.MessageCondition
-
Define the rules for combining this condition with another.
- COMMIT - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- compareTo(CompositeMessageCondition, Message<?>) - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- compareTo(DestinationPatternsMessageCondition, Message<?>) - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Compare the two conditions based on the destination patterns they contain.
- compareTo(RSocketFrameTypeMessageCondition, Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- compareTo(SimpMessageMappingInfo, Message<?>) - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- compareTo(SimpMessageTypeMessageCondition, Message<?>) - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- compareTo(T, Message<?>) - Method in interface org.springframework.messaging.handler.MessageCondition
-
Compare this condition to another in the context of a specific message.
- CompletableFutureReturnValueHandler - Class in org.springframework.messaging.handler.invocation
-
Support for
CompletableFuture
(and as of 4.3.7 alsoCompletionStage
) as a return value type. - CompletableFutureReturnValueHandler() - Constructor for class org.springframework.messaging.handler.invocation.CompletableFutureReturnValueHandler
- CompositeMessageCondition - Class in org.springframework.messaging.handler
-
Composite
MessageCondition
that delegates to other message conditions. - CompositeMessageCondition(MessageCondition<?>...) - Constructor for class org.springframework.messaging.handler.CompositeMessageCondition
- CompositeMessageConverter - Class in org.springframework.messaging.converter
-
A
MessageConverter
that delegates to a list of registered converters to be invoked until one of them returns a non-null result. - CompositeMessageConverter(Collection<MessageConverter>) - Constructor for class org.springframework.messaging.converter.CompositeMessageConverter
-
Create an instance with the given converters.
- configure(RSocketConnector) - Method in interface org.springframework.messaging.rsocket.RSocketConnectorConfigurer
-
Apply configuration to the given
RSocketConnector
. - configureBrokerChannel() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Customize the channel used to send messages from the application to the message broker.
- configureClientInboundChannel(ChannelRegistration) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
A hook for subclasses to customize the message channel for inbound messages from WebSocket clients.
- configureClientOutboundChannel(ChannelRegistration) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
A hook for subclasses to customize the message channel for messages from the application or message broker to WebSocket clients.
- configureInterceptor(MessageChannel, boolean) - Static method in class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
-
Install or remove an
ExecutorChannelInterceptor
that invokes a completion task, if found in the headers of the message. - configureMessageBroker(MessageBrokerRegistry) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
A hook for subclasses to customize message broker configuration through the provided
MessageBrokerRegistry
instance. - configureMessageConverters(List<MessageConverter>) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Override this method to add custom message converters.
- connect(ClientTransport) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Deprecated.
- connect(StompHeaders, StompSessionHandler) - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Deprecated.as of 6.0, in favor of
ReactorNettyTcpStompClient.connectAsync(StompHeaders, StompSessionHandler)
- connect(StompSessionHandler) - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Deprecated.as of 6.0, in favor of
ReactorNettyTcpStompClient.connectAsync(StompSessionHandler)
- connect(TcpConnectionHandler<P>) - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Deprecated.as of 6.0, in favor of
TcpOperations.connectAsync(TcpConnectionHandler)
- connect(TcpConnectionHandler<P>, ReconnectStrategy) - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Deprecated.as of 6.0, in favor of
TcpOperations.connectAsync(TcpConnectionHandler, ReconnectStrategy)
- CONNECT - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- CONNECT - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- CONNECT_ACK - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- CONNECT_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Match connection-level frames "SETUP" or "METADATA_PUSH".
- CONNECT_MESSAGE_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- connectAsync(StompHeaders, StompSessionHandler) - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
An overloaded version of
ReactorNettyTcpStompClient.connectAsync(StompSessionHandler)
that accepts headers to use for the STOMP CONNECT frame. - connectAsync(StompSessionHandler) - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Connect and notify the given
StompSessionHandler
when connected on the STOMP level. - connectAsync(TcpConnectionHandler<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
- connectAsync(TcpConnectionHandler<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
- connectAsync(TcpConnectionHandler<P>) - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Open a new connection.
- connectAsync(TcpConnectionHandler<P>, ReconnectStrategy) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
- connectAsync(TcpConnectionHandler<P>, ReconnectStrategy) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
- connectAsync(TcpConnectionHandler<P>, ReconnectStrategy) - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Open a new connection and a strategy for reconnecting if the connection fails.
- CONNECTED - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- ConnectionHandlingStompSession - Interface in org.springframework.messaging.simp.stomp
-
A
StompSession
that implementsTcpConnectionHandler
in order to send and receive messages. - ConnectionLostException - Exception in org.springframework.messaging.simp.stomp
-
Raised when the connection for a STOMP session is lost rather than closed.
- ConnectionLostException(String) - Constructor for exception org.springframework.messaging.simp.stomp.ConnectionLostException
- ConnectionLostException(String, Throwable) - Constructor for exception org.springframework.messaging.simp.stomp.ConnectionLostException
- ConnectMapping - Annotation Interface in org.springframework.messaging.rsocket.annotation
-
Annotation to map the initial
ConnectionSetupPayload
and subsequent metadata pushes onto a handler method. - connectTcp(String, int) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Deprecated.as of 5.3 in favor of
RSocketRequester.Builder.tcp(String, int)
- connectWebSocket(URI) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Deprecated.as of 5.3 in favor of
RSocketRequester.Builder.websocket(URI)
- containsKey(Object) - Method in class org.springframework.messaging.MessageHeaders
- containsKey(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- containsNativeHeader(String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Whether the native header map contains the give header name.
- containsValue(Object) - Method in class org.springframework.messaging.MessageHeaders
- containsValue(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- CONTENT_LENGTH - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- CONTENT_TYPE - Static variable in class org.springframework.messaging.MessageHeaders
-
The key for the message content type.
- CONTENT_TYPE - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- ContentTypeResolver - Interface in org.springframework.messaging.converter
-
Resolve the content type for a message.
- ContinuationHandlerMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
No-op resolver for method arguments of type
Continuation
. - ContinuationHandlerMethodArgumentResolver() - Constructor for class org.springframework.messaging.handler.annotation.reactive.ContinuationHandlerMethodArgumentResolver
- CONVERSION_HINT_HEADER - Static variable in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Name of the header that can be set to provide further information (e.g.
- convertAndSend(D, Object) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(D, Object) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message and send it to the given destination. - convertAndSend(D, Object, Map<String, Object>) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(D, Object, Map<String, Object>) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers and send it to the given destination. - convertAndSend(D, Object, Map<String, Object>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(D, Object, Map<String, Object>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the given destination. - convertAndSend(D, Object, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(D, Object, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message, apply the given post processor, and send the resulting message to the given destination. - convertAndSend(Object) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(Object) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message and send it to a default destination. - convertAndSend(Object, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- convertAndSend(Object, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message, apply the given post processor, and send the resulting message to a default destination. - convertAndSend(String, T) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertAndSend(String, T) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations
-
Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using a
MessageConverter
, wrap it as a message and send it to the resolved destination. - convertAndSend(String, T, Map<String, Object>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertAndSend(String, T, Map<String, Object>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations
-
Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers and send it to the resolved destination. - convertAndSend(String, T, Map<String, Object>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertAndSend(String, T, Map<String, Object>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations
-
Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers, apply the given post processor, and send the resulting message to the resolved destination. - convertAndSend(String, T, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertAndSend(String, T, MessagePostProcessor) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations
-
Resolve the given destination name to a destination, convert the payload Object to serialized form, possibly using a
MessageConverter
, wrap it as a message, apply the given post processor, and send the resulting message to the resolved destination. - convertAndSendToUser(String, String, Object) - Method in interface org.springframework.messaging.simp.SimpMessageSendingOperations
-
Send a message to the given user.
- convertAndSendToUser(String, String, Object) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
- convertAndSendToUser(String, String, Object, Map<String, Object>) - Method in interface org.springframework.messaging.simp.SimpMessageSendingOperations
-
Send a message to the given user.
- convertAndSendToUser(String, String, Object, Map<String, Object>) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
- convertAndSendToUser(String, String, Object, Map<String, Object>, MessagePostProcessor) - Method in interface org.springframework.messaging.simp.SimpMessageSendingOperations
-
Send a message to the given user.
- convertAndSendToUser(String, String, Object, Map<String, Object>, MessagePostProcessor) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
- convertAndSendToUser(String, String, Object, MessagePostProcessor) - Method in interface org.springframework.messaging.simp.SimpMessageSendingOperations
-
Send a message to the given user.
- convertAndSendToUser(String, String, Object, MessagePostProcessor) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Convert the message payload from serialized form to an Object.
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.ByteArrayMessageConverter
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.ProtobufMessageConverter
- convertFromInternal(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.StringMessageConverter
- convertSendAndReceive(D, Object, Class<T>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(D, Object, Class<T>) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, send it as aMessage
to the given destination, receive the reply and convert its body of the specified target class. - convertSendAndReceive(D, Object, Class<T>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(D, Object, Class<T>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, apply the given post processor and send the resultingMessage
to the given destination, receive the reply and convert its body of the given target class. - convertSendAndReceive(D, Object, Map<String, Object>, Class<T>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(D, Object, Map<String, Object>, Class<T>) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, send it as aMessage
with the given headers, to the specified destination, receive the reply and convert its body of the specified target class. - convertSendAndReceive(D, Object, Map<String, Object>, Class<T>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(D, Object, Map<String, Object>, Class<T>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers, apply the given post processor and send the resultingMessage
to the specified destination, receive the reply and convert its body of the given target class. - convertSendAndReceive(Object, Class<T>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(Object, Class<T>) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, send it as aMessage
to a default destination, receive the reply and convert its body of the specified target class. - convertSendAndReceive(Object, Class<T>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- convertSendAndReceive(Object, Class<T>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Convert the given request Object to serialized form, possibly using a
MessageConverter
, apply the given post processor and send the resultingMessage
to a default destination, receive the reply and convert its body of the given target class. - convertSendAndReceive(String, Object, Class<T>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertSendAndReceive(String, Object, Class<T>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageRequestReplyOperations
-
Resolve the given destination name, convert the payload request Object to serialized form, possibly using a
MessageConverter
, wrap it as a message and send it to the resolved destination, receive a reply and convert its body to the specified target class. - convertSendAndReceive(String, Object, Class<T>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertSendAndReceive(String, Object, Class<T>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageRequestReplyOperations
-
Resolve the given destination name, convert the payload request Object to serialized form, possibly using a
MessageConverter
, wrap it as a message, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class. - convertSendAndReceive(String, Object, Map<String, Object>, Class<T>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertSendAndReceive(String, Object, Map<String, Object>, Class<T>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageRequestReplyOperations
-
Resolve the given destination name, convert the payload request Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers and send it to the resolved destination, receive a reply and convert its body to the specified target class. - convertSendAndReceive(String, Object, Map<String, Object>, Class<T>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- convertSendAndReceive(String, Object, Map<String, Object>, Class<T>, MessagePostProcessor) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageRequestReplyOperations
-
Resolve the given destination name, convert the payload request Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers, apply the given post process, and send the resulting message to the resolved destination, then receive a reply and convert its body to the specified target class. - convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Convert the payload object to serialized form.
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.ByteArrayMessageConverter
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.ProtobufMessageConverter
- convertToInternal(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.StringMessageConverter
- copyHeaders(Map<String, ?>) - Method in class org.springframework.messaging.support.MessageBuilder
-
Copy the name-value pairs from the provided Map.
- copyHeaders(Map<String, ?>) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Copy the name-value pairs from the provided Map.
- copyHeaders(Map<String, ?>) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
- copyHeadersIfAbsent(Map<String, ?>) - Method in class org.springframework.messaging.support.MessageBuilder
-
Copy the name-value pairs from the provided Map.
- copyHeadersIfAbsent(Map<String, ?>) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Copy the name-value pairs from the provided Map.
- copyHeadersIfAbsent(Map<String, ?>) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
- corePoolSize(int) - Method in class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Set the core pool size of the ThreadPoolExecutor.
- couldBePayload(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- create() - Static method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Create an
RSocketStrategies
instance with default settings. - create() - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Create an instance with
SimpMessageType
MESSAGE
. - create(SimpMessageType) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Create an instance with the given
SimpMessageType
. - create(StompCommand) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Create an instance for the given STOMP command.
- create(StompCommand, Map<String, List<String>>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Create an instance for the given STOMP command and headers.
- createAccessor(Message<?>) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- createAccessor(Message<?>) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- createAccessor(Message<?>) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Build a 'nested' accessor for the given message.
- createAnnotationMethodMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, SimpMessagingTemplate) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Protected method for plugging in a custom subclass of
SimpAnnotationMethodMessageHandler
. - createClient(Class<S>) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory
-
Return a proxy that implements the given RSocket service interface to perform RSocket requests and retrieve responses through the configured
RSocketRequester
. - createExceptionHandlerMethodResolverFor(Class<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- createExceptionHandlerMethodResolverFor(Class<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- createExceptionMethodResolverFor(Class<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- createExceptionMethodResolverFor(Class<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Create a concrete instance of
AbstractExceptionHandlerMethodResolver
that finds exception handling methods based on some criteria, e.g. - createForHeartbeat() - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Create headers for a heartbeat.
- createHandlerMethod(Object, Method) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Create a HandlerMethod instance from an Object handler that is either a handler instance or a String-based bean name.
- createInvocableHandlerMethod(Object, Method) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
- createInvocableHandlerMethod(Object, Method) - Method in interface org.springframework.messaging.handler.annotation.support.MessageHandlerMethodFactory
-
Create the
InvocableHandlerMethod
that is able to process the specified method endpoint. - createJacksonConverter() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- createLocalUserRegistry(Integer) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Create the user registry that provides access to local users.
- createMessage(T, MessageHeaders) - Static method in class org.springframework.messaging.support.MessageBuilder
-
A shortcut factory method for creating a message with the given payload and
MessageHeaders
. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver
-
Create the
AbstractNamedValueMethodArgumentResolver.NamedValueInfo
object for the given method parameter. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.HeaderMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
-
Create the
AbstractNamedValueMethodArgumentResolver.NamedValueInfo
object for the given method parameter. - createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
- createNamedValueInfo(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.HeaderMethodArgumentResolver
- createPayload(DataBuffer) - Static method in class org.springframework.messaging.rsocket.PayloadUtils
-
Create a Payload with data only.
- createPayload(DataBuffer, DataBuffer) - Static method in class org.springframework.messaging.rsocket.PayloadUtils
-
Create a Payload from the given metadata and data.
- createSession(StompHeaders, StompSessionHandler) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Factory method for create and configure a new session.
- createWithResolvedBean() - Method in class org.springframework.messaging.handler.HandlerMethod
-
If the provided instance contains a bean name rather than an object instance, the bean name is resolved before a
HandlerMethod
is created and returned. - currentAttributes() - Static method in class org.springframework.messaging.simp.SimpAttributesContextHolder
-
Return the SimpAttributes currently bound to the thread or raise an
IllegalStateException
if none are bound. - customArgumentResolver(RSocketServiceArgumentResolver) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Register a custom argument resolver, invoked ahead of default resolvers.
D
- data(Object) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RequestSpec
-
Provide payload data for the request.
- data(Object, Class<?>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RequestSpec
-
Variant of
RSocketRequester.RequestSpec.data(Object)
that also accepts a hint for the types of values that will be produced. - data(Object, ParameterizedTypeReference<?>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RequestSpec
-
Variant of
RSocketRequester.RequestSpec.data(Object, Class)
for when the type hint has to have a generic type. - DATA_BUFFER_FACTORY_HEADER - Static variable in interface org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandler
-
Header containing a DataBufferFactory for use in return value handling.
- dataBufferFactory() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
dataBufferFactory
. - dataBufferFactory(DataBufferFactory) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Configure the DataBufferFactory to use for allocating buffers when preparing requests or creating responses.
- dataMimeType() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Return the data
MimeType
selected for the underlying RSocket at connection time. - dataMimeType(MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Configure the payload data MimeType to specify on the
SETUP
frame that applies to the whole connection. - decode(ByteBuf) - Method in class org.springframework.messaging.tcp.reactor.AbstractNioBufferReactorNettyCodec
- decode(ByteBuf) - Method in interface org.springframework.messaging.tcp.reactor.ReactorNettyCodec
-
Decode the input
ByteBuf
into one or moreMessages
. - decode(ByteBuffer) - Method in class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Decodes one or more STOMP frames from the given
ByteBuffer
into a list ofMessages
. - decode(ByteBuffer) - Method in class org.springframework.messaging.simp.stomp.StompDecoder
-
Decodes one or more STOMP frames from the given
ByteBuffer
into a list ofMessages
. - decode(ByteBuffer) - Method in class org.springframework.messaging.simp.stomp.StompTcpMessageCodec
- decode(ByteBuffer) - Method in interface org.springframework.messaging.tcp.reactor.TcpMessageCodec
-
Decode the input
ByteBuffer
into one or moreMessages
. - decode(ByteBuffer, MultiValueMap<String, String>) - Method in class org.springframework.messaging.simp.stomp.StompDecoder
-
Decodes one or more STOMP frames from the given
buffer
and returns a list ofMessages
. - decodeInternal(ByteBuffer) - Method in class org.springframework.messaging.simp.stomp.StompReactorNettyCodec
- decodeInternal(ByteBuffer) - Method in class org.springframework.messaging.tcp.reactor.AbstractNioBufferReactorNettyCodec
- decoder(Decoder<?>...) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Append to the list of decoders to use for de-serializing Objects from the data or metadata of a
Payload
. - decoder(ResolvableType, MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Find a compatible Decoder for the given element type.
- decoders() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
decoders
. - decoders(Consumer<List<Decoder<?>>>) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Apply the consumer to the list of configured decoders, immediately.
- DEFAULT_CACHE_LIMIT - Static variable in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Default maximum number of entries for the destination cache: 1024.
- DEFAULT_CHARSET - Static variable in class org.springframework.messaging.converter.ProtobufMessageConverter
-
The default charset used by the converter.
- DEFAULT_CHARSET - Static variable in class org.springframework.messaging.support.MessageHeaderAccessor
-
The default charset used for headers.
- DEFAULT_NONE - Static variable in interface org.springframework.messaging.handler.annotation.ValueConstants
-
Constant defining a value for no default - as a replacement for
null
which we cannot use in annotation attributes. - DEFAULT_RECEIVE_TIMEOUT_HEADER - Static variable in class org.springframework.messaging.core.GenericMessagingTemplate
-
The default header key used for a receive timeout.
- DEFAULT_SEND_TIMEOUT_HEADER - Static variable in class org.springframework.messaging.core.GenericMessagingTemplate
-
The default header key used for a send timeout.
- DefaultContentTypeResolver - Class in org.springframework.messaging.converter
-
A default
ContentTypeResolver
that checks theMessageHeaders.CONTENT_TYPE
header or falls back to a default value. - DefaultContentTypeResolver() - Constructor for class org.springframework.messaging.converter.DefaultContentTypeResolver
- defaultLogger - Static variable in class org.springframework.messaging.handler.HandlerMethod
-
Public for wrapping with fallback logger.
- defaultLogger - Static variable in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Public for wrapping with fallback logger.
- DefaultMessageHandlerMethodFactory - Class in org.springframework.messaging.handler.annotation.support
-
The default
MessageHandlerMethodFactory
implementation creating anInvocableHandlerMethod
with the necessaryHandlerMethodArgumentResolver
instances to detect and process most of the use cases defined byMessageMapping
. - DefaultMessageHandlerMethodFactory() - Constructor for class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
- DefaultMetadataExtractor - Class in org.springframework.messaging.rsocket
-
Default
MetadataExtractor
implementation that relies onDecoder
s to deserialize the content of metadata entries. - DefaultMetadataExtractor(List<Decoder<?>>) - Constructor for class org.springframework.messaging.rsocket.DefaultMetadataExtractor
-
Constructor with list of decoders for de-serializing metadata entries.
- DefaultMetadataExtractor(Decoder<?>...) - Constructor for class org.springframework.messaging.rsocket.DefaultMetadataExtractor
-
Constructor with decoders for de-serializing metadata entries.
- DefaultStompSession - Class in org.springframework.messaging.simp.stomp
-
Default implementation of
ConnectionHandlingStompSession
. - DefaultStompSession(StompSessionHandler, StompHeaders) - Constructor for class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Create a new session.
- DefaultSubscriptionRegistry - Class in org.springframework.messaging.simp.broker
-
Implementation of
SubscriptionRegistry
that stores subscriptions in memory and uses aPathMatcher
for matching destinations. - DefaultSubscriptionRegistry() - Constructor for class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
- DefaultUserDestinationResolver - Class in org.springframework.messaging.simp.user
-
A default implementation of
UserDestinationResolver
that relies on aSimpUserRegistry
to find active sessions for a user. - DefaultUserDestinationResolver(SimpUserRegistry) - Constructor for class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
Create an instance that will access user session id information through the provided registry.
- defaultValue() - Element in annotation interface org.springframework.messaging.handler.annotation.Header
-
The default value to use as a fallback.
- DESTINATION - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- DESTINATION_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- DESTINATION_TEMPLATE_VARIABLES_HEADER - Static variable in class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
-
The name of the header used to for template variables.
- DESTINATION_TEMPLATE_VARIABLES_HEADER - Static variable in class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
-
The name of the header used to for template variables.
- DestinationPatternsMessageCondition - Class in org.springframework.messaging.handler
-
MessageCondition
to match the destination header of a Message against one or more patterns through aRouteMatcher
. - DestinationPatternsMessageCondition(String...) - Constructor for class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Constructor with patterns only.
- DestinationPatternsMessageCondition(String[], PathMatcher) - Constructor for class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Constructor with patterns and a
PathMatcher
instance. - DestinationPatternsMessageCondition(String[], RouteMatcher) - Constructor for class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Constructor with patterns and a
RouteMatcher
instance. - DestinationResolutionException - Exception in org.springframework.messaging.core
-
Thrown by a
DestinationResolver
when it cannot resolve a destination. - DestinationResolutionException(String) - Constructor for exception org.springframework.messaging.core.DestinationResolutionException
- DestinationResolutionException(String, Throwable) - Constructor for exception org.springframework.messaging.core.DestinationResolutionException
- DestinationResolver<D> - Interface in org.springframework.messaging.core
-
Strategy for resolving a String destination name to an actual destination of type
<D>
. - DestinationResolvingMessageReceivingOperations<D> - Interface in org.springframework.messaging.core
-
Extends
MessageReceivingOperations
and adds operations for receiving messages from a destination specified as a (resolvable) String name. - DestinationResolvingMessageRequestReplyOperations<D> - Interface in org.springframework.messaging.core
-
Extends
MessageRequestReplyOperations
and adds operations for sending and receiving messages to and from a destination specified as a (resolvable) String name. - DestinationResolvingMessageSendingOperations<D> - Interface in org.springframework.messaging.core
-
Extends
MessageSendingOperations
and adds operations for sending messages to a destination specified as a (resolvable) String name. - destinations() - Element in annotation interface org.springframework.messaging.simp.annotation.SendToUser
-
One or more destinations to send a message to.
- DestinationUserNameProvider - Interface in org.springframework.messaging.simp.user
- DestinationVariable - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation that indicates a method parameter should be bound to a template variable in a destination template string.
- DestinationVariableArgumentResolver - Class in org.springframework.messaging.rsocket.service
-
RSocketServiceArgumentResolver
for a@DestinationVariable
annotated argument. - DestinationVariableArgumentResolver() - Constructor for class org.springframework.messaging.rsocket.service.DestinationVariableArgumentResolver
- DestinationVariableMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
Resolve for
@DestinationVariable
method parameters. - DestinationVariableMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
Resolve for
@DestinationVariable
method parameters. - DestinationVariableMethodArgumentResolver(ConversionService) - Constructor for class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
- DestinationVariableMethodArgumentResolver(ConversionService) - Constructor for class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
- DESTRUCTION_CALLBACK_NAME_PREFIX - Static variable in class org.springframework.messaging.simp.SimpAttributes
-
Prefix for the name of session attributes used to store destruction callbacks.
- detectHandlerMethods(Object) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Detect if the given handler has any methods that can handle messages and if so register it with the extracted mapping information.
- detectHandlerMethods(Object) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Detect if the given handler has any methods that can handle messages and if so register it with the extracted mapping information.
- disconnect() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- disconnect() - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Disconnect the session by sending a DISCONNECT frame.
- disconnect(StompHeaders) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- disconnect(StompHeaders) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Variant of
StompSession.disconnect()
with headers. - DISCONNECT - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- DISCONNECT - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- DISCONNECT_ACK - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- DISCONNECT_MESSAGE_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- dispose() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Shortcut method that delegates to the same on the underlying
RSocketRequester.rsocketClient()
in order to close the connection from the underlying transport and notify subscribers. - doConvert(Object, Map<String, Object>, MessagePostProcessor) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Convert the given Object to serialized form, possibly using a
MessageConverter
, wrap it as a message with the given headers and apply the given post processor. - doConvert(Message<?>, Class<T>) - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
-
Convert from the given message to the given target class.
- doInvoke(Object...) - Method in class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Invoke the handler method with the given argument values.
- doReceive(D) - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
-
Actually receive a message from the given destination.
- doReceive(MessageChannel) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
- doReceive(MessageChannel, long) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
- doSend(D, Message<?>) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- doSend(String, Message<?>) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
- doSend(MessageChannel, Message<?>) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
- doSend(MessageChannel, Message<?>, long) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
- doSendAndReceive(D, Message<?>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- doSendAndReceive(MessageChannel, Message<?>) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
E
- embeddedValueResolver(StringValueResolver) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Set the
StringValueResolver
to use for resolving placeholders and expressions embedded inRSocketExchange.value()
. - EMPTY_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Empty condition that does not match to any RSocket frames (e.g.
- EMPTY_PAYLOAD - Static variable in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
An empty payload.
- enableSimpleBroker(String...) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Enable a simple message broker and configure one or more prefixes to filter destinations targeting the broker (e.g.
- enableStompBrokerRelay(String...) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Enable a STOMP broker relay and configure the destination prefixes supported by the message broker.
- encode(Map<String, Object>, byte[]) - Method in class org.springframework.messaging.simp.stomp.StompEncoder
-
Encodes the given payload and headers into a
byte[]
. - encode(Message<byte[]>) - Method in class org.springframework.messaging.simp.stomp.StompEncoder
-
Encodes the given STOMP
message
into abyte[]
. - encode(Message<byte[]>) - Method in class org.springframework.messaging.simp.stomp.StompTcpMessageCodec
- encode(Message<P>) - Method in interface org.springframework.messaging.tcp.reactor.TcpMessageCodec
-
Encode the given
Message
to the outputByteBuffer
. - encode(Message<P>, ByteBuf) - Method in class org.springframework.messaging.tcp.reactor.AbstractNioBufferReactorNettyCodec
- encode(Message<P>, ByteBuf) - Method in interface org.springframework.messaging.tcp.reactor.ReactorNettyCodec
-
Encode the given
Message
to the outputByteBuf
. - encodeInternal(Message<byte[]>) - Method in class org.springframework.messaging.simp.stomp.StompReactorNettyCodec
- encodeInternal(Message<P>) - Method in class org.springframework.messaging.tcp.reactor.AbstractNioBufferReactorNettyCodec
- encoder(Encoder<?>...) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Append to the list of encoders to use for serializing Objects to the data or metadata of a
Payload
. - encoder(ResolvableType, MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Find a compatible Encoder for the given element type.
- encoders() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
encoders
. - encoders(Consumer<List<Encoder<?>>>) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Apply the consumer to the list of configured encoders, immediately.
- entrySet() - Method in class org.springframework.messaging.MessageHeaders
- entrySet() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- equals(Object) - Method in class org.springframework.messaging.handler.AbstractMessageCondition
- equals(Object) - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- equals(Object) - Method in class org.springframework.messaging.handler.HandlerMethod
- equals(Object) - Method in class org.springframework.messaging.MessageHeaders
- equals(Object) - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- equals(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- equals(Object) - Method in class org.springframework.messaging.support.GenericMessage
- ERROR - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- ERROR_CHANNEL - Static variable in class org.springframework.messaging.MessageHeaders
-
The key for the message error channel.
- ErrorMessage - Class in org.springframework.messaging.support
-
A
GenericMessage
with aThrowable
payload. - ErrorMessage(Throwable) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
Create a new message with the given payload.
- ErrorMessage(Throwable, Map<String, Object>) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
Create a new message with the given payload and headers.
- ErrorMessage(Throwable, Map<String, Object>, Message<?>) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
Create a new message with the given payload, headers and original message.
- ErrorMessage(Throwable, Message<?>) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
Create a new message with the given payload and original message.
- ErrorMessage(Throwable, MessageHeaders) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
A constructor with the
MessageHeaders
instance to use. - ErrorMessage(Throwable, MessageHeaders, Message<?>) - Constructor for class org.springframework.messaging.support.ErrorMessage
-
Create a new message with the payload,
MessageHeaders
and original message. - executor(TaskExecutor) - Method in class org.springframework.messaging.simp.config.ChannelRegistration
-
Configure the given
TaskExecutor
for this message channel, taking precedence over a task executor registration if any. - ExecutorChannelInterceptor - Interface in org.springframework.messaging.support
-
An extension of
ChannelInterceptor
with callbacks to intercept the asynchronous sending of aMessage
to a specific subscriber through anExecutor
. - ExecutorSubscribableChannel - Class in org.springframework.messaging.support
-
A
SubscribableChannel
that sends messages to each of its subscribers. - ExecutorSubscribableChannel() - Constructor for class org.springframework.messaging.support.ExecutorSubscribableChannel
-
Create a new
ExecutorSubscribableChannel
instance where messages will be sent in the callers thread. - ExecutorSubscribableChannel(Executor) - Constructor for class org.springframework.messaging.support.ExecutorSubscribableChannel
-
Create a new
ExecutorSubscribableChannel
instance where messages will be sent via the specified executor. - expression() - Element in annotation interface org.springframework.messaging.handler.annotation.Payload
-
A SpEL expression to be evaluated against the payload object as the root context.
- extendMapping(CompositeMessageCondition, HandlerMethod) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- extendMapping(T, HandlerMethod) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
This method is invoked just before mappings are added.
- extendTcpClient(TcpClient, TcpConnectionHandler<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
Provides an opportunity to initialize the
TcpClient
for the givenTcpConnectionHandler
which may implement sub-interfaces such asStompTcpConnectionHandler
that expose further information. - extendTcpClient(TcpClient, TcpConnectionHandler<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
Provides an opportunity to initialize the
TcpClient
for the givenTcpConnectionHandler
which may implement sub-interfaces such asStompTcpConnectionHandler
that expose further information. - extract(Payload, MimeType) - Method in class org.springframework.messaging.rsocket.DefaultMetadataExtractor
- extract(Payload, MimeType) - Method in interface org.springframework.messaging.rsocket.MetadataExtractor
-
Extract a map of values from the given
Payload
metadata.
F
- findSubscriptions(Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- findSubscriptions(Message<?>) - Method in interface org.springframework.messaging.simp.broker.SubscriptionRegistry
-
Find all subscriptions that should receive the given message.
- findSubscriptions(SimpSubscriptionMatcher) - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- findSubscriptions(SimpSubscriptionMatcher) - Method in interface org.springframework.messaging.simp.user.SimpUserRegistry
-
Find subscriptions with the given matcher.
- findSubscriptionsInternal(String, Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- findSubscriptionsInternal(String, Message<?>) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
- FixedIntervalReconnectStrategy - Class in org.springframework.messaging.tcp
-
A simple strategy for making reconnect attempts at a fixed interval.
- FixedIntervalReconnectStrategy(long) - Constructor for class org.springframework.messaging.tcp.FixedIntervalReconnectStrategy
-
Create a new
FixedIntervalReconnectStrategy
instance. - forLog(Log) - Static method in class org.springframework.messaging.simp.SimpLogging
-
Wrap the given primary logger with a composite logger that delegates to either the primary or to the shared fallback logger "org.springframework.web.HttpLogging", if the primary is not enabled.
- forLogName(Class<?>) - Static method in class org.springframework.messaging.simp.SimpLogging
-
Create a primary logger for the given class and wrap it with a composite that delegates to it or to the fallback logger named "org.springframework.web.SimpLogging", if the primary is not enabled.
- formatInvokeError(String, Object[]) - Method in class org.springframework.messaging.handler.HandlerMethod
- FRAME_TYPE_HEADER - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
The name of the header that contains the RSocket frame type being processed.
- fromHeaderName(String) - Method in class org.springframework.messaging.support.AbstractHeaderMapper
-
Generate the name to use to set the header defined by the specified
headerName
to the protocol specific message. - fromHeaders(MessageHeaders, T) - Method in interface org.springframework.messaging.support.HeaderMapper
-
Map from the given
MessageHeaders
to the specified target message. - fromJson(Reader, Type) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- fromJson(Reader, Type) - Method in class org.springframework.messaging.converter.GsonMessageConverter
- fromJson(Reader, Type) - Method in class org.springframework.messaging.converter.JsonbMessageConverter
- fromJson(Reader, Type) - Method in class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
- fromJson(String, Type) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- fromJson(String, Type) - Method in class org.springframework.messaging.converter.GsonMessageConverter
- fromJson(String, Type) - Method in class org.springframework.messaging.converter.JsonbMessageConverter
- fromJson(String, Type) - Method in class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
- fromMessage(Message<?>) - Static method in class org.springframework.messaging.simp.SimpAttributes
-
Extract the SiMP session attributes from the given message and wrap them in a
SimpAttributes
instance. - fromMessage(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- fromMessage(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.CompositeMessageConverter
- fromMessage(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.GenericMessageConverter
- fromMessage(Message<?>, Class<?>) - Method in interface org.springframework.messaging.converter.MessageConverter
-
Convert the payload of a
Message
from a serialized form to a typed Object of the specified target class. - fromMessage(Message<?>, Class<?>) - Method in class org.springframework.messaging.converter.SimpleMessageConverter
- fromMessage(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- fromMessage(Message<?>, Class<?>, Object) - Method in class org.springframework.messaging.converter.CompositeMessageConverter
- fromMessage(Message<?>, Class<?>, Object) - Method in interface org.springframework.messaging.converter.SmartMessageConverter
-
A variant of
MessageConverter.fromMessage(Message, Class)
which takes an extra conversion context as an argument, allowing to take e.g. - fromMessage(Message<T>) - Static method in class org.springframework.messaging.support.MessageBuilder
-
Create a builder for a new
Message
instance pre-populated with all the headers copied from the provided message.
G
- GenericMessage<T> - Class in org.springframework.messaging.support
-
An implementation of
Message
with a generic payload. - GenericMessage(T) - Constructor for class org.springframework.messaging.support.GenericMessage
-
Create a new message with the given payload.
- GenericMessage(T, Map<String, Object>) - Constructor for class org.springframework.messaging.support.GenericMessage
-
Create a new message with the given payload and headers.
- GenericMessage(T, MessageHeaders) - Constructor for class org.springframework.messaging.support.GenericMessage
-
A constructor with the
MessageHeaders
instance to use. - GenericMessageConverter - Class in org.springframework.messaging.converter
-
An extension of the
SimpleMessageConverter
that uses aConversionService
to convert the payload of the message to the requested type. - GenericMessageConverter() - Constructor for class org.springframework.messaging.converter.GenericMessageConverter
-
Create a new instance with a default
ConversionService
. - GenericMessageConverter(ConversionService) - Constructor for class org.springframework.messaging.converter.GenericMessageConverter
-
Create a new instance with the given
ConversionService
. - GenericMessagingTemplate - Class in org.springframework.messaging.core
-
A messaging template that resolves destinations names to
MessageChannel
's to send and receive messages from. - GenericMessagingTemplate() - Constructor for class org.springframework.messaging.core.GenericMessagingTemplate
- get(Object) - Method in class org.springframework.messaging.MessageHeaders
- get(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- get(Object, Class<T>) - Method in class org.springframework.messaging.MessageHeaders
- get(String, ObjectFactory<?>) - Method in class org.springframework.messaging.simp.SimpSessionScope
- getAcceptVersion() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getAcceptVersion() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the accept-version header.
- getAccessor(Message<?>) - Static method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return the original
MessageHeaderAccessor
used to create the headers of the givenMessage
, ornull
if that's not available or if its type does not match the required type. - getAccessor(Message<?>, Class<T>) - Static method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return the original
MessageHeaderAccessor
used to create the headers of the givenMessage
, ornull
if that's not available or if its type does not match the required type. - getAccessor(MessageHeaders, Class<T>) - Static method in class org.springframework.messaging.support.MessageHeaderAccessor
-
A variation of
MessageHeaderAccessor.getAccessor(org.springframework.messaging.Message, Class)
with aMessageHeaders
instance instead of aMessage
. - getAck() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getAck() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the ack header.
- getAdapterRegistry() - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Return the configured
ReactiveAdapterRegistry
. - getAdapterRegistry() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
-
The configured adapter registry.
- getApplicationContext() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- getApplicationContext() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- getApplicationContext() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- getApplicationDestinationPrefixes() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getApplicationEventPublisher() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- getArgumentResolver(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Find a registered
HandlerMethodArgumentResolver
that supports the given method parameter. - getArgumentResolverConfigurer() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the configured custom resolvers for handler method arguments.
- getArgumentResolvers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the complete list of argument resolvers.
- getArgumentResolvers() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the argument resolvers initialized during
AbstractMethodMessageHandler.afterPropertiesSet()
. - getAttribute(String) - Method in class org.springframework.messaging.simp.SimpAttributes
-
Return the value for the attribute of the given name, if any.
- getAttributeNames() - Method in class org.springframework.messaging.simp.SimpAttributes
-
Retrieve the names of all attributes.
- getAttributes() - Static method in class org.springframework.messaging.simp.SimpAttributesContextHolder
-
Return the SimpAttributes currently bound to the thread.
- getBean() - Method in class org.springframework.messaging.handler.HandlerMethod
-
Return the bean for this handler method.
- getBeanName() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- getBeanName() - Method in class org.springframework.messaging.support.AbstractMessageChannel
-
Return the bean name for this message channel.
- getBeanType() - Method in class org.springframework.messaging.handler.HandlerMethod
-
This method returns the type of the handler for this handler method.
- getBeanType() - Method in interface org.springframework.messaging.handler.MessagingAdviceBean
-
Return the type of the contained advice bean.
- getBindingResult() - Method in exception org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException
-
Return the BindingResult if the failure is validation-related, or
null
if none. - getBroadcastDestination() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Return the configured destination for unresolved messages.
- getBroadcastDestination() - Method in class org.springframework.messaging.simp.user.UserRegistryMessageHandler
-
Return the configured destination for broadcasting UserRegistry information.
- getBrokerChannel() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- getBrokerChannelRegistration() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getBrokerMessagingTemplate() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Return the messaging template used to send resolved messages to the broker channel.
- getBrokerRegistry(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
An accessor for the
MessageBrokerRegistry
that ensures its one-time creation and initialization throughAbstractMessageBrokerConfiguration.configureMessageBroker(MessageBrokerRegistry)
. - getBufferSize() - Method in class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Calculate the current buffer size.
- getBufferSizeLimit() - Method in class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Return the configured buffer size limit.
- getCacheLimit() - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Return the maximum number of entries for the resolved destination cache.
- getClientInboundChannel() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- getClientInboundChannel() - Method in class org.springframework.messaging.simp.config.AbstractBrokerRegistration
- getClientInboundChannelRegistration() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- getClientLogin() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the configured login to use for connections to the STOMP broker on behalf of connected clients.
- getClientOutboundChannel() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- getClientOutboundChannel() - Method in class org.springframework.messaging.simp.config.AbstractBrokerRegistration
- getClientOutboundChannelForSession(String) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Get the MessageChannel to use for sending messages to clients, possibly a per-session wrapper when
preservePublishOrder=true
. - getClientOutboundChannelRegistration() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- getClientPasscode() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the configured passcode to use for connections to the STOMP broker on behalf of connected clients.
- getCommand() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Return the STOMP command, or
null
if not yet set. - getCommand(Map<String, Object>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Return the STOMP command from the given headers, or
null
if not set. - getCondition(int, int) - Static method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Return a condition for matching the RSocket request interaction type with that is selected based on the declared request and response cardinality of some handler method.
- getCondition(Class<T>) - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- getCondition(AnnotatedElement) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Determine the mapping condition for the given annotated element.
- getCondition(AnnotatedElement) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- getConnectHeaders() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- getConnectHeaders() - Method in interface org.springframework.messaging.simp.stomp.StompTcpConnectionHandler
-
Return the headers that will be sent in the STOMP CONNECT frame.
- getConnectionCount() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the current count of TCP connection to the broker.
- getContainingClass() - Method in class org.springframework.messaging.handler.HandlerMethod
- getContent() - Method in class org.springframework.messaging.handler.AbstractMessageCondition
-
Return the collection of objects the message condition is composed of (e.g.
- getContent() - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
- getContent() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- getContent() - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- getContentLength() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getContentLength() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Return the content-length header or -1 if unknown.
- getContentLength(Map<String, List<String>>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getContentType() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Return the content-type header value.
- getContentType() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getContentTypeResolver() - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Return the
configured
ContentTypeResolver
. - getConversationId() - Method in class org.springframework.messaging.simp.SimpSessionScope
- getConversionService() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Return the configured ConversionService.
- getConversionService() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Return the configured
ConversionService
. - getConverters() - Method in class org.springframework.messaging.converter.CompositeMessageConverter
-
Return the underlying list of delegate converters.
- getCustomArgumentResolvers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the configured custom argument resolvers, if any.
- getCustomHandlers() - Method in class org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer
- getCustomResolvers() - Method in class org.springframework.messaging.handler.invocation.reactive.ArgumentResolverConfigurer
- getCustomReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the configured custom return value handlers, if any.
- getDecoders() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Return the configured decoders.
- getDecoders() - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Return a read-only list of the configured decoders.
- getDecoders() - Method in class org.springframework.messaging.rsocket.DefaultMetadataExtractor
-
Return a read-only list with the configured decoders.
- getDefaultContentType(Object) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Return the default content type for the payload.
- getDefaultDataMimeType() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return the configured
defaultDataMimeType
, ornull
. - getDefaultDestination() - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Return the configured default destination.
- getDefaultDestinationPrefix() - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Return the configured default destination prefix.
- getDefaultHeartbeat() - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Return the configured default heart-beat value (never
null
). - getDefaultMetadataMimeType() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return the configured
defaultMetadataMimeType
. - getDefaultMimeType() - Method in class org.springframework.messaging.converter.DefaultContentTypeResolver
-
Return the default MIME type to use if no
MessageHeaders.CONTENT_TYPE
header is present. - getDefaultUserDestinationPrefix() - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Return the configured default user destination prefix.
- getDestination() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getDestination() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the destination header.
- getDestination() - Method in interface org.springframework.messaging.simp.user.SimpSubscription
-
Return the subscription's destination.
- getDestination(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getDestination(Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- getDestination(Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- getDestination(Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Extract the destination from the given message.
- getDestination(Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getDestinationConditions() - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- getDestinationLookup() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return a read-only multi-value map with a direct lookup of mappings, (e.g.
- getDestinationPrefix() - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
Return the configured prefix for user destinations.
- getDestinationPrefixes() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the configured destination prefixes, if any.
- getDestinationPrefixes() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Return destination prefixes to use to filter messages to forward to the broker.
- getDestinationPrefixes() - Method in class org.springframework.messaging.simp.config.AbstractBrokerRegistration
- getDestinationResolver() - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
-
Return the configured destination resolver.
- getDestinationUserName() - Method in interface org.springframework.messaging.simp.user.DestinationUserNameProvider
-
Return a globally unique user name for use with "user" destinations.
- getDetailedLogMessage(Object) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getDetailedLogMessage(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getDetailedLogMessage(Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return a more detailed message for logging purposes.
- getDetailedPayloadLogMessage(Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getDirectLookupDestinations(SimpMessageMappingInfo) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getDirectLookupDestinations(T) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return destinations contained in the mapping that are not patterns and are therefore suitable for direct lookups.
- getDirectLookupMappings(CompositeMessageCondition) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- getDirectLookupMappings(T) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return String-based destinations for the given mapping, if any, that can be used to find matches with a direct lookup (i.e.
- getEncoders() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
-
The configured encoders.
- getEncoders() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return the configured
encoders
. - getErrorChannel() - Method in class org.springframework.messaging.MessageHeaders
- getErrorChannel() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getExceptionHandlerMethod(HandlerMethod, Exception) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Find an
@MessageExceptionHandler
method for the given exception. - getExceptionsFromMethodSignature(Method) - Static method in class org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver
-
Extract the exceptions this method handles.
- getExecutor() - Method in class org.springframework.messaging.support.ExecutorSubscribableChannel
- getExpectedContentLength() - Method in class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Get the expected content length of the currently buffered, incomplete STOMP frame.
- getFailedMessage() - Method in exception org.springframework.messaging.MessagingException
- getFirst(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Return the first header value for the given header name, if any.
- getFirstNativeHeader(String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Return the first value for the specified native header, if present.
- getFirstNativeHeader(String, Map<String, Object>) - Static method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Return the first value for the specified native header, or
null
if none. - getFrameType(Message<?>) - Static method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Find the RSocket frame type in the message headers.
- getFrameTypes() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- getGson() - Method in class org.springframework.messaging.converter.GsonMessageConverter
-
Return the configured
Gson
instance for this converter. - getHandlerMethodLogger() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return a logger to set on
InvocableHandlerMethod
. - getHandlerMethodLogger() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getHandlerMethods() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return a map with all handler methods and their mappings.
- getHandlerMethods() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return a read-only map with all handler methods and their mappings.
- getHandlerPredicate() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the
configured
handler predicate. - getHeader(String) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Retrieve the value for the header with the given name.
- getHeaderIfAvailable(Map<String, Object>, String, Class<V>) - Method in class org.springframework.messaging.support.AbstractHeaderMapper
-
Return the header value, or
null
if it does not exist or does not match the requestedtype
. - getHeaderInitializer() - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the configured header initializer.
- getHeaderInitializer() - Method in class org.springframework.messaging.simp.stomp.StompDecoder
-
Return the configured
MessageHeaderInitializer
, if any. - getHeaderInitializer() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Return the configured header initializer.
- getHeaders() - Method in interface org.springframework.messaging.Message
-
Return message headers for the message (never
null
but may be empty). - getHeaders() - Method in class org.springframework.messaging.support.GenericMessage
- getHeartbeat() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getHeartbeat() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the heartbeat header.
- getHeartbeat(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getHeartbeatValue() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
The configured value for the heart-beat settings.
- getHost() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getHost() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the host header.
- getId() - Method in class org.springframework.messaging.MessageHeaders
- getId() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the id header.
- getId() - Method in interface org.springframework.messaging.simp.user.SimpSession
-
Return the session id.
- getId() - Method in interface org.springframework.messaging.simp.user.SimpSubscription
-
Return the id associated of the subscription.
- getId() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getIdGenerator() - Static method in class org.springframework.messaging.MessageHeaders
- getIdGenerator() - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
-
Return the configured
IdGenerator
, if any. - getInterceptors() - Method in class org.springframework.messaging.simp.config.ChannelRegistration
- getInterceptors() - Method in class org.springframework.messaging.support.AbstractMessageChannel
- getInterceptors() - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Return the list of configured interceptors.
- getJsonb() - Method in class org.springframework.messaging.converter.JsonbMessageConverter
-
Return the configured
Jsonb
instance for this converter. - getJsonEncoding(MimeType) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Determine the JSON encoding to use for the given content type.
- getLogger() - Method in class org.springframework.messaging.handler.HandlerMethod
-
Return the currently configured Logger.
- getLogger() - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Return the currently configured Logger.
- getLogger() - Method in class org.springframework.messaging.support.AbstractMessageChannel
-
Return the currently configured Logger.
- getLogger() - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
Return the currently configured Logger.
- getLogger() - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
Return the currently configured Logger.
- getLogin() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getLogin() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the login header.
- getLookupDestination(String) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Check whether the given destination (of an incoming message) matches to one of the configured destination prefixes and if so return the remaining portion of the destination after the matched prefix.
- getLookupDestination(String) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getMappingComparator(Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- getMappingComparator(Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return a comparator for sorting matching mappings.
- getMappingComparator(Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return a comparator for sorting matching mappings.
- getMappingComparator(Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Provide the mapping for a handler method.
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Obtain the mapping for the given method, if any.
- getMappingForMethod(Method, Class<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getMarshaller() - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
-
Return the configured Marshaller.
- getMatchingCondition(Message<?>) - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- getMatchingCondition(Message<?>) - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted via
PathMatcher.getPatternComparator(String)
. - getMatchingCondition(Message<?>) - Method in interface org.springframework.messaging.handler.MessageCondition
-
Check if this condition matches the given Message and returns a potentially new condition with content tailored to the current message.
- getMatchingCondition(Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- getMatchingCondition(Message<?>) - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- getMatchingCondition(Message<?>) - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- getMatchingMapping(CompositeMessageCondition, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- getMatchingMapping(SimpMessageMappingInfo, Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getMatchingMapping(T, Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.
- getMatchingMapping(T, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.
- getMessage() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getMessage() - Method in interface org.springframework.messaging.support.MessageHandlingRunnable
-
Return the Message that will be handled.
- getMessageChannel() - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Return the configured message channel.
- getMessageConditions() - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- getMessageConverter() - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Return the configured
MessageConverter
. - getMessageConverter() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Return the configured
MessageConverter
. - getMessageConverter() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Return the configured
MessageConverter
. - getMessageConverter() - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Return the configured
MessageConverter
. - getMessageHandler() - Method in interface org.springframework.messaging.support.MessageHandlingRunnable
-
Return the MessageHandler that will be used to handle the message.
- getMessageHandler(SubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractBrokerRegistration
- getMessageHandler(SubscribableChannel) - Method in class org.springframework.messaging.simp.config.SimpleBrokerRegistration
- getMessageHandler(SubscribableChannel) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
- getMessageHeaders() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return the underlying
MessageHeaders
instance. - getMessageId() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getMessageId() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the message-id header.
- getMessageType() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getMessageType() - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- getMessageType() - Method in enum class org.springframework.messaging.simp.stomp.StompCommand
- getMessageType(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getMessageType(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- getMessageTypeMessageCondition() - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- getMetadata() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the metadata entries for
RSocketRequester.MetadataSpec.metadata(Object, MimeType)
. - getMetadataExtractor() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return the configured
MetadataExtractor
. - getMethodArgumentValues(Message<?>, Object...) - Method in class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.
- getMethodParameter() - Method in exception org.springframework.messaging.handler.invocation.MethodArgumentResolutionException
-
Return the MethodParameter that was rejected.
- getMimeType(Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Return the mime type for the content.
- getMimeType(MessageHeaders) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- getMutableAccessor(Message<?>) - Static method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return a mutable
MessageHeaderAccessor
for the given message attempting to match the type of accessor used to create the message headers, or otherwise wrapping the message with aMessageHeaderAccessor
instance. - getNack() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getName() - Method in interface org.springframework.messaging.simp.user.SimpUser
-
The unique user name.
- getNativeHeader(String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Return all values for the specified native header, if present.
- getNativeHeaders() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getNativeHeaders() - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Subclasses can use this method to access the "native" headers sub-map.
- getNextMessageTask(Message<?>) - Static method in class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
-
Obtain the task to release the next message, if found.
- getObjectMapper() - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Return the underlying
ObjectMapper
for this converter. - getOrder() - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- getOriginalMessage() - Method in class org.springframework.messaging.support.ErrorMessage
-
Return the original message (if available) at the point in the stack where the ErrorMessage was created.
- getParameterNameDiscoverer() - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Return the configured parameter name discoverer.
- getPasscode() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Return the passcode header value, or
null
if not set. - getPasscode() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the passcode header.
- getPasscode(Map<String, Object>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Return the passcode header value, or
null
if not set. - getPathMatcher() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Return the PathMatcher implementation to use for matching destinations.
- getPathMatcher() - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Return the configured
PathMatcher
. - getPathMatcher() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getPathMatcher(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Provide access to the configured PatchMatcher for access from other configuration classes.
- getPatterns() - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
- getPayload() - Method in interface org.springframework.messaging.Message
-
Return the message payload.
- getPayload() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the request payload as a Publisher.
- getPayload() - Method in class org.springframework.messaging.support.GenericMessage
- getPayloadElementType() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the element type for a Publisher payload.
- getPayloadType(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
-
Resolve the target class to convert the payload to.
- getPayloadType(StompHeaders) - Method in interface org.springframework.messaging.simp.stomp.StompFrameHandler
-
Invoked before
StompFrameHandler.handleFrame(StompHeaders, Object)
to determine the type of Object the payload should be converted to. - getPayloadType(StompHeaders) - Method in class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
-
This implementation returns String as the expected payload type for STOMP ERROR frames.
- getPayloadValue() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the request payload as a value to be serialized, if set.
- getPhase() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getPhase() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- getPhase() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- getPhase() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- getPrincipal() - Method in interface org.springframework.messaging.simp.user.SimpUser
-
Return the user associated with the session, if available.
- getRawHeaders() - Method in class org.springframework.messaging.MessageHeaders
- getReactiveAdapterRegistry() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the configured registry for adapting reactive types.
- getReceipt() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getReceipt() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the receipt header.
- getReceiptId() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getReceiptId() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the receipt header.
- getReceiptId() - Method in interface org.springframework.messaging.simp.stomp.StompSession.Receiptable
-
Return the receipt id, or
null
if the STOMP frame for which the handle was returned did not have a "receipt" header. - getReceiptTimeLimit() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Return the configured time limit before a receipt expires.
- getReceiptTimeLimit() - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Return the configured receipt time limit.
- getReceiveTimeout() - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Return the configured receive operation timeout value.
- getReceiveTimeoutHeader() - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Return the configured receive-timeout header.
- getRegistryExpirationPeriod() - Method in class org.springframework.messaging.simp.user.UserRegistryMessageHandler
-
Return the configured registry expiration period.
- getRelayHost() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the STOMP message broker host.
- getRelayPort() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the STOMP message broker port.
- getReplyChannel() - Method in class org.springframework.messaging.MessageHeaders
- getReplyChannel() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getRequiredDefaultDestination() - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- getResolvedFromHandlerMethod() - Method in class org.springframework.messaging.handler.HandlerMethod
-
Return the HandlerMethod from which this HandlerMethod instance was resolved via
HandlerMethod.createWithResolvedBean()
. - getResolvers() - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Return a read-only list with the contained resolvers, or an empty list.
- getResolvers() - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Return a read-only list with the contained resolvers, or an empty list.
- getResolvers() - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Return the configured argument resolvers.
- getReturnValueHandlerConfigurer() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the configured return value handlers.
- getReturnValueHandlerLogger() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return a logger to set on
HandlerMethodReturnValueHandlerComposite
. - getReturnValueHandlerLogger() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- getReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the complete list of return value handlers.
- getReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Return a read-only list with the configured handlers.
- getReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
-
Return a read-only list with the configured handlers.
- getRoute() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the route value for
route
. - getRouteMatcher() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Return the
RouteMatcher
used to map messages to handlers. - getRouteVariables() - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues
-
Return the route variables for
route
. - getRSocketStrategies() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return the
configured
RSocketStrategies
. - getSelectorHeaderName() - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Return the name of the selector header.
- getSendTimeout() - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Return the configured default send operation timeout value.
- getSendTimeout() - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Return the configured send timeout (in milliseconds).
- getSendTimeoutHeader() - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Return the configured send-timeout header.
- getSerializationView(Object) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Determine a Jackson serialization view based on the given conversion hint.
- getSerializedPayloadClass() - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Return the configured preferred serialization payload class.
- getServer() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the server header.
- getSession() - Method in interface org.springframework.messaging.simp.stomp.ConnectionHandlingStompSession
-
Return a future that will complete when the session is ready for use.
- getSession() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- getSession() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the session header.
- getSession() - Method in interface org.springframework.messaging.simp.user.SimpSubscription
-
Return the session of the subscription.
- getSession(String) - Method in interface org.springframework.messaging.simp.user.SimpUser
-
Look up the session for the given id.
- getSessionAttributes() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Return the attributes associated with the current session.
- getSessionAttributes(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getSessionFuture() - Method in interface org.springframework.messaging.simp.stomp.ConnectionHandlingStompSession
-
Deprecated.as of 6.0, in favor of
ConnectionHandlingStompSession.getSession()
- getSessionHandler() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Return the configured session handler.
- getSessionId() - Method in class org.springframework.messaging.simp.SimpAttributes
-
Return an id for the associated session.
- getSessionId() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Return the id of the current session.
- getSessionId() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- getSessionId() - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Return the id for the session.
- getSessionId() - Method in interface org.springframework.messaging.simp.stomp.StompTcpConnectionHandler
-
Return the
sessionId
associated with the STOMP connection. - getSessionId(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getSessionIds() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
-
Return the session id for the targetDestination.
- getSessionMutex() - Method in class org.springframework.messaging.simp.SimpAttributes
-
Expose the object to synchronize on for the underlying session.
- getSessions() - Method in interface org.springframework.messaging.simp.user.SimpUser
-
Return the sessions for the user.
- getShortLogMessage() - Method in class org.springframework.messaging.handler.HandlerMethod
-
Return a short representation of this handler method for log message purposes.
- getShortLogMessage(Object) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getShortLogMessage(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getShortLogMessage(Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return a concise message for logging purposes.
- getShortPayloadLogMessage(Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getSimpleBroker(SubscribableChannel) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getSimpUserRegistry() - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
Return the configured
SimpUserRegistry
. - getSourceDestination() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
-
The "user" destination from the source message.
- getStats() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return a structured object with internal state and counters.
- getStatsInfo() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return a String describing internal state and counters.
- getStompBrokerRelay(SubscribableChannel) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getStompDecoder() - Method in class org.springframework.messaging.simp.stomp.BufferingStompDecoder
-
Return the wrapped
StompDecoder
. - getSubscribeDestination() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
-
The user destination in the form expected when a client subscribes, e.g.
- getSubscribers() - Method in class org.springframework.messaging.support.AbstractSubscribableChannel
- getSubscription() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Get the subscription header.
- getSubscriptionHeaders() - Method in interface org.springframework.messaging.simp.stomp.StompSession.Subscription
-
Return the headers used on the SUBSCRIBE frame.
- getSubscriptionId() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getSubscriptionId() - Method in interface org.springframework.messaging.simp.stomp.StompSession.Subscription
-
Return the id for the subscription.
- getSubscriptionId(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getSubscriptionRegistry() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- getSubscriptions() - Method in interface org.springframework.messaging.simp.user.SimpSession
-
Return the subscriptions for this session.
- getSupportedMimeTypes() - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Return the supported MIME types.
- getSystemHeartbeatReceiveInterval() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the interval, in milliseconds, at which the "system" connection expects to receive heartbeats from the STOMP broker.
- getSystemHeartbeatSendInterval() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the interval, in milliseconds, at which the "system" connection will send heartbeats to the STOMP broker.
- getSystemLogin() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the login used for the shared "system" connection to the STOMP broker.
- getSystemPasscode() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the passcode used for the shared "system" connection to the STOMP broker.
- getSystemSubscriptions() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the configured map with subscriptions on the "system" connection.
- getTargetDestination(String, String, String, String) - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
This method determines how to translate the source "user" destination to an actual target destination for the given active user session.
- getTargetDestinations() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
-
The target destinations that the source destination was translated to, one per active user session, e.g.
- getTargetDestinations(Annotation, Message<?>, String) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- getTaskExecutor() - Method in class org.springframework.messaging.simp.config.TaskExecutorRegistration
- getTaskExecutor(Supplier<TaskExecutor>, Consumer<TaskExecutor>) - Method in class org.springframework.messaging.simp.config.ChannelRegistration
-
Return the
TaskExecutor
to use. - getTaskScheduler() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Return the configured TaskScheduler.
- getTaskScheduler() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Return the configured TaskScheduler to use for receipt tracking.
- getTaskScheduler() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
- getTaskScheduler() - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
The configured TaskScheduler.
- getTcpClient() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Get the configured TCP client (never
null
unless not configured invoked and this method is invoked before the handler is started and hence a default implementation initialized). - getTimestamp() - Method in class org.springframework.messaging.MessageHeaders
- getTimestamp() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- getTimeToNextAttempt(int) - Method in class org.springframework.messaging.tcp.FixedIntervalReconnectStrategy
- getTimeToNextAttempt(int) - Method in interface org.springframework.messaging.tcp.ReconnectStrategy
-
Return the time to the next attempt to reconnect.
- getToStringInfix() - Method in class org.springframework.messaging.handler.AbstractMessageCondition
-
The notation to use when printing discrete items of content.
- getToStringInfix() - Method in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
- getToStringInfix() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- getToStringInfix() - Method in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- getTotalConnect() - Method in interface org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.Stats
-
The number of CONNECT frames processed.
- getTotalConnected() - Method in interface org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.Stats
-
The number of CONNECTED frames processed.
- getTotalDisconnect() - Method in interface org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.Stats
-
The number of DISCONNECT frames processed.
- getTotalHandlers() - Method in interface org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler.Stats
-
The number of connection handlers.
- getUnmarshaller() - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
-
Return the configured unmarshaller.
- getUser() - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Return the user associated with the current session.
- getUser() - Method in interface org.springframework.messaging.simp.user.SimpSession
-
Return the user associated with the session.
- getUser() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
-
The user for this user destination.
- getUser(String) - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- getUser(String) - Method in interface org.springframework.messaging.simp.user.SimpUserRegistry
-
Get the user for the given name.
- getUser(Map<String, Object>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- getUserCount() - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- getUserCount() - Method in interface org.springframework.messaging.simp.user.SimpUserRegistry
-
Return the count of all connected users.
- getUserDestinationBroadcast() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getUserDestinationBroadcast() - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
- getUserDestinationPrefix() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getUserDestinationPrefix() - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Return the configured user destination prefix.
- getUserDestinationResolver() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Return the configured
UserDestinationResolver
. - getUserName(Message<?>, MessageHeaders) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- getUserRegistryBroadcast() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getUserRegistryBroadcast() - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
- getUserRegistryOrder() - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
- getUsers() - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- getUsers() - Method in interface org.springframework.messaging.simp.user.SimpUserRegistry
-
Return a snapshot of all connected users.
- getValidator() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Return the configured Validator instance.
- getValidator() - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Return the configured validator, if any.
- getValidator() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Return the configured Validator instance.
- getValidator() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Override this method to provide a custom
Validator
. - getVersion() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- getVirtualHost() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Return the configured virtual host value.
- GsonMessageConverter - Class in org.springframework.messaging.converter
-
Implementation of
MessageConverter
that can read and write JSON using Google Gson. - GsonMessageConverter() - Constructor for class org.springframework.messaging.converter.GsonMessageConverter
-
Construct a new
GsonMessageConverter
with default configuration. - GsonMessageConverter(Gson) - Constructor for class org.springframework.messaging.converter.GsonMessageConverter
-
Construct a new
GsonMessageConverter
with the given delegate.
H
- handleEncodedContent(Flux<DataBuffer>, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
-
Subclasses implement this method to handle encoded values in some way such as creating and sending messages.
- handleEncodedContent(Flux<DataBuffer>, MethodParameter, Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketPayloadReturnValueHandler
- handleException(StompSession, StompCommand, StompHeaders, byte[], Throwable) - Method in interface org.springframework.messaging.simp.stomp.StompSessionHandler
-
Handle any exception arising while processing a STOMP frame such as a failure to convert the payload or an unhandled exception in the application
StompFrameHandler
. - handleException(StompSession, StompCommand, StompHeaders, byte[], Throwable) - Method in class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
-
This implementation is empty.
- handleFailure(Throwable) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- handleFailure(Throwable) - Method in interface org.springframework.messaging.tcp.TcpConnectionHandler
-
Handle a failure on the connection.
- handleFrame(StompHeaders, Object) - Method in interface org.springframework.messaging.simp.stomp.StompFrameHandler
-
Handle a STOMP frame with the payload converted to the target type returned from
StompFrameHandler.getPayloadType(StompHeaders)
. - handleFrame(StompHeaders, Object) - Method in class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
-
This implementation is empty.
- handleMatch(CompositeMessageCondition, HandlerMethod, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- handleMatch(SimpMessageMappingInfo, HandlerMethod, String, Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- handleMatch(T, HandlerMethod, String, Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- handleMatch(T, HandlerMethod, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- handleMessage(Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- handleMessage(Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- handleMessage(Message<?>) - Method in interface org.springframework.messaging.MessageHandler
-
Handle the given message.
- handleMessage(Message<?>) - Method in interface org.springframework.messaging.ReactiveMessageHandler
-
Handle the given message.
- handleMessage(Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- handleMessage(Message<?>) - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- handleMessage(Message<?>) - Method in class org.springframework.messaging.simp.user.UserRegistryMessageHandler
- handleMessage(Message<byte[]>) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- handleMessage(Message<P>) - Method in interface org.springframework.messaging.tcp.TcpConnectionHandler
-
Handle a message received from the remote host.
- handleMessageInternal(Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- handleMessageInternal(Message<?>) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- handleMessageInternal(Message<?>) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
- handleMessageInternal(Message<?>, String) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver
-
Invoked when a value is required, but
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
- handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.HeaderMethodArgumentResolver
- handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
-
Invoked when a value is required, but
AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String)
returnednull
and there is no default value. - handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
- handleMissingValue(String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.HeaderMethodArgumentResolver
- handleNoContent(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
-
Invoked for a
null
return value, which could mean a void method or method returning an async type parameterized by void. - handleNoContent(MethodParameter, Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketPayloadReturnValueHandler
- handleNoMatch(Set<T>, String, Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- handleNoMatch(RouteMatcher.Route, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Invoked when no matching handler is found.
- handleNoMatch(RouteMatcher.Route, Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- handleResolvedValue(Object, String, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
-
Invoked after a value is resolved.
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler
-
Handle the given return value.
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandler
-
Handle the given return value.
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- handleReturnValue(Object, MethodParameter, Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
- HandlerMethod - Class in org.springframework.messaging.handler
-
Encapsulates information about a handler method consisting of a method and a bean.
- HandlerMethod(Object, Method) - Constructor for class org.springframework.messaging.handler.HandlerMethod
-
Create an instance from a bean instance and a method.
- HandlerMethod(Object, String, Class<?>...) - Constructor for class org.springframework.messaging.handler.HandlerMethod
-
Create an instance from a bean instance, method name, and parameter types.
- HandlerMethod(String, BeanFactory, Method) - Constructor for class org.springframework.messaging.handler.HandlerMethod
-
Create an instance from a bean name, a method, and a
BeanFactory
. - HandlerMethod(HandlerMethod) - Constructor for class org.springframework.messaging.handler.HandlerMethod
-
Copy constructor for use in subclasses.
- HandlerMethodArgumentResolver - Interface in org.springframework.messaging.handler.invocation
-
Strategy interface for resolving method parameters into argument values in the context of a given
Message
. - HandlerMethodArgumentResolver - Interface in org.springframework.messaging.handler.invocation.reactive
-
Strategy interface for resolving method parameters into argument values in the context of a given
Message
. - HandlerMethodArgumentResolverComposite - Class in org.springframework.messaging.handler.invocation
-
Resolves method parameters by delegating to a list of registered
HandlerMethodArgumentResolvers
. - HandlerMethodArgumentResolverComposite - Class in org.springframework.messaging.handler.invocation.reactive
-
Resolves method parameters by delegating to a list of registered
HandlerMethodArgumentResolvers
. - HandlerMethodArgumentResolverComposite() - Constructor for class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
- HandlerMethodArgumentResolverComposite() - Constructor for class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
- HandlerMethodReturnValueHandler - Interface in org.springframework.messaging.handler.invocation
-
Strategy interface to handle the value returned from the invocation of a method handling a
Message
. - HandlerMethodReturnValueHandler - Interface in org.springframework.messaging.handler.invocation.reactive
-
Handle the return value from the invocation of an annotated
Message
handling method. - HandlerMethodReturnValueHandlerComposite - Class in org.springframework.messaging.handler.invocation
-
A HandlerMethodReturnValueHandler that wraps and delegates to others.
- HandlerMethodReturnValueHandlerComposite - Class in org.springframework.messaging.handler.invocation.reactive
-
A HandlerMethodReturnValueHandler that wraps and delegates to others.
- HandlerMethodReturnValueHandlerComposite() - Constructor for class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- HandlerMethodReturnValueHandlerComposite() - Constructor for class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
- handleTransportError(StompSession, Throwable) - Method in interface org.springframework.messaging.simp.stomp.StompSessionHandler
-
Handle a low level transport error which could be an I/O error or a failure to encode or decode a STOMP message.
- handleTransportError(StompSession, Throwable) - Method in class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
-
This implementation is empty.
- hasExceptionMappings() - Method in class org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver
-
Whether the contained type has any exception mappings.
- hashCode() - Method in class org.springframework.messaging.handler.AbstractMessageCondition
- hashCode() - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- hashCode() - Method in class org.springframework.messaging.handler.HandlerMethod
- hashCode() - Method in class org.springframework.messaging.MessageHeaders
- hashCode() - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- hashCode() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- hashCode() - Method in class org.springframework.messaging.support.GenericMessage
- hasInterceptors() - Method in class org.springframework.messaging.simp.config.ChannelRegistration
- hasSessions() - Method in interface org.springframework.messaging.simp.user.SimpUser
-
Whether the user has any sessions.
- hasSubscription(MessageHandler) - Method in class org.springframework.messaging.support.AbstractSubscribableChannel
- hasTaskExecutor() - Method in class org.springframework.messaging.simp.config.ChannelRegistration
- Header - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation which indicates that a method parameter should be bound to a message header.
- HeaderMapper<T> - Interface in org.springframework.messaging.support
-
Generic strategy interface for mapping
MessageHeaders
to and from other types of objects. - HeaderMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
Resolver for
@Header
arguments. - HeaderMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
Resolver for
@Header
arguments. - HeaderMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.messaging.handler.annotation.reactive.HeaderMethodArgumentResolver
- HeaderMethodArgumentResolver(ConversionService, ConfigurableBeanFactory) - Constructor for class org.springframework.messaging.handler.annotation.support.HeaderMethodArgumentResolver
- Headers - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation which indicates that a method parameter should be bound to the headers of a message.
- HeadersMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
Argument resolver for headers.
- HeadersMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
Argument resolver for headers.
- HeadersMethodArgumentResolver() - Constructor for class org.springframework.messaging.handler.annotation.reactive.HeadersMethodArgumentResolver
- HeadersMethodArgumentResolver() - Constructor for class org.springframework.messaging.handler.annotation.support.HeadersMethodArgumentResolver
- HEART_BEAT_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- HEARTBEAT - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- HEARTBEAT - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- HOST - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
I
- ID - Static variable in class org.springframework.messaging.MessageHeaders
-
The key for the Message ID.
- ID - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- ID_VALUE_NONE - Static variable in class org.springframework.messaging.MessageHeaders
-
UUID for none.
- IdTimestampMessageHeaderInitializer - Class in org.springframework.messaging.support
-
A
MessageHeaderInitializer
to customize the strategy for ID and TIMESTAMP message header generation. - IdTimestampMessageHeaderInitializer() - Constructor for class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
- IGNORE_ERROR - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
A header that indicates to the broker that the sender will ignore errors.
- ImmutableMessageChannelInterceptor - Class in org.springframework.messaging.support
-
A simpler interceptor that calls
MessageHeaderAccessor.setImmutable()
on the headers of messages passed through the preSend method. - ImmutableMessageChannelInterceptor() - Constructor for class org.springframework.messaging.support.ImmutableMessageChannelInterceptor
- INDEFINITE_TIMEOUT - Static variable in interface org.springframework.messaging.MessageChannel
-
Constant for sending a message without a prescribed timeout.
- initArgumentResolvers() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- initArgumentResolvers() - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
- initArgumentResolvers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the list of argument resolvers to use.
- initArgumentResolvers() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the list of argument resolvers to use.
- initArgumentResolvers() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- initHeaders(MessageHeaderAccessor) - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
- initHeaders(MessageHeaderAccessor) - Method in interface org.springframework.messaging.support.MessageHeaderInitializer
-
Initialize the given
MessageHeaderAccessor
. - initPhase() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- initReturnValueHandlers() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- initReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Return the list of return value handlers to use.
- initReturnValueHandlers() - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Return the list of return value handlers to use.
- initReturnValueHandlers() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- initReturnValueHandlers() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- InterceptableChannel - Interface in org.springframework.messaging.support
-
A
MessageChannel
that maintains a listChannelInterceptors
and allows interception of message sending. - interceptors(ChannelInterceptor...) - Method in class org.springframework.messaging.simp.config.ChannelRegistration
-
Configure the given interceptors for this message channel, adding them to the channel's current list of interceptors.
- InvocableHandlerMethod - Class in org.springframework.messaging.handler.invocation
-
Extension of
HandlerMethod
that invokes the underlying method with argument values resolved from the current HTTP request through a list ofHandlerMethodArgumentResolver
. - InvocableHandlerMethod - Class in org.springframework.messaging.handler.invocation.reactive
-
Extension of
HandlerMethod
that invokes the underlying method with argument values resolved from the current HTTP request through a list ofHandlerMethodArgumentResolver
. - InvocableHandlerMethod(Object, Method) - Constructor for class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Create an instance from a bean instance and a method.
- InvocableHandlerMethod(Object, Method) - Constructor for class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Create an instance from a bean instance and a method.
- InvocableHandlerMethod(Object, String, Class<?>...) - Constructor for class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Construct a new handler method with the given bean instance, method name and parameters.
- InvocableHandlerMethod(HandlerMethod) - Constructor for class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Create an instance from a
HandlerMethod
. - InvocableHandlerMethod(HandlerMethod) - Constructor for class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Create an instance from a
HandlerMethod
. - invoke(Message<?>, Object...) - Method in class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Invoke the method after resolving its argument values in the context of the given message.
- invoke(Message<?>, Object...) - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Invoke the method for the given exchange.
- isApplicableToBeanType(Class<?>) - Method in interface org.springframework.messaging.handler.MessagingAdviceBean
-
Whether this
MessagingAdviceBean
applies to the given bean type. - isAsyncReturnValue(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.AbstractAsyncReturnValueHandler
- isAsyncReturnValue(Object, MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.AsyncHandlerMethodReturnValueHandler
-
Whether the return value represents an asynchronous, Future-like type with success and error callbacks.
- isAsyncReturnValue(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- isAsyncReturnValue(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- isAutoReceiptEnabled() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Whether receipt headers should be automatically added.
- isAutoStartup() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- isBodyAllowed() - Method in enum class org.springframework.messaging.simp.stomp.StompCommand
- isBrokerAvailable() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Whether the message broker is currently available and able to process messages.
- isBrokerAvailable() - Method in class org.springframework.messaging.simp.broker.BrokerAvailabilityEvent
- isConnected() - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- isConnected() - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Whether the session is connected.
- isDefaultHeartbeatEnabled() - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Determine whether heartbeats are enabled.
- isDisposed() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Shortcut method that delegates to the same on the underlying
RSocketRequester.rsocketClient()
. - isEmpty() - Method in class org.springframework.messaging.MessageHeaders
- isEmpty() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- isEmptyPayload(Object) - Method in class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
-
Check if the given
payload
is empty. - isEmptyPayload(Object) - Method in class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
-
Specify if the given
payload
is empty. - isEnableTimestamp() - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
-
Return whether the timestamp header is enabled or not.
- isHandler(Class<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Whether the given bean type should be introspected for messaging handling methods.
- isHandler(Class<?>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- isHeartbeat() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- isHeartbeatEnabled() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Whether heartbeats are enabled.
- isModified() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Check whether the underlying message headers have been marked as modified.
- isMutable() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Whether the underlying headers can still be modified.
- isPreservePublishOrder() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Whether to ensure messages are received in the order of publication.
- isReadableContentType() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- isReadOnly(String) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- isRemoveLeadingSlash() - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
Whether to remove the leading slash from target destinations.
- isRunning() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- isRunning() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Check whether this message handler is currently running.
- isRunning() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- isSessionCompleted() - Method in class org.springframework.messaging.simp.SimpAttributes
-
Whether the
SimpAttributes.sessionCompleted()
was already invoked. - isStrictContentTypeMatch() - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Whether content type resolution must produce a value that matches one of the supported MIME types.
- isUseDefaultResolution() - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Whether this resolver is configured to use default resolution, i.e.
J
- JsonbMessageConverter - Class in org.springframework.messaging.converter
-
Implementation of
MessageConverter
that can read and write JSON using the JSON Binding API. - JsonbMessageConverter() - Constructor for class org.springframework.messaging.converter.JsonbMessageConverter
-
Construct a new
JsonbMessageConverter
with default configuration. - JsonbMessageConverter(Jsonb) - Constructor for class org.springframework.messaging.converter.JsonbMessageConverter
-
Construct a new
JsonbMessageConverter
with the given delegate. - JsonbMessageConverter(JsonbConfig) - Constructor for class org.springframework.messaging.converter.JsonbMessageConverter
-
Construct a new
JsonbMessageConverter
with the given configuration.
K
- keepAliveSeconds(int) - Method in class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Set the time limit for which threads may remain idle before being terminated.
- keySet() - Method in class org.springframework.messaging.MessageHeaders
- keySet() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- KotlinSerializationJsonMessageConverter - Class in org.springframework.messaging.converter
-
Implementation of
MessageConverter
that can read and write JSON using kotlinx.serialization. - KotlinSerializationJsonMessageConverter() - Constructor for class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
-
Construct a new
KotlinSerializationJsonMessageConverter
with default configuration. - KotlinSerializationJsonMessageConverter(Json) - Constructor for class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
-
Construct a new
KotlinSerializationJsonMessageConverter
with the given delegate.
L
- ListenableFutureReturnValueHandler - Class in org.springframework.messaging.handler.invocation
-
Deprecated.as of 6.0, in favor of
CompletableFutureReturnValueHandler
- ListenableFutureReturnValueHandler() - Constructor for class org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler
-
Deprecated.
- logger - Variable in class org.springframework.messaging.converter.AbstractMessageConverter
- logger - Variable in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- logger - Variable in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
- logger - Variable in class org.springframework.messaging.handler.HandlerMethod
- logger - Variable in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- logger - Variable in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
- logger - Variable in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- logger - Variable in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
- logger - Variable in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
- logger - Variable in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- logger - Variable in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- logger - Variable in class org.springframework.messaging.support.AbstractHeaderMapper
- logger - Variable in class org.springframework.messaging.support.AbstractMessageChannel
- LOGIN - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- logWarningIfNecessary(Type, Throwable) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Determine whether to log the given exception coming from a
ObjectMapper.canDeserialize(com.fasterxml.jackson.databind.JavaType)
/ObjectMapper.canSerialize(java.lang.Class<?>)
check. - LOOKUP_DESTINATION_HEADER - Static variable in class org.springframework.messaging.handler.DestinationPatternsMessageCondition
-
The name of the "lookup destination" header.
M
- MappingJackson2MessageConverter - Class in org.springframework.messaging.converter
-
A Jackson 2 based
MessageConverter
implementation. - MappingJackson2MessageConverter() - Constructor for class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Construct a
MappingJackson2MessageConverter
with a defaultObjectMapper
, supporting theapplication/json
MIME type withUTF-8
character set. - MappingJackson2MessageConverter(ObjectMapper) - Constructor for class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Construct a
MappingJackson2MessageConverter
with a customObjectMapper
, supporting theapplication/json
MIME type withUTF-8
character set. - MappingJackson2MessageConverter(ObjectMapper, MimeType...) - Constructor for class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Construct a
MappingJackson2MessageConverter
with a customObjectMapper
, supporting one or more custom MIME types. - MappingJackson2MessageConverter(MimeType...) - Constructor for class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Construct a
MappingJackson2MessageConverter
with a defaultObjectMapper
, supporting one or more custom MIME types. - MarshallingMessageConverter - Class in org.springframework.messaging.converter
-
Implementation of
MessageConverter
that can read and write XML using Spring'sMarshaller
andUnmarshaller
abstractions. - MarshallingMessageConverter() - Constructor for class org.springframework.messaging.converter.MarshallingMessageConverter
-
Default construct allowing for
MarshallingMessageConverter.setMarshaller(Marshaller)
and/orMarshallingMessageConverter.setUnmarshaller(Unmarshaller)
to be invoked separately. - MarshallingMessageConverter(Marshaller) - Constructor for class org.springframework.messaging.converter.MarshallingMessageConverter
-
Constructor with
Marshaller
. - MarshallingMessageConverter(MimeType...) - Constructor for class org.springframework.messaging.converter.MarshallingMessageConverter
-
Constructor with a given list of MIME types to support.
- match(SimpSubscription) - Method in interface org.springframework.messaging.simp.user.SimpSubscriptionMatcher
-
Match the given subscription.
- maxPoolSize(int) - Method in class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Set the max pool size of the ThreadPoolExecutor.
- Message<T> - Interface in org.springframework.messaging
-
A generic message representation with headers and body.
- MESSAGE - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- MESSAGE - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- MESSAGE - Static variable in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- MESSAGE_ID - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- MESSAGE_TYPE_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- MessageBrokerRegistry - Class in org.springframework.messaging.simp.config
-
A registry for configuring message broker options.
- MessageBrokerRegistry(SubscribableChannel, MessageChannel) - Constructor for class org.springframework.messaging.simp.config.MessageBrokerRegistry
- messageBrokerTaskScheduler() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- MessageBuilder<T> - Class in org.springframework.messaging.support
- MessageChannel - Interface in org.springframework.messaging
-
Defines methods for sending messages.
- MessageCondition<T> - Interface in org.springframework.messaging.handler
-
Contract for mapping conditions to messages.
- MessageConversionException - Exception in org.springframework.messaging.converter
-
An exception raised by
MessageConverter
implementations. - MessageConversionException(String) - Constructor for exception org.springframework.messaging.converter.MessageConversionException
- MessageConversionException(String, Throwable) - Constructor for exception org.springframework.messaging.converter.MessageConversionException
- MessageConversionException(Message<?>, String) - Constructor for exception org.springframework.messaging.converter.MessageConversionException
- MessageConversionException(Message<?>, String, Throwable) - Constructor for exception org.springframework.messaging.converter.MessageConversionException
- MessageConverter - Interface in org.springframework.messaging.converter
-
A converter to turn the payload of a
Message
from serialized form to a typed Object and vice versa. - MessageDeliveryException - Exception in org.springframework.messaging
-
Exception that indicates an error occurred during message delivery.
- MessageDeliveryException(String) - Constructor for exception org.springframework.messaging.MessageDeliveryException
- MessageDeliveryException(Message<?>) - Constructor for exception org.springframework.messaging.MessageDeliveryException
- MessageDeliveryException(Message<?>, String) - Constructor for exception org.springframework.messaging.MessageDeliveryException
- MessageDeliveryException(Message<?>, String, Throwable) - Constructor for exception org.springframework.messaging.MessageDeliveryException
- MessageDeliveryException(Message<?>, Throwable) - Constructor for exception org.springframework.messaging.MessageDeliveryException
- MessageExceptionHandler - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation for handling exceptions thrown from message-handling methods within a specific handler class.
- MessageHandler - Interface in org.springframework.messaging
-
Simple contract for handling a
Message
. - MessageHandlerMethodFactory - Interface in org.springframework.messaging.handler.annotation.support
-
A factory for
InvocableHandlerMethod
that is suitable to process an incomingMessage
- MessageHandlingException - Exception in org.springframework.messaging
-
Exception that indicates an error occurred during message handling.
- MessageHandlingException(Message<?>) - Constructor for exception org.springframework.messaging.MessageHandlingException
- MessageHandlingException(Message<?>, String) - Constructor for exception org.springframework.messaging.MessageHandlingException
- MessageHandlingException(Message<?>, String, Throwable) - Constructor for exception org.springframework.messaging.MessageHandlingException
- MessageHandlingException(Message<?>, Throwable) - Constructor for exception org.springframework.messaging.MessageHandlingException
- MessageHandlingRunnable - Interface in org.springframework.messaging.support
-
Extension of the
Runnable
interface with methods to obtain theMessageHandler
andMessage
to be handled. - MessageHeaderAccessor - Class in org.springframework.messaging.support
-
Wrapper around
MessageHeaders
that provides extra features such as strongly typed accessors for specific headers, the ability to leave headers in aMessage
mutable, and the option to suppress automatic generation ofid
andtimestamp
headers. - MessageHeaderAccessor() - Constructor for class org.springframework.messaging.support.MessageHeaderAccessor
-
A constructor to create new headers.
- MessageHeaderAccessor(Message<?>) - Constructor for class org.springframework.messaging.support.MessageHeaderAccessor
-
A constructor accepting the headers of an existing message to copy.
- MessageHeaderInitializer - Interface in org.springframework.messaging.support
-
Callback interface for initializing a
MessageHeaderAccessor
. - MessageHeaders - Class in org.springframework.messaging
-
The headers for a
Message
. - MessageHeaders(Map<String, Object>) - Constructor for class org.springframework.messaging.MessageHeaders
-
Construct a
MessageHeaders
with the given headers. - MessageHeaders(Map<String, Object>, UUID, Long) - Constructor for class org.springframework.messaging.MessageHeaders
-
Constructor providing control over the ID and TIMESTAMP header values.
- MessageMapping - Annotation Interface in org.springframework.messaging.handler.annotation
- MessageMappingMessageHandler - Class in org.springframework.messaging.handler.annotation.reactive
-
Extension of
AbstractMethodMessageHandler
for reactive, non-blocking handling of messages via@MessageMapping
methods. - MessageMappingMessageHandler() - Constructor for class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- MessageMappingReflectiveProcessor - Class in org.springframework.messaging.handler.annotation
-
ReflectiveProcessor
implementation for types annotated with@MessageMapping
,@SubscribeMapping
and@MessageExceptionHandler
. - MessageMappingReflectiveProcessor() - Constructor for class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- MessageMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
HandlerMethodArgumentResolver
forMessage
method arguments. - MessageMethodArgumentResolver() - Constructor for class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
-
Create a default resolver instance without message conversion.
- MessageMethodArgumentResolver(MessageConverter) - Constructor for class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
-
Create a resolver instance with the given
MessageConverter
. - MessagePostProcessor - Interface in org.springframework.messaging.core
-
A contract for processing a
Message
after it has been created, either returning a modified (effectively new) message or returning the same. - MessageReceivingOperations<D> - Interface in org.springframework.messaging.core
-
Operations for receiving messages from a destination.
- MessageRequestReplyOperations<D> - Interface in org.springframework.messaging.core
-
Operations for sending messages to and receiving the reply from a destination.
- MessageSendingOperations<D> - Interface in org.springframework.messaging.core
-
Operations for sending messages to a destination.
- MessagingAdviceBean - Interface in org.springframework.messaging.handler
-
Represents a Spring-managed bean with cross-cutting functionality to be applied to one or more Spring beans with annotation-based message handling methods.
- MessagingException - Exception in org.springframework.messaging
-
The base exception for any failures related to messaging.
- MessagingException(String) - Constructor for exception org.springframework.messaging.MessagingException
- MessagingException(String, Throwable) - Constructor for exception org.springframework.messaging.MessagingException
- MessagingException(Message<?>) - Constructor for exception org.springframework.messaging.MessagingException
- MessagingException(Message<?>, String) - Constructor for exception org.springframework.messaging.MessagingException
- MessagingException(Message<?>, String, Throwable) - Constructor for exception org.springframework.messaging.MessagingException
- MessagingException(Message<?>, Throwable) - Constructor for exception org.springframework.messaging.MessagingException
- metadata(Object, MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Begin to specify a new request with the given metadata value, which can be a concrete value or any producer of a single value that can be adapted to a
Publisher
viaReactiveAdapterRegistry
. - metadata(Object, MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.MetadataSpec
-
Use this to append additional metadata entries when using composite metadata.
- metadata(Consumer<RSocketRequester.MetadataSpec<?>>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RequestSpec
-
Append additional metadata entries through a
Consumer
. - MetadataArgumentResolver - Class in org.springframework.messaging.rsocket.service
-
RSocketServiceArgumentResolver
for metadata entries. - MetadataArgumentResolver() - Constructor for class org.springframework.messaging.rsocket.service.MetadataArgumentResolver
- metadataExtractor() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
RSocketStrategies.Builder.metadataExtractor(MetadataExtractor)
. - metadataExtractor(MetadataExtractor) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Configure a
MetadataExtractor
to extract the route along with other metadata. - MetadataExtractor - Interface in org.springframework.messaging.rsocket
-
Strategy to extract a map of value(s) from
Payload
metadata, which could be composite metadata with multiple entries. - metadataExtractorRegistry(Consumer<MetadataExtractorRegistry>) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Apply the consumer to the
MetadataExtractorRegistry
in order to register extra metadata entry extractors. - MetadataExtractorRegistry - Interface in org.springframework.messaging.rsocket
-
Stores registrations of extractors for metadata entries.
- metadataMimeType() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Return the metadata
MimeType
selected for the underlying RSocket at connection time. - metadataMimeType(MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Configure the payload metadata MimeType to specify on the
SETUP
frame that applies to the whole connection. - metadataToExtract(MimeType, Class<?>, String) - Method in interface org.springframework.messaging.rsocket.MetadataExtractorRegistry
-
Decode metadata entries with the given
MimeType
to the specified target class, and store the decoded value in the output map under the given name. - metadataToExtract(MimeType, Class<T>, BiConsumer<T, Map<String, Object>>) - Method in class org.springframework.messaging.rsocket.DefaultMetadataExtractor
- metadataToExtract(MimeType, Class<T>, BiConsumer<T, Map<String, Object>>) - Method in interface org.springframework.messaging.rsocket.MetadataExtractorRegistry
-
Variant of
MetadataExtractorRegistry.metadataToExtract(MimeType, Class, String)
that allows custom logic to be used to map the decoded value to any number of values in the output map. - metadataToExtract(MimeType, ParameterizedTypeReference<?>, String) - Method in interface org.springframework.messaging.rsocket.MetadataExtractorRegistry
-
Variant of
MetadataExtractorRegistry.metadataToExtract(MimeType, Class, String)
that acceptsParameterizedTypeReference
instead ofClass
for specifying a target type with generic parameters. - metadataToExtract(MimeType, ParameterizedTypeReference<T>, BiConsumer<T, Map<String, Object>>) - Method in class org.springframework.messaging.rsocket.DefaultMetadataExtractor
- metadataToExtract(MimeType, ParameterizedTypeReference<T>, BiConsumer<T, Map<String, Object>>) - Method in interface org.springframework.messaging.rsocket.MetadataExtractorRegistry
-
Variant of
MetadataExtractorRegistry.metadataToExtract(MimeType, Class, BiConsumer)
that acceptsParameterizedTypeReference
instead ofClass
for specifying a target type with generic parameters. - MethodArgumentNotValidException - Exception in org.springframework.messaging.handler.annotation.support
-
Exception to be thrown when a method argument fails validation perhaps as a result of
@Valid
style validation, or perhaps because it is required. - MethodArgumentNotValidException(Message<?>, MethodParameter) - Constructor for exception org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException
-
Create a new instance with the invalid
MethodParameter
. - MethodArgumentNotValidException(Message<?>, MethodParameter, BindingResult) - Constructor for exception org.springframework.messaging.handler.annotation.support.MethodArgumentNotValidException
-
Create a new instance with the invalid
MethodParameter
and aBindingResult
. - MethodArgumentResolutionException - Exception in org.springframework.messaging.handler.invocation
-
Common exception resulting from the invocation of
HandlerMethodArgumentResolver
. - MethodArgumentResolutionException(Message<?>, MethodParameter) - Constructor for exception org.springframework.messaging.handler.invocation.MethodArgumentResolutionException
-
Create a new instance providing the invalid
MethodParameter
. - MethodArgumentResolutionException(Message<?>, MethodParameter, String) - Constructor for exception org.springframework.messaging.handler.invocation.MethodArgumentResolutionException
-
Create a new instance providing the invalid
MethodParameter
and a prepared description. - MethodArgumentResolutionException(Message<?>, MethodParameter, String, Throwable) - Constructor for exception org.springframework.messaging.handler.invocation.MethodArgumentResolutionException
-
Create a new instance providing the invalid
MethodParameter
, prepared description, and a cause. - MethodArgumentTypeMismatchException - Exception in org.springframework.messaging.handler.annotation.support
-
Exception that indicates that a method argument has not the expected type.
- MethodArgumentTypeMismatchException(Message<?>, MethodParameter, String) - Constructor for exception org.springframework.messaging.handler.annotation.support.MethodArgumentTypeMismatchException
- MissingSessionUserException - Exception in org.springframework.messaging.simp.annotation.support
-
MessagingException
thrown when a session is missing. - MissingSessionUserException(Message<?>) - Constructor for exception org.springframework.messaging.simp.annotation.support.MissingSessionUserException
- MultiServerUserRegistry - Class in org.springframework.messaging.simp.user
-
SimpUserRegistry
that looks up users in a "local" user registry as well as a set of "remote" user registries. - MultiServerUserRegistry(SimpUserRegistry) - Constructor for class org.springframework.messaging.simp.user.MultiServerUserRegistry
-
Create an instance wrapping the local user registry.
- mutate() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return a builder to create a new
RSocketStrategies
instance replicated from the current instance.
N
- NACK - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- name() - Element in annotation interface org.springframework.messaging.handler.annotation.Header
-
The name of the request header to bind to.
- NamedValueInfo(String, boolean, String) - Constructor for class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver.NamedValueInfo
- NamedValueInfo(String, boolean, String) - Constructor for class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver.NamedValueInfo
- NATIVE_HEADERS - Static variable in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
The header name used to store native headers.
- NativeMessageHeaderAccessor - Class in org.springframework.messaging.support
-
MessageHeaderAccessor
subclass that supports storage and access of headers from an external source such as a message broker. - NativeMessageHeaderAccessor() - Constructor for class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Protected constructor to create a new instance.
- NativeMessageHeaderAccessor(Map<String, List<String>>) - Constructor for class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Protected constructor to create an instance with the given native headers.
- NativeMessageHeaderAccessor(Message<?>) - Constructor for class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Protected constructor that copies headers from another message.
O
- obtainRouteMatcher() - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Obtain the
RouteMatcher
for actual use. - onApplicationEvent(ApplicationEvent) - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- onApplicationEvent(BrokerAvailabilityEvent) - Method in class org.springframework.messaging.simp.user.UserRegistryMessageHandler
- onReadInactivity(Runnable, long) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- onReadInactivity(Runnable, long) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- onReadInactivity(Runnable, long) - Method in interface org.springframework.messaging.tcp.TcpConnection
-
Register a task to invoke after a period of read inactivity.
- onWriteInactivity(Runnable, long) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- onWriteInactivity(Runnable, long) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- onWriteInactivity(Runnable, long) - Method in interface org.springframework.messaging.tcp.TcpConnection
-
Register a task to invoke after a period of write inactivity.
- OrderedMessageChannelDecorator - Class in org.springframework.messaging.simp.broker
-
Decorator for an
ExecutorSubscribableChannel
that ensures messages are processed in the order they were published to the channel. - OrderedMessageChannelDecorator(MessageChannel, Log) - Constructor for class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
- org.springframework.messaging - package org.springframework.messaging
-
Support for working with messaging APIs and protocols.
- org.springframework.messaging.converter - package org.springframework.messaging.converter
-
Provides support for message conversion.
- org.springframework.messaging.core - package org.springframework.messaging.core
-
Defines interfaces and implementation classes for messaging templates.
- org.springframework.messaging.handler - package org.springframework.messaging.handler
-
Basic abstractions for working with message handler methods.
- org.springframework.messaging.handler.annotation - package org.springframework.messaging.handler.annotation
-
Annotations and support classes for handling messages.
- org.springframework.messaging.handler.annotation.reactive - package org.springframework.messaging.handler.annotation.reactive
-
Support classes for working with annotated message-handling methods with non-blocking, reactive contracts.
- org.springframework.messaging.handler.annotation.support - package org.springframework.messaging.handler.annotation.support
-
Support classes for working with annotated message-handling methods.
- org.springframework.messaging.handler.invocation - package org.springframework.messaging.handler.invocation
-
Common infrastructure for invoking message handler methods.
- org.springframework.messaging.handler.invocation.reactive - package org.springframework.messaging.handler.invocation.reactive
-
Common infrastructure for invoking message handler methods with non-blocking, and reactive contracts.
- org.springframework.messaging.rsocket - package org.springframework.messaging.rsocket
-
Support for the RSocket protocol.
- org.springframework.messaging.rsocket.annotation - package org.springframework.messaging.rsocket.annotation
-
Annotations and support classes for handling RSocket streams.
- org.springframework.messaging.rsocket.annotation.support - package org.springframework.messaging.rsocket.annotation.support
-
Support classes for working with annotated RSocket stream handling methods.
- org.springframework.messaging.rsocket.service - package org.springframework.messaging.rsocket.service
-
Annotations to declare an RSocket service contract with request methods along with a proxy factory backed by an
RSocketRequester
. - org.springframework.messaging.simp - package org.springframework.messaging.simp
-
Generic support for Simple Messaging Protocols including protocols such as STOMP.
- org.springframework.messaging.simp.annotation - package org.springframework.messaging.simp.annotation
-
Annotations and for handling messages from SImple Messaging Protocols such as STOMP.
- org.springframework.messaging.simp.annotation.support - package org.springframework.messaging.simp.annotation.support
-
Support classes for handling messages from simple messaging protocols (like STOMP).
- org.springframework.messaging.simp.broker - package org.springframework.messaging.simp.broker
-
Provides a "simple" message broker implementation along with an abstract base class and other supporting types such as a registry for subscriptions.
- org.springframework.messaging.simp.config - package org.springframework.messaging.simp.config
-
Configuration support for WebSocket messaging using higher level messaging protocols.
- org.springframework.messaging.simp.stomp - package org.springframework.messaging.simp.stomp
-
Generic support for simple messaging protocols (like STOMP).
- org.springframework.messaging.simp.user - package org.springframework.messaging.simp.user
-
Support for handling messages to "user" destinations (i.e.
- org.springframework.messaging.support - package org.springframework.messaging.support
-
Provides implementations of
Message
along with a MessageBuilder and MessageHeaderAccessor for building and working with messages and message headers, as well as variousMessageChannel
implementations and channel interceptor support. - org.springframework.messaging.tcp - package org.springframework.messaging.tcp
-
Contains abstractions and implementation classes for establishing TCP connections via
TcpOperations
, handling messages viaTcpConnectionHandler
, as well as sending messages viaTcpConnection
. - org.springframework.messaging.tcp.reactor - package org.springframework.messaging.tcp.reactor
-
Contains support for TCP messaging based on Reactor.
- ORIGINAL_DESTINATION - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
A header for internal use with "user" destinations where we need to restore the destination prior to sending messages to clients.
- OTHER - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
P
- PASSCODE - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- Payload - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation that binds a method parameter to the payload of a message.
- PayloadArgumentResolver - Class in org.springframework.messaging.rsocket.service
-
RSocketServiceArgumentResolver
for@Payload
annotated arguments. - PayloadArgumentResolver(ReactiveAdapterRegistry, boolean) - Constructor for class org.springframework.messaging.rsocket.service.PayloadArgumentResolver
- PayloadMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.reactive
-
A resolver to extract and decode the payload of a message using a
Decoder
, where the payload is expected to be aPublisher
ofDataBuffer
. - PayloadMethodArgumentResolver - Class in org.springframework.messaging.handler.annotation.support
-
A resolver to extract and convert the payload of a message using a
MessageConverter
. - PayloadMethodArgumentResolver(List<? extends Decoder<?>>, Validator, ReactiveAdapterRegistry, boolean) - Constructor for class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
- PayloadMethodArgumentResolver(MessageConverter) - Constructor for class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
-
Create a new
PayloadArgumentResolver
with the givenMessageConverter
. - PayloadMethodArgumentResolver(MessageConverter, Validator) - Constructor for class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
- PayloadMethodArgumentResolver(MessageConverter, Validator, boolean) - Constructor for class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
- PayloadUtils - Class in org.springframework.messaging.rsocket
-
Static utility methods to create
Payload
fromDataBuffer
s and vice versa. - PayloadUtils() - Constructor for class org.springframework.messaging.rsocket.PayloadUtils
- PollableChannel - Interface in org.springframework.messaging
-
A
MessageChannel
from which messages may be actively received through polling. - postProcessMessage(Message<?>) - Method in interface org.springframework.messaging.core.MessagePostProcessor
-
Process the given message.
- postReceive(Message<?>, MessageChannel) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked immediately after a Message has been retrieved but before it is returned to the caller.
- postSend(Message<?>, MessageChannel, boolean) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked immediately after the send invocation.
- preReceive(MessageChannel) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked as soon as receive is called and before a Message is actually retrieved.
- preSend(Message<?>, MessageChannel) - Method in interface org.springframework.messaging.support.ChannelInterceptor
-
Invoked before the Message is actually sent to the channel.
- preSend(Message<?>, MessageChannel) - Method in class org.springframework.messaging.support.ImmutableMessageChannelInterceptor
- PrincipalMethodArgumentResolver - Class in org.springframework.messaging.simp.annotation.support
-
Resolver for arguments of type
Principal
, includingOptional<Principal>
. - PrincipalMethodArgumentResolver() - Constructor for class org.springframework.messaging.simp.annotation.support.PrincipalMethodArgumentResolver
- processConnectHeaders(StompHeaders) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Further initialize the StompHeaders, for example setting the heart-beat header if necessary.
- processDestinations(String[]) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Resolve placeholders in the given destinations.
- processHandlerMethodException(HandlerMethod, Exception, Message<?>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- processHeadersToSend(Map<String, Object>) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Provides access to the map of input headers before a send operation.
- processHeadersToSend(Map<String, Object>) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Creates a new map and puts the given headers under the key
NATIVE_HEADERS
. - PROTOBUF - Static variable in class org.springframework.messaging.converter.ProtobufMessageConverter
-
The mime-type for protobuf
application/x-protobuf
. - ProtobufJsonFormatMessageConverter - Class in org.springframework.messaging.converter
-
Subclass of
ProtobufMessageConverter
for use with the official"com.google.protobuf:protobuf-java-util"
library for JSON support. - ProtobufJsonFormatMessageConverter(ExtensionRegistry) - Constructor for class org.springframework.messaging.converter.ProtobufJsonFormatMessageConverter
-
Constructor with default instances of
JsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. - ProtobufJsonFormatMessageConverter(JsonFormat.Parser, JsonFormat.Printer) - Constructor for class org.springframework.messaging.converter.ProtobufJsonFormatMessageConverter
-
Constructor with given instances of
JsonFormat.Parser
,JsonFormat.Printer
, and a default instance ofExtensionRegistry
. - ProtobufJsonFormatMessageConverter(JsonFormat.Parser, JsonFormat.Printer, ExtensionRegistry) - Constructor for class org.springframework.messaging.converter.ProtobufJsonFormatMessageConverter
-
Constructor with given instances of
JsonFormat.Parser
,JsonFormat.Printer
, andExtensionRegistry
. - ProtobufMessageConverter - Class in org.springframework.messaging.converter
-
An
MessageConverter
that reads and writescom.google.protobuf.Messages
using Google Protocol Buffers. - ProtobufMessageConverter() - Constructor for class org.springframework.messaging.converter.ProtobufMessageConverter
-
Constructor with a default instance of
ExtensionRegistry
. - ProtobufMessageConverter(ExtensionRegistry) - Constructor for class org.springframework.messaging.converter.ProtobufMessageConverter
-
Constructor with a given
ExtensionRegistry
. - publishBrokerAvailableEvent() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- publishBrokerUnavailableEvent() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- put(String, Object) - Method in class org.springframework.messaging.MessageHeaders
-
Since MessageHeaders are immutable, the call to this method will result in
UnsupportedOperationException
. - put(String, List<String>) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- putAll(Map<? extends String, ? extends Object>) - Method in class org.springframework.messaging.MessageHeaders
-
Since MessageHeaders are immutable, the call to this method will result in
UnsupportedOperationException
. - putAll(Map<? extends String, ? extends List<String>>) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
Q
- queueCapacity(int) - Method in class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Set the queue capacity for the ThreadPoolExecutor.
R
- reactiveAdapterRegistry() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
reactiveAdapterRegistry
. - reactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Set the
ReactiveAdapterRegistry
to use to support different asynchronous types for HTTP service method return values. - reactiveAdapterStrategy(ReactiveAdapterRegistry) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Configure the registry for reactive type support.
- ReactiveMessageHandler - Interface in org.springframework.messaging
-
Reactive contract for handling a
Message
. - ReactiveReturnValueHandler - Class in org.springframework.messaging.handler.invocation
-
Support for single-value reactive types (like
Mono
orSingle
) as a return value type. - ReactiveReturnValueHandler() - Constructor for class org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- ReactiveReturnValueHandler(ReactiveAdapterRegistry) - Constructor for class org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- ReactorNetty2TcpClient<P> - Class in org.springframework.messaging.tcp.reactor
-
Reactor Netty based implementation of
TcpOperations
. - ReactorNetty2TcpClient(String, int, TcpMessageCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
Simple constructor with the host and port to use to connect to.
- ReactorNetty2TcpClient(Function<TcpClient, TcpClient>, TcpMessageCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
A variant of
ReactorNetty2TcpClient(String, int, TcpMessageCodec)
that still manages the lifecycle of theTcpClient
and underlying resources, but allows for direct configuration of other properties of the client through aFunction<TcpClient, TcpClient>
. - ReactorNetty2TcpClient(TcpClient, TcpMessageCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
Constructor with an externally created
TcpClient
instance whose lifecycle is expected to be managed externally. - ReactorNetty2TcpConnection<P> - Class in org.springframework.messaging.tcp.reactor
-
Reactor Netty based implementation of
TcpConnection
. - ReactorNetty2TcpConnection(NettyInbound, NettyOutbound, TcpMessageCodec<P>, Sinks.Empty<Void>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- ReactorNettyCodec<P> - Interface in org.springframework.messaging.tcp.reactor
-
Simple holder for a decoding
Function
and an encodingBiConsumer
to use with Reactor Netty. - ReactorNettyTcpClient<P> - Class in org.springframework.messaging.tcp.reactor
-
Reactor Netty based implementation of
TcpOperations
. - ReactorNettyTcpClient(String, int, ReactorNettyCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
Simple constructor with the host and port to use to connect to.
- ReactorNettyTcpClient(Function<TcpClient, TcpClient>, ReactorNettyCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
A variant of
ReactorNettyTcpClient(String, int, ReactorNettyCodec)
that still manages the lifecycle of theTcpClient
and underlying resources, but allows for direct configuration of other properties of the client through aFunction<TcpClient, TcpClient>
. - ReactorNettyTcpClient(TcpClient, ReactorNettyCodec<P>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
Constructor with an externally created
TcpClient
instance whose lifecycle is expected to be managed externally. - ReactorNettyTcpConnection<P> - Class in org.springframework.messaging.tcp.reactor
-
Reactor Netty based implementation of
TcpConnection
. - ReactorNettyTcpConnection(NettyInbound, NettyOutbound, ReactorNettyCodec<P>, Sinks.Empty<Void>) - Constructor for class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- ReactorNettyTcpStompClient - Class in org.springframework.messaging.simp.stomp
-
A STOMP over TCP client, configurable with either
ReactorNettyTcpClient
orReactorNetty2TcpClient
. - ReactorNettyTcpStompClient() - Constructor for class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Create an instance with host "127.0.0.1" and port 61613.
- ReactorNettyTcpStompClient(String, int) - Constructor for class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Create an instance with the given host and port.
- ReactorNettyTcpStompClient(TcpOperations<byte[]>) - Constructor for class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Create an instance with a pre-configured TCP client.
- readOnlyStompHeaders(Map<String, List<String>>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Return a
StompHeaders
object that can only be read, not written to. - RECEIPT - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- RECEIPT - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- RECEIPT_ID - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- receive() - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
- receive() - Method in interface org.springframework.messaging.core.MessageReceivingOperations
-
Receive a message from a default destination.
- receive() - Method in interface org.springframework.messaging.PollableChannel
-
Receive a message from this channel, blocking indefinitely if necessary.
- receive(long) - Method in interface org.springframework.messaging.PollableChannel
-
Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.
- receive(D) - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
- receive(D) - Method in interface org.springframework.messaging.core.MessageReceivingOperations
-
Receive a message from the given destination.
- receive(String) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- receive(String) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations
-
Resolve the given destination name and receive a message from it.
- receiveAndConvert(D, Class<T>) - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
- receiveAndConvert(D, Class<T>) - Method in interface org.springframework.messaging.core.MessageReceivingOperations
-
Receive a message from the given destination and convert its payload to the specified target class.
- receiveAndConvert(Class<T>) - Method in class org.springframework.messaging.core.AbstractMessageReceivingTemplate
- receiveAndConvert(Class<T>) - Method in interface org.springframework.messaging.core.MessageReceivingOperations
-
Receive a message from a default destination and convert its payload to the specified target class.
- receiveAndConvert(String, Class<T>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- receiveAndConvert(String, Class<T>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageReceivingOperations
-
Resolve the given destination name, receive a message from it, convert the payload to the specified target type.
- ReconnectStrategy - Interface in org.springframework.messaging.tcp
-
A contract to determine the frequency of reconnect attempts after connection failure.
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.messaging.simp.SimpAttributes
-
Register a callback to execute on destruction of the specified attribute.
- registerDestructionCallback(String, Runnable) - Method in class org.springframework.messaging.simp.SimpSessionScope
- registerExceptionHandlerAdvice(MessagingAdviceBean, AbstractExceptionHandlerMethodResolver) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Subclasses can invoke this method to populate the MessagingAdviceBean cache (e.g.
- registerExceptionHandlerAdvice(MessagingAdviceBean, AbstractExceptionHandlerMethodResolver) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Subclasses can invoke this method to populate the MessagingAdviceBean cache (e.g.
- registerHandlerMethod(Object, Method, T) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Register a handler method and its unique mapping.
- registerHandlerMethod(Object, Method, T) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Register a handler method and its unique mapping.
- registerMessageExceptionHandlerHints(ReflectionHints, MessageExceptionHandler) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- registerMessagingAdvice(MessagingAdviceBean) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Use this method to register a
MessagingAdviceBean
that may contain globally applicable@MessageExceptionHandler
methods. - registerMethodHints(ReflectionHints, Method) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- registerParameterHints(ReflectionHints, Method) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- registerReflectionHints(ReflectionHints, AnnotatedElement) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- registerReturnValueHints(ReflectionHints, Method) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- registerSubscription(Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- registerSubscription(Message<?>) - Method in interface org.springframework.messaging.simp.broker.SubscriptionRegistry
-
Register a subscription represented by the given message.
- registerTypeHints(ReflectionHints, Class<?>) - Method in class org.springframework.messaging.handler.annotation.MessageMappingReflectiveProcessor
- remove(Object) - Method in class org.springframework.messaging.MessageHeaders
-
Since MessageHeaders are immutable, the call to this method will result in
UnsupportedOperationException
. - remove(Object) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- remove(String) - Method in class org.springframework.messaging.simp.SimpSessionScope
- removeAttribute(String) - Method in class org.springframework.messaging.simp.SimpAttributes
-
Remove the attribute of the given name, if it exists.
- removeHeader(String) - Method in class org.springframework.messaging.support.MessageBuilder
-
Remove the value for the given header name.
- removeHeader(String) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Remove the value for the given header name.
- removeHeaders(String...) - Method in class org.springframework.messaging.support.MessageBuilder
-
Removes all headers provided via array of 'headerPatterns'.
- removeHeaders(String...) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Removes all headers provided via array of 'headerPatterns'.
- removeInterceptor(int) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- removeInterceptor(int) - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Remove the interceptor at the given index.
- removeInterceptor(ChannelInterceptor) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- removeInterceptor(ChannelInterceptor) - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Remove the given interceptor.
- removeNativeHeader(String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Remove the specified native header value replacing existing values.
- removeSubscriptionInternal(String, String, Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- removeSubscriptionInternal(String, String, Message<?>) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
- REPLY_CHANNEL - Static variable in class org.springframework.messaging.MessageHeaders
-
The key for the message reply channel.
- REQUEST_CHANNEL_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Match RSocket frame "REQUEST_CHANNEL".
- REQUEST_FNF_OR_RESPONSE_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Match RSocket frames "REQUEST_FNF" or "REQUEST_RESPONSE".
- REQUEST_RESPONSE_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Match RSocket frame "REQUEST_RESPONSE".
- REQUEST_STREAM_CONDITION - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
-
Match RSocket frame "REQUEST_STREAM".
- required() - Element in annotation interface org.springframework.messaging.handler.annotation.Header
-
Whether the header is required.
- required() - Element in annotation interface org.springframework.messaging.handler.annotation.Payload
-
Whether payload content is required.
- requiresContentLength() - Method in enum class org.springframework.messaging.simp.stomp.StompCommand
- requiresDestination() - Method in enum class org.springframework.messaging.simp.stomp.StompCommand
- requiresSubscriptionId() - Method in enum class org.springframework.messaging.simp.stomp.StompCommand
- resetAttributes() - Static method in class org.springframework.messaging.simp.SimpAttributesContextHolder
-
Reset the SimpAttributes for the current thread.
- resolve(Object, MethodParameter, RSocketRequestValues.Builder) - Method in class org.springframework.messaging.rsocket.service.DestinationVariableArgumentResolver
- resolve(Object, MethodParameter, RSocketRequestValues.Builder) - Method in class org.springframework.messaging.rsocket.service.MetadataArgumentResolver
- resolve(Object, MethodParameter, RSocketRequestValues.Builder) - Method in class org.springframework.messaging.rsocket.service.PayloadArgumentResolver
- resolve(Object, MethodParameter, RSocketRequestValues.Builder) - Method in interface org.springframework.messaging.rsocket.service.RSocketServiceArgumentResolver
-
Resolve the argument value.
- resolve(MessageHeaders) - Method in interface org.springframework.messaging.converter.ContentTypeResolver
-
Determine the
MimeType
of a message from the given MessageHeaders. - resolve(MessageHeaders) - Method in class org.springframework.messaging.converter.DefaultContentTypeResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.ContinuationHandlerMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
-
Decode the content of the given message payload through a compatible
Decoder
. - resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.HeadersMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver
-
Resolves a method parameter into an argument value from a given message.
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. - resolveArgument(MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolver
-
Resolves a method parameter into an argument value from a given message.
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Iterate over registered
HandlerMethodArgumentResolvers
and invoke the one that supports it. - resolveArgument(MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.reactive.SyncHandlerMethodArgumentResolver
-
Resolves a method parameter into an argument value from a given message.
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketRequesterMethodArgumentResolver
- resolveArgument(MethodParameter, Message<?>) - Method in class org.springframework.messaging.simp.annotation.support.PrincipalMethodArgumentResolver
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver
-
Resolves the given parameter type and value name into an argument value.
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.reactive.HeaderMethodArgumentResolver
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver
-
Resolves the given parameter type and value name into an argument value.
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
- resolveArgumentInternal(MethodParameter, Message<?>, String) - Method in class org.springframework.messaging.handler.annotation.support.HeaderMethodArgumentResolver
- resolveArgumentValue(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.AbstractNamedValueMethodArgumentResolver
- resolveArgumentValue(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.reactive.HeadersMethodArgumentResolver
- resolveArgumentValue(MethodParameter, Message<?>) - Method in interface org.springframework.messaging.handler.invocation.reactive.SyncHandlerMethodArgumentResolver
-
Resolve the value for the method parameter synchronously.
- resolveBean() - Method in interface org.springframework.messaging.handler.MessagingAdviceBean
-
Return the advice bean instance, if necessary resolving a bean specified by name through the BeanFactory.
- resolveContextualObject(String) - Method in class org.springframework.messaging.simp.SimpSessionScope
- resolveDestination(String) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- resolveDestination(String) - Method in class org.springframework.messaging.core.BeanFactoryMessageChannelDestinationResolver
- resolveDestination(String) - Method in class org.springframework.messaging.core.CachingDestinationResolverProxy
-
Resolves and caches destinations if successfully resolved by the target DestinationResolver implementation.
- resolveDestination(String) - Method in interface org.springframework.messaging.core.DestinationResolver
-
Resolve the given destination name.
- resolveDestination(Message<?>) - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
- resolveDestination(Message<?>) - Method in interface org.springframework.messaging.simp.user.UserDestinationResolver
-
Resolve the given message with a user destination to one or more messages with actual destinations, one for each active user session.
- resolveEmbeddedValuesInDestinations(String[]) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Resolve placeholder values in the given array of destinations.
- resolveMethod(Throwable) - Method in class org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver
-
Find a
Method
to handle the given exception. - resolveMethodByExceptionType(Class<? extends Throwable>) - Method in class org.springframework.messaging.handler.invocation.AbstractExceptionHandlerMethodResolver
-
Find a
Method
to handle the given exception type. - resolveTargetClass(MethodParameter, Message<?>) - Method in class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
-
Resolve the target class to convert the payload to.
- responder() - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Return an RSocket
SocketAcceptor
backed by thisRSocketMessageHandler
instance that can be plugged in as aclient
orserver
RSocket responder. - responder(RSocketStrategies, Object...) - Static method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Static factory method to create an RSocket
SocketAcceptor
backed by handlers with annotated methods. - RESPONSE_HEADER - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketPayloadReturnValueHandler
-
Message header name that is expected to have an
AtomicReference
which will receive theFlux<Payload>
that represents the response. - retainDataAndReleasePayload(Payload, DataBufferFactory) - Static method in class org.springframework.messaging.rsocket.PayloadUtils
-
Use this method to slice, retain and wrap the data portion of the
Payload
, and also to release thePayload
. - retrieveFlux(Class<T>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec
-
Perform an
requestStream
or arequestChannel
exchange depending on whether the request input is single or multi-payload. - retrieveFlux(ParameterizedTypeReference<T>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec
-
Variant of
RSocketRequester.RetrieveSpec.retrieveFlux(Class)
for when the dataType has to have a generic type. - retrieveMono(Class<T>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec
-
Perform a
requestResponse
exchange. - retrieveMono(ParameterizedTypeReference<T>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec
-
Variant of
RSocketRequester.RetrieveSpec.retrieveMono(Class)
for when the dataType has to have a generic type. - ReturnValueHandlerConfigurer - Class in org.springframework.messaging.handler.invocation.reactive
-
Assist with configuration for handler method return value handlers.
- ReturnValueHandlerConfigurer() - Constructor for class org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer
- route(String, Object...) - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Begin to specify a new request with the given route to a remote handler.
- ROUTE_KEY - Static variable in interface org.springframework.messaging.rsocket.MetadataExtractor
-
The key to assign to the extracted "route" of the payload.
- routeMatcher() - Method in interface org.springframework.messaging.rsocket.RSocketStrategies
-
Return the configured
RSocketStrategies.Builder.routeMatcher(RouteMatcher)
. - routeMatcher(RouteMatcher) - Method in interface org.springframework.messaging.rsocket.RSocketStrategies.Builder
-
Configure a
RouteMatcher
for matching routes to message handlers based on route patterns. - rsocket() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Return the underlying
RSocket
if the requester was created with a "live" RSocket viaRSocketRequester.wrap(RSocket, MimeType, MimeType, RSocketStrategies)
or via one of the (deprecated) connect methods on theRSocketRequester
builder, or otherwise returnnull
. - RSOCKET_REQUESTER_HEADER - Static variable in class org.springframework.messaging.rsocket.annotation.support.RSocketRequesterMethodArgumentResolver
-
Message header name that is expected to have the
RSocket
to initiate new interactions to the remote peer with. - rsocketClient() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Return the underlying
RSocketClient
used to make requests with. - rsocketConnector(RSocketConnectorConfigurer) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Callback to configure the
RSocketConnector
directly. - RSocketConnectorConfigurer - Interface in org.springframework.messaging.rsocket
-
Strategy to apply configuration to an
RSocketConnector
. - RSocketExchange - Annotation Interface in org.springframework.messaging.rsocket.service
-
Annotation to declare an RSocket endpoint on an RSocket service interface.
- RSocketFrameTypeMessageCondition - Class in org.springframework.messaging.rsocket.annotation.support
-
A condition to assist with mapping onto handler methods based on the RSocket frame type.
- RSocketFrameTypeMessageCondition(FrameType...) - Constructor for class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- RSocketFrameTypeMessageCondition(Collection<FrameType>) - Constructor for class org.springframework.messaging.rsocket.annotation.support.RSocketFrameTypeMessageCondition
- RSocketMessageHandler - Class in org.springframework.messaging.rsocket.annotation.support
-
Extension of
MessageMappingMessageHandler
to handle RSocket requests with@MessageMapping
and@ConnectMapping
methods, also supporting use of@RSocketExchange
. - RSocketMessageHandler() - Constructor for class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
- RSocketPayloadReturnValueHandler - Class in org.springframework.messaging.rsocket.annotation.support
-
Extension of
AbstractEncoderMethodReturnValueHandler
thathandles
encoded content by wrapping data buffers as RSocket payloads and by passing those through theRSocketPayloadReturnValueHandler.RESPONSE_HEADER
header. - RSocketPayloadReturnValueHandler(List<Encoder<?>>, ReactiveAdapterRegistry) - Constructor for class org.springframework.messaging.rsocket.annotation.support.RSocketPayloadReturnValueHandler
- rsocketRequester(RSocketRequester) - Method in class org.springframework.messaging.rsocket.service.RSocketServiceProxyFactory.Builder
-
Provide the requester to perform requests through.
- RSocketRequester - Interface in org.springframework.messaging.rsocket
-
A thin wrapper around a sending
RSocket
with a fluent API accepting and returning higher level Objects for input and for output, along with methods to prepare routing and other metadata. - RSocketRequester.Builder - Interface in org.springframework.messaging.rsocket
-
Builder to create a requester by connecting to a server.
- RSocketRequester.MetadataSpec<S extends RSocketRequester.MetadataSpec<S>> - Interface in org.springframework.messaging.rsocket
-
Spec for providing additional composite metadata entries.
- RSocketRequester.RequestSpec - Interface in org.springframework.messaging.rsocket
-
Spec to declare the input for an RSocket request.
- RSocketRequester.RetrieveSpec - Interface in org.springframework.messaging.rsocket
-
Spec to declare the expected output for an RSocket request.
- RSocketRequesterMethodArgumentResolver - Class in org.springframework.messaging.rsocket.annotation.support
-
Resolves arguments of type
RSocket
that can be used for making requests to the remote peer. - RSocketRequesterMethodArgumentResolver() - Constructor for class org.springframework.messaging.rsocket.annotation.support.RSocketRequesterMethodArgumentResolver
- RSocketRequestValues - Class in org.springframework.messaging.rsocket.service
-
Container for RSocket request values extracted from an
@RSocketExchange
-annotated method and argument values passed to it. - RSocketRequestValues(String, List<Object>, RSocketRequestValues.MetadataHelper, Object, Publisher<?>, ParameterizedTypeReference<?>) - Constructor for class org.springframework.messaging.rsocket.service.RSocketRequestValues
- RSocketRequestValues.Builder - Class in org.springframework.messaging.rsocket.service
-
Builder for
RSocketRequestValues
. - RSocketServiceArgumentResolver - Interface in org.springframework.messaging.rsocket.service
-
Resolve an argument from an
@RSocketExchange
-annotated method to one or more RSocket request values. - RSocketServiceProxyFactory - Class in org.springframework.messaging.rsocket.service
-
Factory to create a client proxy from an RSocket service interface with
@RSocketExchange
methods. - RSocketServiceProxyFactory.Builder - Class in org.springframework.messaging.rsocket.service
-
Builder to create an
RSocketServiceProxyFactory
. - rsocketStrategies(Consumer<RSocketStrategies.Builder>) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Customize the
RSocketStrategies
. - rsocketStrategies(RSocketStrategies) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Provide the
RSocketStrategies
to use. - RSocketStrategies - Interface in org.springframework.messaging.rsocket
-
Access to strategies for use by RSocket requester and responder components.
- RSocketStrategies.Builder - Interface in org.springframework.messaging.rsocket
-
The builder options for creating
RSocketStrategies
.
S
- send() - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec
-
Perform a
fireAndForget
sending the provided data and metadata. - send(D, Message<?>) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- send(D, Message<?>) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Send a message to the given destination.
- send(String, Object) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- send(String, Object) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Send a message to the specified destination, converting the payload to a
byte[]
with the help of aMessageConverter
. - send(String, Message<?>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- send(String, Message<?>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageSendingOperations
-
Resolve the given destination name to a destination and send a message to it.
- send(Message<?>) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
- send(Message<?>) - Method in interface org.springframework.messaging.core.MessageSendingOperations
-
Send a message to a default destination.
- send(Message<?>) - Method in interface org.springframework.messaging.MessageChannel
-
Send a
Message
to this channel. - send(Message<?>) - Method in class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
- send(Message<?>) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
If the headers of the given message already contain a
SimpMessageHeaderAccessor#DESTINATION_HEADER
then the message is sent without further changes. - send(Message<?>) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- send(Message<?>, long) - Method in interface org.springframework.messaging.MessageChannel
-
Send a message, blocking until either the message is accepted or the specified timeout period elapses.
- send(Message<?>, long) - Method in class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
- send(Message<?>, long) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- send(Message<P>) - Method in interface org.springframework.messaging.tcp.TcpConnection
-
Deprecated.as of 6.0, in favor of
TcpConnection.sendAsync(Message)
- send(StompHeaders, Object) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- send(StompHeaders, Object) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
An overloaded version of
StompSession.send(String, Object)
with fullStompHeaders
instead of just a destination. - SEND - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- sendAndReceive(D, Message<?>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- sendAndReceive(D, Message<?>) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Send a request message and receive the reply from the given destination.
- sendAndReceive(String, Message<?>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
- sendAndReceive(String, Message<?>) - Method in interface org.springframework.messaging.core.DestinationResolvingMessageRequestReplyOperations
-
Resolve the given destination name to a destination and send the given message, receive a reply and return it.
- sendAndReceive(Message<?>) - Method in class org.springframework.messaging.core.AbstractMessagingTemplate
- sendAndReceive(Message<?>) - Method in interface org.springframework.messaging.core.MessageRequestReplyOperations
-
Send a request message and receive the reply from a default destination.
- sendAsync(Message<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- sendAsync(Message<P>) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- sendAsync(Message<P>) - Method in interface org.springframework.messaging.tcp.TcpConnection
-
Send the given message.
- sendInternal(Message<?>, long) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- sendInternal(Message<?>, long) - Method in class org.springframework.messaging.support.ExecutorSubscribableChannel
- sendMessageToSubscribers(String, Message<?>) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- sendMetadata() - Method in interface org.springframework.messaging.rsocket.RSocketRequester.RequestSpec
-
Perform a
metadataPush
. - SendTo - Annotation Interface in org.springframework.messaging.handler.annotation
-
Annotation that indicates a method's return value should be converted to a
Message
if necessary and sent to the specified destination. - SendToMethodReturnValueHandler - Class in org.springframework.messaging.simp.annotation.support
-
A
HandlerMethodReturnValueHandler
for sending to destinations specified in aSendTo
orSendToUser
method-level annotations. - SendToMethodReturnValueHandler(SimpMessageSendingOperations, boolean) - Constructor for class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- SendToUser - Annotation Interface in org.springframework.messaging.simp.annotation
-
Indicates the return value of a message-handling method should be sent as a
Message
to the specified destination(s) further prepended with"/user/{username}"
where the user name is extracted from the headers of the input message being handled. - SERVER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- SESSION - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- SESSION_ATTRIBUTES - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- SESSION_COMPLETED_NAME - Static variable in class org.springframework.messaging.simp.SimpAttributes
-
Key set after the session is completed.
- SESSION_ID_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- SESSION_MUTEX_NAME - Static variable in class org.springframework.messaging.simp.SimpAttributes
-
Key for the mutex session attribute.
- sessionCompleted() - Method in class org.springframework.messaging.simp.SimpAttributes
-
Invoked when the session is completed.
- set(String, String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the given, single header value under the given name.
- setAcceptVersion(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setAcceptVersion(String...) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the accept-version header.
- setAck(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setAck(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the ack header to one of "auto", "client", or "client-individual".
- setAll(Map<String, String>) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- setApplicationContext(ApplicationContext) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- setApplicationContext(ApplicationContext) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- setApplicationContext(ApplicationContext) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- setApplicationDestinationPrefixes(String...) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Configure one or more prefixes to filter destinations targeting application annotated methods.
- setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- setArgumentResolverConfigurer(ArgumentResolverConfigurer) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Configure custom resolvers for handler method arguments.
- setArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
Configure the complete list of supported argument types effectively overriding the ones configured by default.
- setArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Configure the complete list of supported argument types, effectively overriding the ones configured by default.
- setArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Configure the argument resolvers to use for resolving method argument values against a
ServerWebExchange
. - setAttribute(String, Object) - Method in class org.springframework.messaging.simp.SimpAttributes
-
Set the value with the given name replacing an existing value (if any).
- setAttributes(SimpAttributes) - Static method in class org.springframework.messaging.simp.SimpAttributesContextHolder
-
Bind the given SimpAttributes to the current thread.
- setAttributesFromMessage(Message<?>) - Static method in class org.springframework.messaging.simp.SimpAttributesContextHolder
-
Extract the SiMP session attributes from the given message, wrap them in a
SimpAttributes
instance and bind it to the current thread. - setAutoReceipt(boolean) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- setAutoReceipt(boolean) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
When enabled, a receipt header is automatically added to future
send
andsubscribe
operations on this session, which causes the server to return a RECEIPT. - setAutoStartup(boolean) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- setAutoStartup(boolean) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Configure whether the
StompBrokerRelayMessageHandler
should start automatically when the Spring ApplicationContext is refreshed. - setBeanFactory(BeanFactory) - Method in class org.springframework.messaging.core.BeanFactoryMessageChannelDestinationResolver
- setBeanFactory(BeanFactory) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
- setBeanFactory(BeanFactory) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
A
BeanFactory
only needs to be available for placeholder resolution in handler method arguments; it's optional otherwise. - setBeanName(String) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
- setBeanName(String) - Method in class org.springframework.messaging.support.AbstractMessageChannel
-
A message channel uses the bean name primarily for logging purposes.
- setBroadcastDestination(String) - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Set a destination to broadcast messages to that remain unresolved because the user is not connected.
- setCacheLimit(int) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Specify the maximum number of entries for the resolved destination cache.
- setCacheLimit(int) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Configure the cache limit to apply for registrations with the broker.
- setCacheLimit(Integer) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
When configured, the specified cache limit is passed down to the underlying SubscriptionRegistry, overriding any default there.
- setClientLogin(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the login to use when creating connections to the STOMP broker on behalf of connected clients.
- setClientLogin(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the login to use when creating connections to the STOMP broker on behalf of connected clients.
- setClientPasscode(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the passcode to use when creating connections to the STOMP broker on behalf of connected clients.
- setClientPasscode(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the client passcode to use to create connections to the STOMP broker on behalf of connected clients.
- setContentLength(int) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setContentLength(long) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the content-length header.
- setContentType(MimeType) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setContentType(MimeType) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the content-type header.
- setContentType(MimeType) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- setContentTypeResolver(ContentTypeResolver) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Configure a
ContentTypeResolver
for resolving the content type of input messages. - setConversionService(ConversionService) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Configure a
ConversionService
to use for type conversion of String based values, e.g. - setConversionService(ConversionService) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
Set the
ConversionService
to use to convert the original message payload or headers. - setConversionService(ConversionService) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Configure a
ConversionService
to use when resolving method arguments, for example message header values. - setCustomArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
Set the list of custom
HandlerMethodArgumentResolver
s that will be used after resolvers for supported argument type. - setCustomArgumentResolvers(List<HandlerMethodArgumentResolver>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Sets the list of custom
HandlerMethodArgumentResolver
s that will be used after resolvers for supported argument type. - setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Set the list of custom
HandlerMethodReturnValueHandler
s that will be used after return value handlers for known types. - setDecoders(List<? extends Decoder<?>>) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Configure the decoders to use for incoming payloads.
- setDecoders(List<? extends Decoder<?>>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure the decoders to use for incoming payloads.
- setDefaultDataMimeType(MimeType) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure the default content type to use for data payloads if the
SETUP
frame did not specify one. - setDefaultDestination(D) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Configure the default destination to use in send methods that don't have a destination argument.
- setDefaultDestinationPrefix(String) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Configure a default prefix to add to message destinations in cases where a method is not annotated with
@SendTo
or does not specify any destinations through the annotation's value attribute. - setDefaultHeartbeat(long[]) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Configure the default value for the "heart-beat" header of the STOMP CONNECT frame.
- setDefaultMetadataMimeType(MimeType) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure the default
MimeType
for payload data if theSETUP
frame did not specify one. - setDefaultMimeType(MimeType) - Method in class org.springframework.messaging.converter.DefaultContentTypeResolver
-
Set the default MIME type to use when there is no
MessageHeaders.CONTENT_TYPE
header present. - setDefaultUserDestinationPrefix(String) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Configure a default prefix to add to message destinations in cases where a method is annotated with
@SendToUser
but does not specify any destinations through the annotation's value attribute. - setDestination(String) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- setDestination(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setDestination(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the destination header.
- setDestinationPrefixes(Collection<String>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
When this property is configured only messages to destinations matching one of the configured prefixes are eligible for handling.
- setDestinationPrefixes(Collection<String>) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
When this property is configured only messages to destinations matching one of the configured prefixes are eligible for handling.
- setDestinationResolver(DestinationResolver<D>) - Method in class org.springframework.messaging.core.AbstractDestinationResolvingMessagingTemplate
-
Configure the
DestinationResolver
to use to resolve String destination names into actual destinations of type<D>
. - setDisableIdGeneration() - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
-
A shortcut for calling
IdTimestampMessageHeaderInitializer.setIdGenerator(org.springframework.util.IdGenerator)
with an id generation strategy to disable id generation completely. - setEmbeddedValueResolver(StringValueResolver) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
- setEmbeddedValueResolver(StringValueResolver) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- setEnableTimestamp(boolean) - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
-
Whether to enable the automatic addition of the
MessageHeaders.TIMESTAMP
header onMessageHeaderAccessor
instances being initialized. - setEncoders(List<? extends Encoder<?>>) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure the encoders to use for encoding handler method return values.
- setErrorChannel(MessageChannel) - Method in class org.springframework.messaging.support.MessageBuilder
- setErrorChannel(MessageChannel) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- setErrorChannelName(String) - Method in class org.springframework.messaging.support.MessageBuilder
- setErrorChannelName(String) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- setGson(Gson) - Method in class org.springframework.messaging.converter.GsonMessageConverter
-
Set the
Gson
instance to use. - setHandlerPredicate(Predicate<Class<?>>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Configure a predicate for selecting which Spring beans to check for the presence of message handler methods.
- setHandlers(List<Object>) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Manually configure the handlers to check for the presence of message handling methods, which also disables auto-detection via a
handlerPredicate
. - setHeader(String, Object) - Method in class org.springframework.messaging.support.MessageBuilder
-
Set the value for the given header name.
- setHeader(String, Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Set the value for the given header name.
- setHeaderIfAbsent(String, Object) - Method in class org.springframework.messaging.support.MessageBuilder
-
Set the value for the given header name only if the header name is not already associated with a value.
- setHeaderIfAbsent(String, Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Set the value for the given header name only if the header name is not already associated with a value.
- setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
-
Configure a
MessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Configure a
MessageHeaderInitializer
to pass on toHandlerMethodReturnValueHandlers
that send messages from controller return values. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
-
Configure a
MessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Configure a
MessageHeaderInitializer
to apply to the headers of all messages sent to the client outbound channel. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Configure a
MessageHeaderInitializer
to apply to the headers of all messages created through theSimpMessagingTemplate
. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Configure a
MessageHeaderInitializer
to apply to the headers of all messages created through theStompBrokerRelayMessageHandler
that are sent to the client outbound message channel. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.stomp.StompDecoder
-
Configure a
MessageHeaderInitializer
to apply to the headers ofMessages
from decoded STOMP frames. - setHeaderInitializer(MessageHeaderInitializer) - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Configure a custom
MessageHeaderInitializer
to initialize the headers of resolved target messages. - setHeaders(MessageHeaderAccessor) - Method in class org.springframework.messaging.support.MessageBuilder
-
Set the message headers to use by providing a
MessageHeaderAccessor
. - setHeartbeat(long[]) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the heartbeat header.
- setHeartbeat(long, long) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setHeartbeatValue(long[]) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Configure the value for the heart-beat settings.
- setHeartbeatValue(long[]) - Method in class org.springframework.messaging.simp.config.SimpleBrokerRegistration
-
Configure the value for the heartbeat settings.
- setHost(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setHost(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the host header.
- setId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the id header.
- setIdGenerator(IdGenerator) - Method in class org.springframework.messaging.support.IdTimestampMessageHeaderInitializer
-
Configure the IdGenerator strategy to initialize
MessageHeaderAccessor
instances with. - setImmutable() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
By default, when
MessageHeaderAccessor.getMessageHeaders()
is called,"this"
MessageHeaderAccessor
instance can no longer be used to modify the underlying message headers. - setImmutable() - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
- setInboundPrefix(String) - Method in class org.springframework.messaging.support.AbstractHeaderMapper
-
Specify a prefix to be appended to the message header name for any user-defined property that is being mapped into the MessageHeaders.
- setInterceptors(List<ChannelInterceptor>) - Method in class org.springframework.messaging.support.AbstractMessageChannel
- setInterceptors(List<ChannelInterceptor>) - Method in class org.springframework.messaging.support.ExecutorSubscribableChannel
- setInterceptors(List<ChannelInterceptor>) - Method in interface org.springframework.messaging.support.InterceptableChannel
-
Set the list of channel interceptors clearing any existing interceptors.
- setJsonb(Jsonb) - Method in class org.springframework.messaging.converter.JsonbMessageConverter
-
Set the
Jsonb
instance to use. - setLeaveMutable(boolean) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
By default, when
MessageHeaderAccessor.getMessageHeaders()
is called,"this"
MessageHeaderAccessor
instance can no longer be used to modify the underlying message headers and the returnedMessageHeaders
is immutable. - setLogger(Log) - Method in class org.springframework.messaging.handler.HandlerMethod
-
Set an alternative logger to use than the one based on the class name.
- setLogger(Log) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
-
Set an alternative logger to use than the one based on the class name.
- setLogger(Log) - Method in class org.springframework.messaging.support.AbstractMessageChannel
-
Set an alternative logger to use than the one based on the class name.
- setLogger(Log) - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
-
Set an alternative logger to use than the one based on the class name.
- setLogger(Log) - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
-
Set an alternative logger to use than the one based on the class name.
- setLogin(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setLogin(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the login header.
- setMarshaller(Marshaller) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
-
Set the
Marshaller
to be used by this message converter. - setMessage(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setMessageConverter(MessageConverter) - Method in class org.springframework.messaging.core.AbstractMessageSendingTemplate
-
Set the
MessageConverter
to use inconvertAndSend
methods. - setMessageConverter(MessageConverter) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
Set the
MessageConverter
to use. - setMessageConverter(MessageConverter) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Configure a
MessageConverter
to use to convert the payload of a message from its serialized form with a specific MIME type to an Object matching the target method parameter. - setMessageConverter(MessageConverter) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Set the
MessageConverter
to use to convert the payload of incoming and outgoing messages to and frombyte[]
based on object type, or expected object type, and the "content-type" header. - setMessageConverter(MessageConverter) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Set the
MessageConverter
to use to convert the payload of incoming and outgoing messages to and frombyte[]
based on object type and the "content-type" header. - setMessageId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setMessageId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the message-id header.
- setMessageMethodArgumentResolvers(HandlerMethodArgumentResolverComposite) - Method in class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Set
HandlerMethodArgumentResolvers
to use for resolving method argument values. - setMessageTypeIfNotSet(SimpMessageType) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- setMetadataExtractor(MetadataExtractor) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure a
MetadataExtractor
to extract the route along with other metadata. - setModified(boolean) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Mark the underlying message headers as modified.
- setNack(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setNativeHeader(String, String) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Set the specified native header value replacing existing values.
- setNativeHeaderValues(String, List<String>) - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Variant of
NativeMessageHeaderAccessor.addNativeHeader(String, String)
for all values. - setObjectMapper(ObjectMapper) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Set the
ObjectMapper
for this converter. - setOutboundPrefix(String) - Method in class org.springframework.messaging.support.AbstractHeaderMapper
-
Specify a prefix to be appended to the protocol property name for any user-defined message header that is being mapped into the protocol-specific Message.
- setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.messaging.handler.invocation.InvocableHandlerMethod
-
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
- setParameterNameDiscoverer(ParameterNameDiscoverer) - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
- setPasscode(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setPasscode(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the passcode header.
- setPathMatcher(PathMatcher) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Set the PathMatcher implementation to use for matching destinations against configured destination patterns.
- setPathMatcher(PathMatcher) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Specify the
PathMatcher
to use. - setPathMatcher(PathMatcher) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
When configured, the given PathMatcher is passed down to the underlying SubscriptionRegistry to use for matching destination to subscriptions.
- setPathMatcher(PathMatcher) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Configure the PathMatcher to use to match the destinations of incoming messages to
@MessageMapping
and@SubscribeMapping
methods. - setPayload(P, ParameterizedTypeReference<T>) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Set the request payload value to be serialized.
- setPayloadValue(Object) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Set the request payload as a concrete value to be serialized.
- setPhase(int) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Set the phase that this handler should run in.
- setPhase(int) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Set the phase that this handler should run in.
- setPhase(int) - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Set the phase that this handler should run in.
- setPreservePublishOrder(boolean) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Whether the client must receive messages in the order of publication.
- setPreservePublishOrder(boolean) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Whether the client must receive messages in the order of publication.
- setPrettyPrint(boolean) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
-
Whether to use the
DefaultPrettyPrinter
when writing JSON. - setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Configure the registry for adapting various reactive types.
- setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.messaging.handler.invocation.reactive.InvocableHandlerMethod
-
Configure a reactive adapter registry.
- setReactiveAdapterRegistry(ReactiveAdapterRegistry) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure the registry for adapting various reactive types.
- setReceipt(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setReceipt(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the receipt header.
- setReceiptId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setReceiptId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the receipt-id header.
- setReceiptTimeLimit(long) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Configure the time in milliseconds before a receipt expires.
- setReceiptTimeLimit(long) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Configure the number of milliseconds before a receipt is considered expired.
- setReceiveTimeout(long) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Configure the default timeout value to use for receive operations.
- setReceiveTimeoutHeader(String) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Set the name of the header used to determine the send timeout (if present).
- setRegistryExpirationPeriod(long) - Method in class org.springframework.messaging.simp.user.UserRegistryMessageHandler
-
Configure the amount of time (in milliseconds) before a remote user registry snapshot is considered expired.
- setRelayHost(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the STOMP message broker host.
- setRelayHost(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the STOMP message broker host.
- setRelayPort(int) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the STOMP message broker port.
- setRelayPort(int) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the STOMP message broker port.
- setRemoveLeadingSlash(boolean) - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
Use this property to indicate whether the leading slash from translated user destinations should be removed or not.
- setReplyChannel(MessageChannel) - Method in class org.springframework.messaging.support.MessageBuilder
- setReplyChannel(MessageChannel) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- setReplyChannelName(String) - Method in class org.springframework.messaging.support.MessageBuilder
- setReplyChannelName(String) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- setReturnValueHandlerConfigurer(ReturnValueHandlerConfigurer) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
-
Configure custom return value handlers for handler methods.
- setReturnValueHandlers(List<HandlerMethodReturnValueHandler>) - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
-
Configure the complete list of supported return value types, effectively overriding the ones configured by default.
- setRoute(String) - Method in class org.springframework.messaging.rsocket.service.RSocketRequestValues.Builder
-
Set the route for the request.
- setRouteMatcher(RouteMatcher) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Set the
RouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with. - setRouteMatcher(RouteMatcher) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Set the
RouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with. - setRSocketStrategies(RSocketStrategies) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketMessageHandler
-
Configure this handler through an
RSocketStrategies
instance which can be re-used to initialize a client-sideRSocketRequester
. - setSelectorHeaderName(String) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
-
Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.
- setSelectorHeaderName(String) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.
- setSelectorHeaderName(String) - Method in class org.springframework.messaging.simp.config.SimpleBrokerRegistration
-
Configure the name of a header that a subscription message can have for the purpose of filtering messages matched to the subscription.
- setSendTimeout(long) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Configure the default timeout value to use for send operations.
- setSendTimeout(long) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Specify the timeout value to use for send operations (in milliseconds).
- setSendTimeoutHeader(String) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Set the name of the header used to determine the send timeout (if present).
- setSerializedPayloadClass(Class<?>) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Configure the preferred serialization class to use (byte[] or String) when converting an Object payload to a
Message
. - setServer(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the server header.
- setSession(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the session header.
- setSessionAttributes(Map<String, Object>) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
A static alternative for access to the session attributes header.
- setSessionId(String) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- setStrictContentTypeMatch(boolean) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Whether this converter should convert messages for which no content type can be resolved through the configured
ContentTypeResolver
. - setSubscription(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaders
-
Set the login header.
- setSubscriptionId(String) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- setSubscriptionId(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setSubscriptionRegistry(SubscriptionRegistry) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Configure a custom
SubscriptionRegistry
to use for storing subscriptions. - setSystemHeartbeatReceiveInterval(long) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the maximum interval, in milliseconds, at which the "system" relay session expects, in the absence of any other data, to receive a heartbeat from the STOMP broker.
- setSystemHeartbeatReceiveInterval(long) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the maximum interval, in milliseconds, at which the "system" connection expects, in the absence of any other data, to receive a heartbeat from the STOMP broker.
- setSystemHeartbeatSendInterval(long) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the interval, in milliseconds, at which the "system" relay session will, in the absence of any other data being sent, send a heartbeat to the STOMP broker.
- setSystemHeartbeatSendInterval(long) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the interval, in milliseconds, at which the "system" connection will, in the absence of any other data being sent, send a heartbeat to the STOMP broker.
- setSystemLogin(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e.
- setSystemLogin(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the login for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e.
- setSystemPasscode(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e.
- setSystemPasscode(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the passcode for the shared "system" connection used to send messages to the STOMP broker from within the application, i.e.
- setSystemSubscriptions(Map<String, MessageHandler>) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Configure one more destinations to subscribe to on the shared "system" connection along with MessageHandler's to handle received messages.
- setTargetDestinationResolver(DestinationResolver<D>) - Method in class org.springframework.messaging.core.CachingDestinationResolverProxy
-
Set the target DestinationResolver to delegate to.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Configure the
TaskScheduler
to use for providing heartbeat support. - setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.config.SimpleBrokerRegistration
-
Configure the
TaskScheduler
to use for providing heartbeat support. - setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Some STOMP clients (e.g.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
-
Configure the TaskScheduler to use for receipt tracking.
- setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Configure the
TaskScheduler
to use to reset client-to-broker message count in the current heartbeat period. - setTaskScheduler(TaskScheduler) - Method in class org.springframework.messaging.simp.stomp.StompClientSupport
-
Configure a scheduler to use for heartbeats and for receipt tracking.
- setTcpClient(TcpOperations<byte[]>) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Configure a TCP client for managing TCP connections to the STOMP broker.
- setTcpClient(TcpOperations<byte[]>) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Configure a TCP client for managing TCP connections to the STOMP broker.
- setThrowExceptionOnLateReply(boolean) - Method in class org.springframework.messaging.core.GenericMessagingTemplate
-
Whether the thread sending a reply should have an exception raised if the receiving thread isn't going to receive the reply either because it timed out, or because it already received a reply, or because it got an exception while sending the request message.
- setUnmarshaller(Unmarshaller) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
-
Set the
Unmarshaller
to be used by this message converter. - setupData(Object) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Set the data for the setup payload.
- setupMetadata(Object, MimeType) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Add metadata entry to the setup payload.
- setupRoute(String, Object...) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Set the route for the setup payload.
- setUser(Principal) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- setUserChangeCallback(Consumer<Principal>) - Method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Provide a callback to be invoked if and when
SimpMessageHeaderAccessor.setUser(Principal)
is called. - setUserDestinationBroadcast(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set a destination to broadcast messages to user destinations that remain unresolved because the user appears not to be connected.
- setUserDestinationPredicate(Predicate<String>) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
-
Configure a Predicate to identify messages with a user destination.
- setUserDestinationPrefix(String) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Configure the prefix used to identify user destinations.
- setUserDestinationPrefix(String) - Method in class org.springframework.messaging.simp.SimpMessagingTemplate
-
Configure the prefix to use for destinations targeting a specific user.
- setUserDestinationPrefix(String) - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
-
The prefix used to identify user destinations.
- setUserRegistryBroadcast(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set a destination to broadcast the content of the local user registry to and to listen for such broadcasts from other servers.
- setUserRegistryOrder(int) - Method in class org.springframework.messaging.simp.config.MessageBrokerRegistry
-
Set the order for the
SimpUserRegistry
to use as aSmartApplicationListener
. - setValidator(Validator) - Method in class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
-
Set the Validator instance used for validating
@Payload
arguments. - setValidator(Validator) - Method in class org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory
-
Set the Validator instance used for validating
@Payload
arguments. - setValidator(Validator) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Set the Validator instance used for validating
@Payload
arguments. - setVersion(String) - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- setVirtualHost(String) - Method in class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Set the value of the "host" header to use in STOMP CONNECT frames.
- setVirtualHost(String) - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Set the value of the "host" header to use in STOMP CONNECT frames.
- shutdown() - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
-
Shut down the client and release resources.
- shutdown() - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Deprecated.as of 6.0, in favor of
TcpOperations.shutdownAsync()
- shutdownAsync() - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
- shutdownAsync() - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
- shutdownAsync() - Method in interface org.springframework.messaging.tcp.TcpOperations
-
Shut down and close any open connections.
- simpAnnotationMethodMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, SimpMessagingTemplate, CompositeMessageConverter) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- SimpAnnotationMethodMessageHandler - Class in org.springframework.messaging.simp.annotation.support
-
A handler for messages delegating to
@MessageMapping
and@SubscribeMapping
annotated methods. - SimpAnnotationMethodMessageHandler(SubscribableChannel, MessageChannel, SimpMessageSendingOperations) - Constructor for class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
-
Create an instance of SimpAnnotationMethodMessageHandler with the given message channels and broker messaging template.
- SimpAttributes - Class in org.springframework.messaging.simp
-
A wrapper class for access to attributes associated with a SiMP session (e.g.
- SimpAttributes(String, Map<String, Object>) - Constructor for class org.springframework.messaging.simp.SimpAttributes
-
Constructor wrapping the given session attributes map.
- SimpAttributesContextHolder - Class in org.springframework.messaging.simp
-
Holder class to expose SiMP attributes associated with a session (e.g.
- SimpAttributesContextHolder() - Constructor for class org.springframework.messaging.simp.SimpAttributesContextHolder
- simpleBrokerMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationResolver) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- SimpleBrokerMessageHandler - Class in org.springframework.messaging.simp.broker
-
A "simple" message broker that recognizes the message types defined in
SimpMessageType
, keeps track of subscriptions with the help of aSubscriptionRegistry
, and sends messages to subscribers. - SimpleBrokerMessageHandler(SubscribableChannel, MessageChannel, SubscribableChannel, Collection<String>) - Constructor for class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
-
Create a SimpleBrokerMessageHandler instance with the given message channels and destination prefixes.
- SimpleBrokerRegistration - Class in org.springframework.messaging.simp.config
-
Registration class for configuring a
SimpleBrokerMessageHandler
. - SimpleBrokerRegistration(SubscribableChannel, MessageChannel, String[]) - Constructor for class org.springframework.messaging.simp.config.SimpleBrokerRegistration
-
Create a new
SimpleBrokerRegistration
. - SimpleMessageConverter - Class in org.springframework.messaging.converter
-
A simple converter that simply unwraps the message payload as long as it matches the expected target class.
- SimpleMessageConverter() - Constructor for class org.springframework.messaging.converter.SimpleMessageConverter
- SimpLogging - Class in org.springframework.messaging.simp
-
Holds the shared logger named "org.springframework.web.SimpLogging" to use for STOMP over WebSocket messaging when logging for "org.springframework.messaging.simp" is off but logging for "org.springframework.web" is on.
- SimpLogging() - Constructor for class org.springframework.messaging.simp.SimpLogging
- SimpMessageHeaderAccessor - Class in org.springframework.messaging.simp
-
A base class for working with message headers in simple messaging protocols that support basic messaging patterns.
- SimpMessageHeaderAccessor(Message<?>) - Constructor for class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
A constructor for accessing and modifying existing message headers.
- SimpMessageHeaderAccessor(SimpMessageType, Map<String, List<String>>) - Constructor for class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
A constructor for creating new message headers.
- SimpMessageMappingInfo - Class in org.springframework.messaging.simp
-
MessageCondition
for SImple Messaging Protocols. - SimpMessageMappingInfo(SimpMessageTypeMessageCondition, DestinationPatternsMessageCondition) - Constructor for class org.springframework.messaging.simp.SimpMessageMappingInfo
- SimpMessageSendingOperations - Interface in org.springframework.messaging.simp
-
A specialization of
MessageSendingOperations
with methods for use with the Spring Framework support for Simple Messaging Protocols (like STOMP). - SimpMessageType - Enum Class in org.springframework.messaging.simp
-
A generic representation of different kinds of messages found in simple messaging protocols like STOMP.
- SimpMessageTypeMessageCondition - Class in org.springframework.messaging.simp
-
MessageCondition
that matches by the message type obtained viaSimpMessageHeaderAccessor.getMessageType(Map)
. - SimpMessageTypeMessageCondition(SimpMessageType) - Constructor for class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
-
A constructor accepting a message type.
- SimpMessagingTemplate - Class in org.springframework.messaging.simp
-
An implementation of
SimpMessageSendingOperations
. - SimpMessagingTemplate(MessageChannel) - Constructor for class org.springframework.messaging.simp.SimpMessagingTemplate
-
Create a new
SimpMessagingTemplate
instance. - SimpSession - Interface in org.springframework.messaging.simp.user
-
Represents a session of connected user.
- SimpSessionScope - Class in org.springframework.messaging.simp
-
A
Scope
implementation exposing the attributes of a SiMP session (e.g. - SimpSessionScope() - Constructor for class org.springframework.messaging.simp.SimpSessionScope
- SimpSubscription - Interface in org.springframework.messaging.simp.user
-
Represents a subscription within a user session.
- SimpSubscriptionMatcher - Interface in org.springframework.messaging.simp.user
-
A strategy for matching subscriptions.
- SimpUser - Interface in org.springframework.messaging.simp.user
-
Represents a connected user.
- SimpUserRegistry - Interface in org.springframework.messaging.simp.user
-
A registry of currently connected users.
- simpValidator() - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
-
Return an
Validator
instance for validating@Payload
method arguments. - size() - Method in class org.springframework.messaging.MessageHeaders
- size() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- skipEol(ByteBuffer) - Method in class org.springframework.messaging.simp.stomp.StompDecoder
-
Skip one ore more EOL characters at the start of the given ByteBuffer.
- SmartMessageConverter - Interface in org.springframework.messaging.converter
-
An extended
MessageConverter
SPI with conversion hint support. - start() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- start() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- start() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- startInternal() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- startInternal() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- startInternal() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
- STOMP - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- STOMP_ACCEPT_VERSION_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_ACK_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_CONTENT_LENGTH_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_CONTENT_TYPE_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_DESTINATION_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_HEARTBEAT_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_HOST_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_ID_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_LOGIN_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_MESSAGE_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_MESSAGE_ID_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_NACK_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_PASSCODE_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_RECEIPT_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_RECEIPT_ID_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_SUBSCRIPTION_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- STOMP_VERSION_HEADER - Static variable in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- stompBrokerRelayMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationMessageHandler, MessageHandler, UserDestinationResolver) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- StompBrokerRelayMessageHandler - Class in org.springframework.messaging.simp.stomp
-
A
MessageHandler
that handles messages by forwarding them to a STOMP broker. - StompBrokerRelayMessageHandler(SubscribableChannel, MessageChannel, SubscribableChannel, Collection<String>) - Constructor for class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
Create a StompBrokerRelayMessageHandler instance with the given message channels and destination prefixes.
- StompBrokerRelayMessageHandler.Stats - Interface in org.springframework.messaging.simp.stomp
-
Contract for access to session counters.
- StompBrokerRelayRegistration - Class in org.springframework.messaging.simp.config
-
Registration class for configuring a
StompBrokerRelayMessageHandler
. - StompBrokerRelayRegistration(SubscribableChannel, MessageChannel, String[]) - Constructor for class org.springframework.messaging.simp.config.StompBrokerRelayRegistration
-
Create a new
StompBrokerRelayRegistration
. - StompClientSupport - Class in org.springframework.messaging.simp.stomp
-
Base class for STOMP client implementations.
- StompClientSupport() - Constructor for class org.springframework.messaging.simp.stomp.StompClientSupport
- StompCommand - Enum Class in org.springframework.messaging.simp.stomp
-
Represents a STOMP command.
- StompConversionException - Exception in org.springframework.messaging.simp.stomp
-
Raised after a failure to encode or decode a STOMP message.
- StompConversionException(String) - Constructor for exception org.springframework.messaging.simp.stomp.StompConversionException
- StompConversionException(String, Throwable) - Constructor for exception org.springframework.messaging.simp.stomp.StompConversionException
- StompDecoder - Class in org.springframework.messaging.simp.stomp
-
Decodes one or more STOMP frames contained in a
ByteBuffer
. - StompDecoder() - Constructor for class org.springframework.messaging.simp.stomp.StompDecoder
- StompEncoder - Class in org.springframework.messaging.simp.stomp
-
An encoder for STOMP frames.
- StompEncoder() - Constructor for class org.springframework.messaging.simp.stomp.StompEncoder
- StompFrameHandler - Interface in org.springframework.messaging.simp.stomp
-
Contract to handle a STOMP frame.
- StompHeaderAccessor - Class in org.springframework.messaging.simp.stomp
-
A
MessageHeaderAccessor
to use when creating aMessage
from a decoded STOMP frame, or when encoding aMessage
to a STOMP frame. - StompHeaders - Class in org.springframework.messaging.simp.stomp
-
Represents STOMP frame headers.
- StompHeaders() - Constructor for class org.springframework.messaging.simp.stomp.StompHeaders
-
Create a new instance to be populated with new header values.
- StompReactorNettyCodec - Class in org.springframework.messaging.simp.stomp
-
Simple delegation to StompDecoder and StompEncoder.
- StompReactorNettyCodec() - Constructor for class org.springframework.messaging.simp.stomp.StompReactorNettyCodec
- StompReactorNettyCodec(StompDecoder) - Constructor for class org.springframework.messaging.simp.stomp.StompReactorNettyCodec
- StompReactorNettyCodec(StompDecoder, StompEncoder) - Constructor for class org.springframework.messaging.simp.stomp.StompReactorNettyCodec
- StompSession - Interface in org.springframework.messaging.simp.stomp
-
Represents a STOMP session with operations to send messages, create subscriptions and receive messages on those subscriptions.
- StompSession.Receiptable - Interface in org.springframework.messaging.simp.stomp
-
A handle to use to track receipts.
- StompSession.Subscription - Interface in org.springframework.messaging.simp.stomp
-
A handle to use to unsubscribe or to track a receipt.
- StompSessionHandler - Interface in org.springframework.messaging.simp.stomp
-
A contract for client STOMP session lifecycle events including a callback when the session is established and notifications of transport or message handling failures.
- StompSessionHandlerAdapter - Class in org.springframework.messaging.simp.stomp
-
Abstract adapter class for
StompSessionHandler
with mostly empty implementation methods except forStompSessionHandlerAdapter.getPayloadType(org.springframework.messaging.simp.stomp.StompHeaders)
which returns String as the default Object type expected for STOMP ERROR frame payloads. - StompSessionHandlerAdapter() - Constructor for class org.springframework.messaging.simp.stomp.StompSessionHandlerAdapter
- StompTcpConnectionHandler<P> - Interface in org.springframework.messaging.simp.stomp
-
A
TcpConnectionHandler
for use with STOMP connections, exposing further information about the connection. - StompTcpMessageCodec - Class in org.springframework.messaging.simp.stomp
- StompTcpMessageCodec() - Constructor for class org.springframework.messaging.simp.stomp.StompTcpMessageCodec
- StompTcpMessageCodec(StompDecoder) - Constructor for class org.springframework.messaging.simp.stomp.StompTcpMessageCodec
- StompTcpMessageCodec(StompDecoder, StompEncoder) - Constructor for class org.springframework.messaging.simp.stomp.StompTcpMessageCodec
- stop() - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- stop() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- stop() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- stop(Runnable) - Method in class org.springframework.messaging.simp.annotation.support.SimpAnnotationMethodMessageHandler
- stop(Runnable) - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- stop(Runnable) - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- stopInternal() - Method in class org.springframework.messaging.simp.broker.AbstractBrokerMessageHandler
- stopInternal() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- stopInternal() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
- strategies() - Method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Return the configured
RSocketStrategies
. - StringMessageConverter - Class in org.springframework.messaging.converter
-
A
MessageConverter
that supports MIME type "text/plain" with the payload converted to and from a String. - StringMessageConverter() - Constructor for class org.springframework.messaging.converter.StringMessageConverter
- StringMessageConverter(Charset) - Constructor for class org.springframework.messaging.converter.StringMessageConverter
- SubscribableChannel - Interface in org.springframework.messaging
-
A
MessageChannel
that maintains a registry of subscribers and invokes them to handle messages sent through this channel. - subscribe(String, StompFrameHandler) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- subscribe(String, StompFrameHandler) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
Subscribe to the given destination by sending a SUBSCRIBE frame and handle received messages with the specified
StompFrameHandler
. - subscribe(MessageHandler) - Method in interface org.springframework.messaging.SubscribableChannel
-
Register a message handler.
- subscribe(MessageHandler) - Method in class org.springframework.messaging.support.AbstractSubscribableChannel
- subscribe(StompHeaders, StompFrameHandler) - Method in class org.springframework.messaging.simp.stomp.DefaultStompSession
- subscribe(StompHeaders, StompFrameHandler) - Method in interface org.springframework.messaging.simp.stomp.StompSession
-
An overloaded version of
StompSession.subscribe(String, StompFrameHandler)
with fullStompHeaders
instead of just a destination. - SUBSCRIBE - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- SUBSCRIBE - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- SUBSCRIBE - Static variable in class org.springframework.messaging.simp.SimpMessageTypeMessageCondition
- SubscribeMapping - Annotation Interface in org.springframework.messaging.simp.annotation
-
Annotation for mapping subscription messages onto specific handler methods based on the destination of a subscription.
- SUBSCRIPTION - Static variable in class org.springframework.messaging.simp.stomp.StompHeaders
- SUBSCRIPTION_ID_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- SubscriptionMethodReturnValueHandler - Class in org.springframework.messaging.simp.annotation.support
-
HandlerMethodReturnValueHandler
for replying directly to a subscription. - SubscriptionMethodReturnValueHandler(MessageSendingOperations<String>) - Constructor for class org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
-
Construct a new SubscriptionMethodReturnValueHandler.
- SubscriptionRegistry - Interface in org.springframework.messaging.simp.broker
-
A registry of subscription by session that allows looking up subscriptions.
- supports(Class<?>) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- supports(Class<?>) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
-
Whether the given class is supported by this converter.
- supports(Class<?>) - Method in class org.springframework.messaging.converter.ByteArrayMessageConverter
- supports(Class<?>) - Method in class org.springframework.messaging.converter.MappingJackson2MessageConverter
- supports(Class<?>) - Method in class org.springframework.messaging.converter.MarshallingMessageConverter
- supports(Class<?>) - Method in class org.springframework.messaging.converter.ProtobufMessageConverter
- supports(Class<?>) - Method in class org.springframework.messaging.converter.StringMessageConverter
- supportsEventType(Class<? extends ApplicationEvent>) - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- supportsMimeType(MessageHeaders) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- supportsOrderedMessages(MessageChannel) - Static method in class org.springframework.messaging.simp.broker.OrderedMessageChannelDecorator
-
Whether the channel has been
configured
with an interceptor for sequential handling. - supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.ContinuationHandlerMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.DestinationVariableMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.HeaderMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.HeadersMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.reactive.PayloadMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.DestinationVariableMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.HeaderMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.HeadersMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.MessageMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver
-
Whether the given method parameter is supported by this resolver.
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolverComposite
-
Whether the given method parameter is supported by any registered
HandlerMethodArgumentResolver
. - supportsParameter(MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolver
-
Whether the given method parameter is supported by this resolver.
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodArgumentResolverComposite
-
Whether the given method parameter is supported by any registered
HandlerMethodArgumentResolver
. - supportsParameter(MethodParameter) - Method in class org.springframework.messaging.rsocket.annotation.support.RSocketRequesterMethodArgumentResolver
- supportsParameter(MethodParameter) - Method in class org.springframework.messaging.simp.annotation.support.PrincipalMethodArgumentResolver
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.CompletableFutureReturnValueHandler
- supportsReturnType(MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandler
-
Whether the given method return type is supported by this handler.
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler
-
Deprecated.
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.reactive.AbstractEncoderMethodReturnValueHandler
- supportsReturnType(MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandler
-
Whether the given method return type is supported by this handler.
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.reactive.HandlerMethodReturnValueHandlerComposite
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- supportsReturnType(MethodParameter) - Method in class org.springframework.messaging.simp.annotation.support.SubscriptionMethodReturnValueHandler
- supportsSourceType(Class<?>) - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- SyncHandlerMethodArgumentResolver - Interface in org.springframework.messaging.handler.invocation.reactive
-
An extension of
HandlerMethodArgumentResolver
for implementations that are synchronous in nature and do not block to resolve values. - SYSTEM_SESSION_ID - Static variable in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
-
The system session ID.
T
- taskExecutor() - Method in class org.springframework.messaging.simp.config.ChannelRegistration
-
Configure the thread pool backing this message channel.
- taskExecutor(ThreadPoolTaskExecutor) - Method in class org.springframework.messaging.simp.config.ChannelRegistration
-
Configure the thread pool backing this message channel using a custom ThreadPoolTaskExecutor.
- TaskExecutorRegistration - Class in org.springframework.messaging.simp.config
-
A registration class for customizing the properties of
ThreadPoolTaskExecutor
. - TaskExecutorRegistration() - Constructor for class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Create a new
TaskExecutorRegistration
for a defaultThreadPoolTaskExecutor
. - TaskExecutorRegistration(ThreadPoolTaskExecutor) - Constructor for class org.springframework.messaging.simp.config.TaskExecutorRegistration
-
Create a new
TaskExecutorRegistration
for a givenThreadPoolTaskExecutor
. - tcp(String, int) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Build an
RSocketRequester
with anRSocketClient
that connects over TCP to the given host and port. - TcpConnection<P> - Interface in org.springframework.messaging.tcp
-
A contract for sending messages and managing a TCP connection.
- TcpConnectionHandler<P> - Interface in org.springframework.messaging.tcp
-
A contract for managing lifecycle events for a TCP connection including the handling of incoming messages.
- TcpMessageCodec<P> - Interface in org.springframework.messaging.tcp.reactor
-
Contract to encode and decode a
Message
to and from aByteBuffer
allowing a higher-level protocol (e.g. - TcpOperations<P> - Interface in org.springframework.messaging.tcp
-
A contract for establishing TCP connections.
- TIMESTAMP - Static variable in class org.springframework.messaging.MessageHeaders
-
The key for the message timestamp.
- toCompletableFuture(Object, MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.AsyncHandlerMethodReturnValueHandler
-
Adapt the asynchronous return value to a
CompletableFuture
. - toCompletableFuture(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.CompletableFutureReturnValueHandler
- toCompletableFuture(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.HandlerMethodReturnValueHandlerComposite
- toCompletableFuture(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler
-
Deprecated.
- toCompletableFuture(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ReactiveReturnValueHandler
- toHeaderName(String) - Method in class org.springframework.messaging.support.AbstractHeaderMapper
-
Generate the name to use to set the header defined by the specified
propertyName
to theMessageHeaders
instance. - toHeaders(T) - Method in interface org.springframework.messaging.support.HeaderMapper
-
Map from the given target message to abstracted
MessageHeaders
. - toJson(Object, Type) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- toJson(Object, Type) - Method in class org.springframework.messaging.converter.GsonMessageConverter
- toJson(Object, Type) - Method in class org.springframework.messaging.converter.JsonbMessageConverter
- toJson(Object, Type) - Method in class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
- toJson(Object, Type, Writer) - Method in class org.springframework.messaging.converter.AbstractJsonMessageConverter
- toJson(Object, Type, Writer) - Method in class org.springframework.messaging.converter.GsonMessageConverter
- toJson(Object, Type, Writer) - Method in class org.springframework.messaging.converter.JsonbMessageConverter
- toJson(Object, Type, Writer) - Method in class org.springframework.messaging.converter.KotlinSerializationJsonMessageConverter
- toListenableFuture(Object, MethodParameter) - Method in interface org.springframework.messaging.handler.invocation.AsyncHandlerMethodReturnValueHandler
-
Deprecated.as of 6.0, in favor of
AsyncHandlerMethodReturnValueHandler.toCompletableFuture(Object, MethodParameter)
- toListenableFuture(Object, MethodParameter) - Method in class org.springframework.messaging.handler.invocation.ListenableFutureReturnValueHandler
-
Deprecated.
- toMap() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return a copy of the underlying header values as a plain
Map
object. - toMessage(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- toMessage(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.CompositeMessageConverter
- toMessage(Object, MessageHeaders) - Method in interface org.springframework.messaging.converter.MessageConverter
-
Create a
Message
whose payload is the result of converting the given payload Object to serialized form. - toMessage(Object, MessageHeaders) - Method in class org.springframework.messaging.converter.SimpleMessageConverter
- toMessage(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.AbstractMessageConverter
- toMessage(Object, MessageHeaders, Object) - Method in class org.springframework.messaging.converter.CompositeMessageConverter
- toMessage(Object, MessageHeaders, Object) - Method in interface org.springframework.messaging.converter.SmartMessageConverter
-
A variant of
MessageConverter.toMessage(Object, MessageHeaders)
which takes an extra conversion context as an argument, allowing to take e.g. - toMessageHeaders() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
-
Return a copy of the underlying header values as a
MessageHeaders
object. - toNativeHeaderMap() - Method in class org.springframework.messaging.support.NativeMessageHeaderAccessor
-
Return a copy of the native headers sub-map, or an empty map.
- toSingleValueMap() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- toString() - Method in class org.springframework.messaging.converter.CompositeMessageConverter
- toString() - Method in class org.springframework.messaging.converter.DefaultContentTypeResolver
- toString() - Method in class org.springframework.messaging.handler.AbstractMessageCondition
- toString() - Method in class org.springframework.messaging.handler.CompositeMessageCondition
- toString() - Method in class org.springframework.messaging.handler.invocation.AbstractMethodMessageHandler
- toString() - Method in class org.springframework.messaging.MessageHeaders
- toString() - Method in exception org.springframework.messaging.MessagingException
- toString() - Method in class org.springframework.messaging.simp.annotation.support.SendToMethodReturnValueHandler
- toString() - Method in class org.springframework.messaging.simp.broker.BrokerAvailabilityEvent
- toString() - Method in class org.springframework.messaging.simp.broker.SimpleBrokerMessageHandler
- toString() - Method in class org.springframework.messaging.simp.SimpMessageMappingInfo
- toString() - Method in class org.springframework.messaging.simp.stomp.ReactorNettyTcpStompClient
- toString() - Method in class org.springframework.messaging.simp.stomp.StompBrokerRelayMessageHandler
- toString() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- toString() - Method in class org.springframework.messaging.simp.user.DefaultUserDestinationResolver
- toString() - Method in class org.springframework.messaging.simp.user.MultiServerUserRegistry
- toString() - Method in class org.springframework.messaging.simp.user.UserDestinationMessageHandler
- toString() - Method in class org.springframework.messaging.simp.user.UserDestinationResult
- toString() - Method in class org.springframework.messaging.support.AbstractMessageChannel
- toString() - Method in class org.springframework.messaging.support.ErrorMessage
- toString() - Method in class org.springframework.messaging.support.GenericMessage
- toString() - Method in class org.springframework.messaging.support.MessageHeaderAccessor
- toString() - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpClient
- toString() - Method in class org.springframework.messaging.tcp.reactor.ReactorNetty2TcpConnection
- toString() - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpClient
- toString() - Method in class org.springframework.messaging.tcp.reactor.ReactorNettyTcpConnection
- transport(ClientTransport) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Variant of
RSocketRequester.Builder.tcp(String, int)
andRSocketRequester.Builder.websocket(URI)
with an already initializedClientTransport
. - transports(Publisher<List<LoadbalanceTarget>>, LoadbalanceStrategy) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Build an
RSocketRequester
with anLoadbalanceRSocketClient
that will connect to one of the given targets selected through the givenLoadbalanceRSocketClient
. - triggerAfterReceiveCompletion(Message<?>, MessageChannel, Exception) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
- triggerAfterSendCompletion(Message<?>, MessageChannel, boolean, Exception) - Method in class org.springframework.messaging.support.AbstractMessageChannel.ChannelInterceptorChain
U
- unregisterAllSubscriptions(String) - Method in class org.springframework.messaging.simp.broker.DefaultSubscriptionRegistry
- unregisterAllSubscriptions(String) - Method in interface org.springframework.messaging.simp.broker.SubscriptionRegistry
-
Remove all subscriptions associated with the given sessionId.
- unregisterSubscription(Message<?>) - Method in class org.springframework.messaging.simp.broker.AbstractSubscriptionRegistry
- unregisterSubscription(Message<?>) - Method in interface org.springframework.messaging.simp.broker.SubscriptionRegistry
-
Unregister a subscription.
- unsubscribe() - Method in interface org.springframework.messaging.simp.stomp.StompSession.Subscription
-
Remove the subscription by sending an UNSUBSCRIBE frame.
- unsubscribe(MessageHandler) - Method in interface org.springframework.messaging.SubscribableChannel
-
Un-register a message handler.
- unsubscribe(MessageHandler) - Method in class org.springframework.messaging.support.AbstractSubscribableChannel
- unsubscribe(StompHeaders) - Method in interface org.springframework.messaging.simp.stomp.StompSession.Subscription
-
Alternative to
StompSession.Subscription.unsubscribe()
with additional custom headers to send to the server. - UNSUBSCRIBE - Enum constant in enum class org.springframework.messaging.simp.SimpMessageType
- UNSUBSCRIBE - Enum constant in enum class org.springframework.messaging.simp.stomp.StompCommand
- updateStompCommandAsClientMessage() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- updateStompCommandAsServerMessage() - Method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
- USER_HEADER - Static variable in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
- userDestinationMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, AbstractSubscribableChannel, UserDestinationResolver) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- UserDestinationMessageHandler - Class in org.springframework.messaging.simp.user
-
MessageHandler
with support for "user" destinations. - UserDestinationMessageHandler(SubscribableChannel, SubscribableChannel, UserDestinationResolver) - Constructor for class org.springframework.messaging.simp.user.UserDestinationMessageHandler
-
Create an instance with the given client and broker channels to subscribe to, and then send resolved messages to the broker channel.
- userDestinationResolver(SimpUserRegistry, AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- UserDestinationResolver - Interface in org.springframework.messaging.simp.user
-
A strategy for resolving a "user" destination by translating it to one or more actual destinations one per active user session.
- UserDestinationResult - Class in org.springframework.messaging.simp.user
-
Contains the result from parsing a "user" destination from a source message and translating it to target destinations (one per active user session).
- UserDestinationResult(String, Set<String>, String, String) - Constructor for class org.springframework.messaging.simp.user.UserDestinationResult
- UserDestinationResult(String, Set<String>, String, String, Set<String>) - Constructor for class org.springframework.messaging.simp.user.UserDestinationResult
-
Additional constructor with the session id for each targetDestination.
- userRegistry(AbstractSubscribableChannel, AbstractSubscribableChannel) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- userRegistryMessageHandler(AbstractSubscribableChannel, AbstractSubscribableChannel, SimpUserRegistry, SimpMessagingTemplate, TaskScheduler) - Method in class org.springframework.messaging.simp.config.AbstractMessageBrokerConfiguration
- UserRegistryMessageHandler - Class in org.springframework.messaging.simp.user
-
MessageHandler
that handles user registry broadcasts from other application servers and periodically broadcasts the content of the local user registry. - UserRegistryMessageHandler(MultiServerUserRegistry, SimpMessagingTemplate, String, TaskScheduler) - Constructor for class org.springframework.messaging.simp.user.UserRegistryMessageHandler
-
Constructor.
V
- validate(Message<?>, MethodParameter, Object) - Method in class org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver
-
Validate the payload if applicable.
- value() - Element in annotation interface org.springframework.messaging.handler.annotation.DestinationVariable
-
The name of the destination template variable to bind to.
- value() - Element in annotation interface org.springframework.messaging.handler.annotation.Header
-
Alias for
Header.name()
. - value() - Element in annotation interface org.springframework.messaging.handler.annotation.MessageExceptionHandler
-
Exceptions handled by the annotated method.
- value() - Element in annotation interface org.springframework.messaging.handler.annotation.MessageMapping
-
Destination-based mapping expressed by this annotation.
- value() - Element in annotation interface org.springframework.messaging.handler.annotation.Payload
-
Alias for
Payload.expression()
. - value() - Element in annotation interface org.springframework.messaging.handler.annotation.SendTo
-
The destination for a message created from the return value of a method.
- value() - Element in annotation interface org.springframework.messaging.rsocket.annotation.ConnectMapping
-
Mappings expressed by this annotation to match to the route from the metadata of the initial
ConnectionSetupPayload
or in subsequent metadata pushes. - value() - Element in annotation interface org.springframework.messaging.rsocket.service.RSocketExchange
-
Destination-based mapping expressed by this annotation.
- value() - Element in annotation interface org.springframework.messaging.simp.annotation.SendToUser
-
Alias for
SendToUser.destinations()
. - value() - Element in annotation interface org.springframework.messaging.simp.annotation.SubscribeMapping
-
Destination-based mapping expressed by this annotation.
- ValueConstants - Interface in org.springframework.messaging.handler.annotation
-
Common annotation value constants.
- valueOf(String) - Static method in enum class org.springframework.messaging.simp.SimpMessageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.messaging.simp.stomp.StompCommand
-
Returns the enum constant of this class with the specified name.
- values() - Method in class org.springframework.messaging.MessageHeaders
- values() - Static method in enum class org.springframework.messaging.simp.SimpMessageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.messaging.simp.stomp.StompCommand
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Method in class org.springframework.messaging.simp.stomp.StompHeaders
- verifyType(String, Object) - Method in class org.springframework.messaging.support.MessageHeaderAccessor
W
- websocket(URI) - Method in interface org.springframework.messaging.rsocket.RSocketRequester.Builder
-
Build an
RSocketRequester
with anRSocketClient
that connects over WebSocket to the given URL. - withPayload(T) - Static method in class org.springframework.messaging.support.MessageBuilder
-
Create a new builder for a message with the given payload.
- wrap(RSocket, MimeType, MimeType, RSocketStrategies) - Static method in interface org.springframework.messaging.rsocket.RSocketRequester
-
Wrap an existing
RSocket
. - wrap(Message<?>) - Static method in class org.springframework.messaging.simp.SimpMessageHeaderAccessor
-
Create an instance by copying the headers of a Message.
- wrap(Message<?>) - Static method in class org.springframework.messaging.simp.stomp.StompHeaderAccessor
-
Create an instance from the payload and headers of the given Message.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
RSocketRequester.Builder.transport(ClientTransport)