Uses of Interface
org.springframework.messaging.Message
Packages that use Message
Package
Description
Core package of the JMS support.
Message listener adapter mechanism that delegates to target listener
methods, converting messages to appropriate message content types
(such as String or byte array) that get passed into listener methods.
This package provides generic JMS support classes,
to be used by higher-level classes like JmsTemplate.
Support for working with messaging APIs and protocols.
Provides support for message conversion.
Defines interfaces and implementation classes for messaging templates.
Basic abstractions for working with message handler methods.
Support classes for working with annotated message-handling methods with
non-blocking, reactive contracts.
Support classes for working with annotated message-handling methods.
Common infrastructure for invoking message handler methods.
Common infrastructure for invoking message handler methods with non-blocking,
and reactive contracts.
Support classes for working with annotated RSocket stream handling methods.
Generic support for Simple Messaging Protocols including protocols such as STOMP.
Support classes for handling messages from simple messaging protocols
(like STOMP).
Provides a "simple" message broker implementation along with an abstract base
class and other supporting types such as a registry for subscriptions.
Generic support for simple messaging protocols (like STOMP).
Support for handling messages to "user" destinations (i.e.
Provides implementations of
Message along with
a MessageBuilder and MessageHeaderAccessor for building and working with messages and
message headers, as well as various MessageChannel
implementations and channel interceptor support.Contains abstractions and implementation classes for establishing TCP connections via
TcpOperations,
handling messages via
TcpConnectionHandler,
as well as sending messages via
TcpConnection.Contains support for TCP messaging based on Reactor.
WebSocket integration for Spring's messaging module.
-
Uses of Message in org.springframework.jms.core
Methods in org.springframework.jms.core that return MessageModifier and TypeMethodDescriptionJmsMessagingTemplate.convertJmsMessage(@Nullable Message message) JmsMessagingTemplate.doReceive(Destination destination) JmsMessagingTemplate.doSendAndReceive(Destination destination, Message<?> requestMessage) JmsMessagingTemplate.doSendAndReceive(String destinationName, Message<?> requestMessage) Receive a message from the given destination.JmsMessagingTemplate.receive()JmsMessageOperations.sendAndReceive(String destinationName, Message<?> requestMessage) Send a request message and receive the reply from the given destination.JmsMessagingTemplate.sendAndReceive(String destinationName, Message<?> requestMessage) JmsMessagingTemplate.sendAndReceive(Message<?> requestMessage) Methods in org.springframework.jms.core with parameters of type MessageModifier and TypeMethodDescriptionprotected voidJmsMessagingTemplate.doSend(Destination destination, Message<?> message) protected voidJmsMessagingTemplate.doSendAndReceive(Destination destination, Message<?> requestMessage) JmsMessagingTemplate.doSendAndReceive(String destinationName, Message<?> requestMessage) voidSend a message to the given destination.voidvoidJmsMessageOperations.sendAndReceive(String destinationName, Message<?> requestMessage) Send a request message and receive the reply from the given destination.JmsMessagingTemplate.sendAndReceive(String destinationName, Message<?> requestMessage) JmsMessagingTemplate.sendAndReceive(Message<?> requestMessage) -
Uses of Message in org.springframework.jms.listener.adapter
Methods in org.springframework.jms.listener.adapter that return MessageModifier and TypeMethodDescriptionprotected Message<?>MessagingMessageListenerAdapter.toMessagingMessage(Message jmsMessage) -
Uses of Message in org.springframework.jms.support
Methods in org.springframework.jms.support with parameters of type MessageModifier and TypeMethodDescriptionstatic JmsMessageHeaderAccessorCreate aJmsMessageHeaderAccessorfrom the headers of an existing message.Constructors in org.springframework.jms.support with parameters of type Message -
Uses of Message in org.springframework.messaging
Methods in org.springframework.messaging that return MessageModifier and TypeMethodDescriptionMessagingException.getFailedMessage()PollableChannel.receive()Receive a message from this channel, blocking indefinitely if necessary.PollableChannel.receive(long timeout) Receive a message from this channel, blocking until either a message is available or the specified timeout period elapses.Methods in org.springframework.messaging with parameters of type MessageModifier and TypeMethodDescriptionvoidMessageHandler.handleMessage(Message<?> message) Handle the given message.reactor.core.publisher.Mono<Void>ReactiveMessageHandler.handleMessage(Message<?> message) Handle the given message.default booleanSend aMessageto this channel.booleanSend a message, blocking until either the message is accepted or the specified timeout period elapses.Constructors in org.springframework.messaging with parameters of type MessageModifierConstructorDescriptionMessageDeliveryException(Message<?> undeliveredMessage) MessageDeliveryException(Message<?> message, @Nullable Throwable cause) MessageDeliveryException(Message<?> undeliveredMessage, String description) MessageDeliveryException(Message<?> undeliveredMessage, String description, @Nullable Throwable cause) MessageHandlingException(Message<?> failedMessage) MessageHandlingException(Message<?> message, String description) MessageHandlingException(Message<?> message, String description, Throwable cause) MessageHandlingException(Message<?> failedMessage, Throwable cause) MessagingException(Message<?> message) MessagingException(Message<?> message, @Nullable Throwable cause) MessagingException(Message<?> message, String description) -
Uses of Message in org.springframework.messaging.converter
Methods in org.springframework.messaging.converter that return MessageModifier and TypeMethodDescriptionAbstractMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers) AbstractMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint) CompositeMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers) CompositeMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint) MessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers) Create aMessagewhose payload is the result of converting the given payload Object to serialized form.Message<?>SimpleMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers) SmartMessageConverter.toMessage(Object payload, @Nullable MessageHeaders headers, @Nullable Object conversionHint) A variant ofMessageConverter.toMessage(Object, MessageHeaders)which takes an extra conversion context as an argument, allowing to take, for example, annotations on a return type into account.Methods in org.springframework.messaging.converter with parameters of type MessageModifier and TypeMethodDescriptionprotected booleanAbstractMessageConverter.canConvertFrom(Message<?> message, Class<?> targetClass) protected booleanMappingJackson2MessageConverter.canConvertFrom(Message<?> message, @Nullable Class<?> targetClass) protected booleanMarshallingMessageConverter.canConvertFrom(Message<?> message, Class<?> targetClass) AbstractJsonMessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) AbstractMessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) Convert the message payload from serialized form to an Object.ByteArrayMessageConverter.convertFromInternal(Message<?> message, @Nullable Class<?> targetClass, @Nullable Object conversionHint) MappingJackson2MessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) MarshallingMessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) protected ObjectProtobufMessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) protected ObjectStringMessageConverter.convertFromInternal(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) AbstractMessageConverter.fromMessage(Message<?> message, Class<?> targetClass) AbstractMessageConverter.fromMessage(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) CompositeMessageConverter.fromMessage(Message<?> message, Class<?> targetClass) CompositeMessageConverter.fromMessage(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) GenericMessageConverter.fromMessage(Message<?> message, Class<?> targetClass) MessageConverter.fromMessage(Message<?> message, Class<?> targetClass) Convert the payload of aMessagefrom a serialized form to a typed Object of the specified target class.SimpleMessageConverter.fromMessage(Message<?> message, Class<?> targetClass) SmartMessageConverter.fromMessage(Message<?> message, Class<?> targetClass, @Nullable Object conversionHint) A variant ofMessageConverter.fromMessage(Message, Class)which takes an extra conversion context as an argument, allowing to take, for example, annotations on a payload parameter into account.Constructors in org.springframework.messaging.converter with parameters of type MessageModifierConstructorDescriptionMessageConversionException(Message<?> failedMessage, @Nullable String description, @Nullable Throwable cause) MessageConversionException(Message<?> failedMessage, String description) -
Uses of Message in org.springframework.messaging.core
Methods in org.springframework.messaging.core that return MessageModifier and TypeMethodDescriptionprotected Message<?>AbstractMessageSendingTemplate.doConvert(Object payload, @Nullable Map<String, Object> headers, @Nullable MessagePostProcessor postProcessor) Convert the given Object to serialized form, possibly using aMessageConverter, wrap it as a message with the given headers and apply the given post processor.Actually receive a message from the given destination.GenericMessagingTemplate.doReceive(MessageChannel channel) GenericMessagingTemplate.doReceive(MessageChannel channel, long timeout) AbstractMessagingTemplate.doSendAndReceive(D destination, Message<?> requestMessage) GenericMessagingTemplate.doSendAndReceive(MessageChannel channel, Message<?> requestMessage) Message<?>MessagePostProcessor.postProcessMessage(Message<?> message) Process the given message.AbstractMessageReceivingTemplate.receive()Resolve the given destination name and receive a message from it.MessageReceivingOperations.receive()Receive a message from a default destination.Receive a message from the given destination.AbstractDestinationResolvingMessagingTemplate.sendAndReceive(String destinationName, Message<?> requestMessage) AbstractMessagingTemplate.sendAndReceive(D destination, Message<?> requestMessage) AbstractMessagingTemplate.sendAndReceive(Message<?> requestMessage) DestinationResolvingMessageRequestReplyOperations.sendAndReceive(String destinationName, Message<?> requestMessage) Resolve the given destination name to a destination and send the given message, receive a reply and return it.MessageRequestReplyOperations.sendAndReceive(D destination, Message<?> requestMessage) Send a request message and receive the reply from the given destination.MessageRequestReplyOperations.sendAndReceive(Message<?> requestMessage) Send a request message and receive the reply from a default destination.Methods in org.springframework.messaging.core with parameters of type MessageModifier and TypeMethodDescriptionprotected <T> @Nullable TConvert from the given message to the given target class.protected abstract voidprotected final voidGenericMessagingTemplate.doSend(MessageChannel channel, Message<?> message) protected final voidGenericMessagingTemplate.doSend(MessageChannel channel, Message<?> message, long timeout) AbstractMessagingTemplate.doSendAndReceive(D destination, Message<?> requestMessage) GenericMessagingTemplate.doSendAndReceive(MessageChannel channel, Message<?> requestMessage) Message<?>MessagePostProcessor.postProcessMessage(Message<?> message) Process the given message.voidvoidvoidvoidResolve the given destination name to a destination and send a message to it.voidSend a message to the given destination.voidSend a message to a default destination.AbstractDestinationResolvingMessagingTemplate.sendAndReceive(String destinationName, Message<?> requestMessage) AbstractMessagingTemplate.sendAndReceive(D destination, Message<?> requestMessage) AbstractMessagingTemplate.sendAndReceive(Message<?> requestMessage) DestinationResolvingMessageRequestReplyOperations.sendAndReceive(String destinationName, Message<?> requestMessage) Resolve the given destination name to a destination and send the given message, receive a reply and return it.MessageRequestReplyOperations.sendAndReceive(D destination, Message<?> requestMessage) Send a request message and receive the reply from the given destination.MessageRequestReplyOperations.sendAndReceive(Message<?> requestMessage) Send a request message and receive the reply from a default destination. -
Uses of Message in org.springframework.messaging.handler
Methods in org.springframework.messaging.handler with parameters of type MessageModifier and TypeMethodDescriptionintCompositeMessageCondition.compareTo(CompositeMessageCondition other, Message<?> message) intDestinationPatternsMessageCondition.compareTo(DestinationPatternsMessageCondition other, Message<?> message) Compare the two conditions based on the destination patterns they contain.intCompare this condition to another in the context of a specific message.CompositeMessageCondition.getMatchingCondition(Message<?> message) DestinationPatternsMessageCondition.getMatchingCondition(Message<?> message) Check if any of the patterns match the given Message destination and return an instance that is guaranteed to contain matching patterns, sorted viaPathMatcher.getPatternComparator(String).MessageCondition.getMatchingCondition(Message<?> message) Check if this condition matches the given Message and returns a potentially new condition with content tailored to the current message. -
Uses of Message in org.springframework.messaging.handler.annotation.reactive
Methods in org.springframework.messaging.handler.annotation.reactive with parameters of type MessageModifier and TypeMethodDescriptionprotected @Nullable RouteMatcher.RouteMessageMappingMessageHandler.getDestination(Message<?> message) protected Comparator<CompositeMessageCondition>MessageMappingMessageHandler.getMappingComparator(Message<?> message) protected @Nullable CompositeMessageConditionMessageMappingMessageHandler.getMatchingMapping(CompositeMessageCondition mapping, Message<?> message) PayloadMethodArgumentResolver.getMimeType(Message<?> message) Return the mime type for the content.protected reactor.core.publisher.Mono<Void>MessageMappingMessageHandler.handleMatch(CompositeMessageCondition mapping, HandlerMethod handlerMethod, Message<?> message) protected abstract voidAbstractNamedValueMethodArgumentResolver.handleMissingValue(String name, MethodParameter parameter, Message<?> message) Invoked when a value is required, butAbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String)returnednulland there is no default value.protected voidDestinationVariableMethodArgumentResolver.handleMissingValue(String name, MethodParameter parameter, Message<?> message) protected voidHeaderMethodArgumentResolver.handleMissingValue(String headerName, MethodParameter parameter, Message<?> message) reactor.core.publisher.Mono<Object>ContinuationHandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) final reactor.core.publisher.Mono<Object>PayloadMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) Decode the content of the given message payload through a compatibleDecoder.AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) Resolves the given parameter type and value name into an argument value.DestinationVariableMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) HeaderMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) AbstractNamedValueMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter, Message<?> message) HeadersMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter, Message<?> message) -
Uses of Message in org.springframework.messaging.handler.annotation.support
Methods in org.springframework.messaging.handler.annotation.support with parameters of type MessageModifier and TypeMethodDescriptionprotected Class<?>MessageMethodArgumentResolver.getPayloadType(MethodParameter parameter, Message<?> message) Resolve the target class to convert the payload to.protected abstract voidAbstractNamedValueMethodArgumentResolver.handleMissingValue(String name, MethodParameter parameter, Message<?> message) Invoked when a value is required, butAbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(org.springframework.core.MethodParameter, org.springframework.messaging.Message<?>, java.lang.String)returnednulland there is no default value.protected voidDestinationVariableMethodArgumentResolver.handleMissingValue(String name, MethodParameter parameter, Message<?> message) protected voidHeaderMethodArgumentResolver.handleMissingValue(String headerName, MethodParameter parameter, Message<?> message) protected voidAbstractNamedValueMethodArgumentResolver.handleResolvedValue(@Nullable Object arg, String name, MethodParameter parameter, Message<?> message) Invoked after a value is resolved.AbstractNamedValueMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) HeadersMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) MessageMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) PayloadMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) AbstractNamedValueMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) Resolves the given parameter type and value name into an argument value.DestinationVariableMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) HeaderMethodArgumentResolver.resolveArgumentInternal(MethodParameter parameter, Message<?> message, String name) protected Class<?>PayloadMethodArgumentResolver.resolveTargetClass(MethodParameter parameter, Message<?> message) Resolve the target class to convert the payload to.protected voidPayloadMethodArgumentResolver.validate(Message<?> message, MethodParameter parameter, Object target) Validate the payload if applicable.Constructors in org.springframework.messaging.handler.annotation.support with parameters of type MessageModifierConstructorDescriptionMethodArgumentNotValidException(Message<?> message, MethodParameter parameter) Create a new instance with the invalidMethodParameter.MethodArgumentNotValidException(Message<?> message, MethodParameter parameter, BindingResult bindingResult) Create a new instance with the invalidMethodParameterand aBindingResult.MethodArgumentTypeMismatchException(Message<?> message, MethodParameter parameter, String description) -
Uses of Message in org.springframework.messaging.handler.invocation
Methods in org.springframework.messaging.handler.invocation with parameters of type MessageModifier and TypeMethodDescriptionAbstractMethodMessageHandler.getDestination(Message<?> message) protected abstract Comparator<T>AbstractMethodMessageHandler.getMappingComparator(Message<?> message) Return a comparator for sorting matching mappings.AbstractMethodMessageHandler.getMatchingMapping(T mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.InvocableHandlerMethod.getMethodArgumentValues(Message<?> message, @Nullable Object... providedArgs) Get the method argument values for the current message, checking the provided argument values and falling back to the configured argument resolvers.protected voidAbstractMethodMessageHandler.handleMatch(T mapping, HandlerMethod handlerMethod, String lookupDestination, Message<?> message) voidAbstractMethodMessageHandler.handleMessage(Message<?> message) protected voidAbstractMethodMessageHandler.handleMessageInternal(Message<?> message, String lookupDestination) protected voidAbstractMethodMessageHandler.handleNoMatch(Set<T> ts, String lookupDestination, Message<?> message) voidAbstractAsyncReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) voidHandlerMethodReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) Handle the given return value.voidHandlerMethodReturnValueHandlerComposite.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) Invoke the method after resolving its argument values in the context of the given message.protected voidAbstractMethodMessageHandler.processHandlerMethodException(HandlerMethod handlerMethod, Exception exception, Message<?> message) HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) Resolves a method parameter into an argument value from a given message.HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter, Message<?> message) Iterate over registeredHandlerMethodArgumentResolversand invoke the one that supports it.Constructors in org.springframework.messaging.handler.invocation with parameters of type MessageModifierConstructorDescriptionMethodArgumentResolutionException(Message<?> message, MethodParameter parameter) Create a new instance providing the invalidMethodParameter.MethodArgumentResolutionException(Message<?> message, MethodParameter parameter, String description) Create a new instance providing the invalidMethodParameterand a prepared description.MethodArgumentResolutionException(Message<?> message, MethodParameter parameter, String description, @Nullable Throwable cause) Create a new instance providing the invalidMethodParameter, prepared description, and a cause. -
Uses of Message in org.springframework.messaging.handler.invocation.reactive
Methods in org.springframework.messaging.handler.invocation.reactive with parameters of type MessageModifier and TypeMethodDescriptionprotected abstract @Nullable RouteMatcher.RouteAbstractMethodMessageHandler.getDestination(Message<?> message) Extract the destination from the given message.protected abstract Comparator<T>AbstractMethodMessageHandler.getMappingComparator(Message<?> message) Return a comparator for sorting matching mappings.AbstractMethodMessageHandler.getMatchingMapping(T mapping, Message<?> message) Check if a mapping matches the current message and return a possibly new mapping with conditions relevant to the current request.protected abstract reactor.core.publisher.Mono<Void>AbstractEncoderMethodReturnValueHandler.handleEncodedContent(reactor.core.publisher.Flux<DataBuffer> encodedContent, MethodParameter returnType, Message<?> message) Subclasses implement this method to handle encoded values in some way such as creating and sending messages.protected reactor.core.publisher.Mono<Void>AbstractMethodMessageHandler.handleMatch(T mapping, HandlerMethod handlerMethod, Message<?> message) reactor.core.publisher.Mono<Void>AbstractMethodMessageHandler.handleMessage(Message<?> message) protected abstract reactor.core.publisher.Mono<Void>AbstractEncoderMethodReturnValueHandler.handleNoContent(MethodParameter returnType, Message<?> message) Invoked for anullreturn value, which could mean a void method or method returning an async type parameterized by void.protected voidAbstractMethodMessageHandler.handleNoMatch(@Nullable RouteMatcher.Route destination, Message<?> message) Invoked when no matching handler is found.reactor.core.publisher.Mono<Void>AbstractEncoderMethodReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) reactor.core.publisher.Mono<Void>HandlerMethodReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) Handle the given return value.reactor.core.publisher.Mono<Void>HandlerMethodReturnValueHandlerComposite.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) reactor.core.publisher.Mono<Object>Invoke the method for the given exchange.reactor.core.publisher.Mono<Object>HandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) Resolves a method parameter into an argument value from a given message.reactor.core.publisher.Mono<Object>HandlerMethodArgumentResolverComposite.resolveArgument(MethodParameter parameter, Message<?> message) Iterate over registeredHandlerMethodArgumentResolversand invoke the one that supports it.default reactor.core.publisher.Mono<Object>SyncHandlerMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) Resolves a method parameter into an argument value from a given message.SyncHandlerMethodArgumentResolver.resolveArgumentValue(MethodParameter parameter, Message<?> message) Resolve the value for the method parameter synchronously. -
Uses of Message in org.springframework.messaging.rsocket.annotation.support
Methods in org.springframework.messaging.rsocket.annotation.support with parameters of type MessageModifier and TypeMethodDescriptionintRSocketFrameTypeMessageCondition.compareTo(RSocketFrameTypeMessageCondition other, Message<?> message) static @Nullable io.rsocket.frame.FrameTypeRSocketFrameTypeMessageCondition.getFrameType(Message<?> message) Find the RSocket frame type in the message headers.RSocketFrameTypeMessageCondition.getMatchingCondition(Message<?> message) protected reactor.core.publisher.Mono<Void>RSocketPayloadReturnValueHandler.handleEncodedContent(reactor.core.publisher.Flux<DataBuffer> encodedContent, MethodParameter returnType, Message<?> message) protected reactor.core.publisher.Mono<Void>RSocketPayloadReturnValueHandler.handleNoContent(MethodParameter returnType, Message<?> message) protected voidRSocketMessageHandler.handleNoMatch(@Nullable RouteMatcher.Route destination, Message<?> message) reactor.core.publisher.Mono<Object>RSocketRequesterMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) -
Uses of Message in org.springframework.messaging.simp
Methods in org.springframework.messaging.simp with parameters of type MessageModifier and TypeMethodDescriptionintSimpMessageMappingInfo.compareTo(SimpMessageMappingInfo other, Message<?> message) intSimpMessageTypeMessageCondition.compareTo(SimpMessageTypeMessageCondition other, Message<?> message) protected MessageHeaderAccessorSimpMessageHeaderAccessor.createAccessor(Message<?> message) protected voidstatic SimpAttributesSimpAttributes.fromMessage(Message<?> message) Extract the SiMP session attributes from the given message and wrap them in aSimpAttributesinstance.SimpMessageMappingInfo.getMatchingCondition(Message<?> message) SimpMessageTypeMessageCondition.getMatchingCondition(Message<?> message) voidIf the headers of the given message already contain aSimpMessageHeaderAccessor#DESTINATION_HEADERthen the message is sent without further changes.static voidSimpAttributesContextHolder.setAttributesFromMessage(Message<?> message) Extract the SiMP session attributes from the given message, wrap them in aSimpAttributesinstance and bind it to the current thread.static SimpMessageHeaderAccessorCreate an instance by copying the headers of a Message.Constructors in org.springframework.messaging.simp with parameters of type MessageModifierConstructorDescriptionprotectedSimpMessageHeaderAccessor(Message<?> message) A constructor for accessing and modifying existing message headers. -
Uses of Message in org.springframework.messaging.simp.annotation.support
Methods in org.springframework.messaging.simp.annotation.support with parameters of type MessageModifier and TypeMethodDescriptionSimpAnnotationMethodMessageHandler.getDestination(Message<?> message) protected Comparator<SimpMessageMappingInfo>SimpAnnotationMethodMessageHandler.getMappingComparator(Message<?> message) protected @Nullable SimpMessageMappingInfoSimpAnnotationMethodMessageHandler.getMatchingMapping(SimpMessageMappingInfo mapping, Message<?> message) protected String[]SendToMethodReturnValueHandler.getTargetDestinations(@Nullable Annotation annotation, Message<?> message, String defaultPrefix) SendToMethodReturnValueHandler.getUserName(Message<?> message, MessageHeaders headers) protected voidSimpAnnotationMethodMessageHandler.handleMatch(SimpMessageMappingInfo mapping, HandlerMethod handlerMethod, String lookupDestination, Message<?> message) voidSendToMethodReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) voidSubscriptionMethodReturnValueHandler.handleReturnValue(@Nullable Object returnValue, MethodParameter returnType, Message<?> message) PrincipalMethodArgumentResolver.resolveArgument(MethodParameter parameter, Message<?> message) Constructors in org.springframework.messaging.simp.annotation.support with parameters of type Message -
Uses of Message in org.springframework.messaging.simp.broker
Methods in org.springframework.messaging.simp.broker with parameters of type MessageModifier and TypeMethodDescriptionprotected abstract voidAbstractSubscriptionRegistry.addSubscriptionInternal(String sessionId, String subscriptionId, String destination, Message<?> message) protected voidDefaultSubscriptionRegistry.addSubscriptionInternal(String sessionId, String subscriptionId, String destination, Message<?> message) final MultiValueMap<String,String> AbstractSubscriptionRegistry.findSubscriptions(Message<?> message) SubscriptionRegistry.findSubscriptions(Message<?> message) Find all subscriptions that should receive the given message.protected abstract MultiValueMap<String,String> AbstractSubscriptionRegistry.findSubscriptionsInternal(String destination, Message<?> message) protected MultiValueMap<String,String> DefaultSubscriptionRegistry.findSubscriptionsInternal(String destination, Message<?> message) OrderedMessageChannelDecorator.getNextMessageTask(Message<?> message) Obtain the task to release the next message, if found.voidAbstractBrokerMessageHandler.handleMessage(Message<?> message) protected abstract voidAbstractBrokerMessageHandler.handleMessageInternal(Message<?> message) protected voidSimpleBrokerMessageHandler.handleMessageInternal(Message<?> message) final voidAbstractSubscriptionRegistry.registerSubscription(Message<?> message) voidSubscriptionRegistry.registerSubscription(Message<?> subscribeMessage) Register a subscription represented by the given message.protected abstract voidAbstractSubscriptionRegistry.removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message) protected voidDefaultSubscriptionRegistry.removeSubscriptionInternal(String sessionId, String subscriptionId, Message<?> message) booleanbooleanprotected voidSimpleBrokerMessageHandler.sendMessageToSubscribers(@Nullable String destination, Message<?> message) final voidAbstractSubscriptionRegistry.unregisterSubscription(Message<?> message) voidSubscriptionRegistry.unregisterSubscription(Message<?> unsubscribeMessage) Unregister a subscription. -
Uses of Message in org.springframework.messaging.simp.stomp
Methods in org.springframework.messaging.simp.stomp that return types with arguments of type MessageModifier and TypeMethodDescriptionBufferingStompDecoder.decode(ByteBuffer newBuffer) Decodes one or more STOMP frames from the givenByteBufferinto a list ofMessages.StompDecoder.decode(ByteBuffer byteBuffer) Decodes one or more STOMP frames from the givenByteBufferinto a list ofMessages.StompDecoder.decode(ByteBuffer byteBuffer, @Nullable MultiValueMap<String, String> partialMessageHeaders) Decodes one or more STOMP frames from the givenbufferand returns a list ofMessages.StompTcpMessageCodec.decode(ByteBuffer nioBuffer) StompReactorNettyCodec.decodeInternal(ByteBuffer nioBuffer) Methods in org.springframework.messaging.simp.stomp with parameters of type MessageModifier and TypeMethodDescriptionprotected MessageHeaderAccessorStompHeaderAccessor.createAccessor(Message<?> message) byte[]Encodes the given STOMPmessageinto abyte[].protected ByteBufferStompReactorNettyCodec.encodeInternal(Message<byte[]> message) voidDefaultStompSession.handleMessage(Message<byte[]> message) protected voidStompBrokerRelayMessageHandler.handleMessageInternal(Message<?> message) static StompHeaderAccessorCreate an instance from the payload and headers of the given Message. -
Uses of Message in org.springframework.messaging.simp.user
Methods in org.springframework.messaging.simp.user with parameters of type MessageModifier and TypeMethodDescriptionvoidUserDestinationMessageHandler.handleMessage(Message<?> sourceMessage) voidUserRegistryMessageHandler.handleMessage(Message<?> message) DefaultUserDestinationResolver.resolveDestination(Message<?> message) UserDestinationResolver.resolveDestination(Message<?> message) Resolve the given message with a user destination to one or more messages with actual destinations, one for each active user session. -
Uses of Message in org.springframework.messaging.support
Classes in org.springframework.messaging.support that implement MessageModifier and TypeClassDescriptionclassAGenericMessagewith aThrowablepayload.classAn implementation ofMessagewith a generic payload.Methods in org.springframework.messaging.support that return MessageModifier and TypeMethodDescriptionAbstractMessageChannel.ChannelInterceptorChain.applyPostReceive(Message<?> message, MessageChannel channel) AbstractMessageChannel.ChannelInterceptorChain.applyPreSend(Message<?> message, MessageChannel channel) ExecutorChannelInterceptor.beforeHandle(Message<?> message, MessageChannel channel, MessageHandler handler) Invoked inside theRunnablesubmitted to the Executor just before calling the target MessageHandler to handle the message.MessageBuilder.build()static <T> Message<T>MessageBuilder.createMessage(T payload, MessageHeaders messageHeaders) A shortcut factory method for creating a message with the given payload andMessageHeaders.Message<?>MessageHandlingRunnable.getMessage()Return the Message that will be handled.ErrorMessage.getOriginalMessage()Return the original message (if available) at the point in the stack where the ErrorMessage was created.ChannelInterceptor.postReceive(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller.ChannelInterceptor.preSend(Message<?> message, MessageChannel channel) Invoked before the Message is actually sent to the channel.Message<?>ImmutableMessageChannelInterceptor.preSend(Message<?> message, MessageChannel channel) Methods in org.springframework.messaging.support with parameters of type MessageModifier and TypeMethodDescriptiondefault voidExecutorChannelInterceptor.afterMessageHandled(Message<?> message, MessageChannel channel, MessageHandler handler, @Nullable Exception ex) Invoked inside theRunnablesubmitted to the Executor after calling the target MessageHandler regardless of the outcome (i.e.default voidChannelInterceptor.afterReceiveCompletion(@Nullable Message<?> message, MessageChannel channel, @Nullable Exception ex) Invoked after the completion of a receive regardless of any exception that have been raised thus allowing for proper resource cleanup.default voidChannelInterceptor.afterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, @Nullable Exception ex) Invoked after the completion of a send regardless of any exception that have been raised thus allowing for proper resource cleanup.AbstractMessageChannel.ChannelInterceptorChain.applyPostReceive(Message<?> message, MessageChannel channel) voidAbstractMessageChannel.ChannelInterceptorChain.applyPostSend(Message<?> message, MessageChannel channel, boolean sent) AbstractMessageChannel.ChannelInterceptorChain.applyPreSend(Message<?> message, MessageChannel channel) ExecutorChannelInterceptor.beforeHandle(Message<?> message, MessageChannel channel, MessageHandler handler) Invoked inside theRunnablesubmitted to the Executor just before calling the target MessageHandler to handle the message.protected MessageHeaderAccessorMessageHeaderAccessor.createAccessor(Message<?> message) Build a 'nested' accessor for the given message.static <T> MessageBuilder<T>MessageBuilder.fromMessage(Message<T> message) Create a builder for a newMessageinstance pre-populated with all the headers copied from the provided message.static @Nullable MessageHeaderAccessorMessageHeaderAccessor.getAccessor(Message<?> message) Return the originalMessageHeaderAccessorused to create the headers of the givenMessage, ornullif that's not available or if its type does not match the required type.static <T extends MessageHeaderAccessor>
@Nullable TMessageHeaderAccessor.getAccessor(Message<?> message, @Nullable Class<T> requiredType) Return the originalMessageHeaderAccessorused to create the headers of the givenMessage, ornullif that's not available or if its type does not match the required type.static MessageHeaderAccessorMessageHeaderAccessor.getMutableAccessor(Message<?> message) Return a mutableMessageHeaderAccessorfor the given message attempting to match the type of accessor used to create the message headers, or otherwise wrapping the message with aMessageHeaderAccessorinstance.ChannelInterceptor.postReceive(Message<?> message, MessageChannel channel) Invoked immediately after a Message has been retrieved but before it is returned to the caller.default voidChannelInterceptor.postSend(Message<?> message, MessageChannel channel, boolean sent) Invoked immediately after the send invocation.ChannelInterceptor.preSend(Message<?> message, MessageChannel channel) Invoked before the Message is actually sent to the channel.Message<?>ImmutableMessageChannelInterceptor.preSend(Message<?> message, MessageChannel channel) final booleanfinal booleanprotected abstract booleanAbstractMessageChannel.sendInternal(Message<?> message, long timeout) booleanExecutorSubscribableChannel.sendInternal(Message<?> message, long timeout) voidAbstractMessageChannel.ChannelInterceptorChain.triggerAfterReceiveCompletion(@Nullable Message<?> message, MessageChannel channel, @Nullable Exception ex) voidAbstractMessageChannel.ChannelInterceptorChain.triggerAfterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, @Nullable Exception ex) Constructors in org.springframework.messaging.support with parameters of type MessageModifierConstructorDescriptionCreate a new message with the given payload, headers and original message.ErrorMessage(Throwable payload, Message<?> originalMessage) Create a new message with the given payload and original message.ErrorMessage(Throwable payload, MessageHeaders headers, Message<?> originalMessage) Create a new message with the payload,MessageHeadersand original message.MessageHeaderAccessor(@Nullable Message<?> message) A constructor accepting the headers of an existing message to copy.protectedNativeMessageHeaderAccessor(@Nullable Message<?> message) Protected constructor that copies headers from another message. -
Uses of Message in org.springframework.messaging.tcp
Methods in org.springframework.messaging.tcp with parameters of type MessageModifier and TypeMethodDescriptionvoidTcpConnectionHandler.handleMessage(Message<P> message) Handle a message received from the remote host.Send the given message. -
Uses of Message in org.springframework.messaging.tcp.reactor
Methods in org.springframework.messaging.tcp.reactor that return types with arguments of type MessageModifier and TypeMethodDescriptionAbstractNioBufferReactorNettyCodec.decode(io.netty.buffer.ByteBuf inputBuffer) ReactorNettyCodec.decode(io.netty.buffer.ByteBuf inputBuffer) Decode the inputByteBufinto one or moreMessages.TcpMessageCodec.decode(ByteBuffer buffer) Decode the inputByteBufferinto one or moreMessages.AbstractNioBufferReactorNettyCodec.decodeInternal(ByteBuffer nioBuffer) Methods in org.springframework.messaging.tcp.reactor with parameters of type MessageModifier and TypeMethodDescriptionvoidvoidEncode the givenMessageto the outputByteBuf.Encode the givenMessageto the outputByteBuffer.protected abstract ByteBufferAbstractNioBufferReactorNettyCodec.encodeInternal(Message<P> message) -
Uses of Message in org.springframework.web.socket.messaging
Methods in org.springframework.web.socket.messaging that return MessageModifier and TypeMethodDescriptionMessage<byte[]>AbstractSubProtocolEvent.getMessage()Return the Message associated with the event.StompSubProtocolErrorHandler.handleClientMessageProcessingError(@Nullable Message<byte[]> clientMessage, Throwable ex) SubProtocolErrorHandler.handleClientMessageProcessingError(@Nullable Message<P> clientMessage, Throwable ex) Handle errors thrown while processing client messages providing an opportunity to prepare the error message or to prevent one from being sent.StompSubProtocolErrorHandler.handleErrorMessageToClient(Message<byte[]> errorMessage) SubProtocolErrorHandler.handleErrorMessageToClient(Message<P> errorMessage) Handle errors sent from the server side to clients, for example, errors from the"broke relay"because connectivity failed or the external broker sent an error message, etc.protected Message<byte[]>StompSubProtocolErrorHandler.handleInternal(StompHeaderAccessor errorHeaderAccessor, byte[] errorPayload, @Nullable Throwable cause, @Nullable StompHeaderAccessor clientHeaderAccessor) Methods in org.springframework.web.socket.messaging with parameters of type MessageModifier and TypeMethodDescriptionStompSubProtocolErrorHandler.handleClientMessageProcessingError(@Nullable Message<byte[]> clientMessage, Throwable ex) SubProtocolErrorHandler.handleClientMessageProcessingError(@Nullable Message<P> clientMessage, Throwable ex) Handle errors thrown while processing client messages providing an opportunity to prepare the error message or to prevent one from being sent.StompSubProtocolErrorHandler.handleErrorMessageToClient(Message<byte[]> errorMessage) SubProtocolErrorHandler.handleErrorMessageToClient(Message<P> errorMessage) Handle errors sent from the server side to clients, for example, errors from the"broke relay"because connectivity failed or the external broker sent an error message, etc.voidSubProtocolWebSocketHandler.handleMessage(Message<?> message) Handle an outbound Spring Message to a WebSocket client.voidStompSubProtocolHandler.handleMessageToClient(WebSocketSession session, Message<?> message) Handle STOMP messages going back out to WebSocket clients.voidSubProtocolHandler.handleMessageToClient(WebSocketSession session, Message<?> message) Handle the givenMessageto the client associated with the given WebSocket session.StompSubProtocolHandler.resolveSessionId(Message<?> message) SubProtocolHandler.resolveSessionId(Message<?> message) Resolve the session id from the given message or returnnull.protected StompHeaderAccessorStompSubProtocolHandler.toMutableAccessor(StompHeaderAccessor headerAccessor, Message<?> message) Constructors in org.springframework.web.socket.messaging with parameters of type MessageModifierConstructorDescriptionprotectedAbstractSubProtocolEvent(Object source, Message<byte[]> message) Create a new AbstractSubProtocolEvent.protectedAbstractSubProtocolEvent(Object source, Message<byte[]> message, @Nullable Principal user) Create a new AbstractSubProtocolEvent.SessionConnectedEvent(Object source, Message<byte[]> message) Create a new SessionConnectedEvent.SessionConnectedEvent(Object source, Message<byte[]> message, @Nullable Principal user) SessionConnectEvent(Object source, Message<byte[]> message) Create a new SessionConnectEvent.SessionConnectEvent(Object source, Message<byte[]> message, @Nullable Principal user) SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus) Create a new SessionDisconnectEvent.SessionDisconnectEvent(Object source, Message<byte[]> message, String sessionId, CloseStatus closeStatus, @Nullable Principal user) Create a new SessionDisconnectEvent.SessionSubscribeEvent(Object source, Message<byte[]> message) SessionSubscribeEvent(Object source, Message<byte[]> message, @Nullable Principal user) SessionUnsubscribeEvent(Object source, Message<byte[]> message) SessionUnsubscribeEvent(Object source, Message<byte[]> message, @Nullable Principal user)