Class RSocketMessageHandler
- All Implemented Interfaces:
Aware
,BeanNameAware
,InitializingBean
,ApplicationContextAware
,EmbeddedValueResolverAware
,ReactiveMessageHandler
MessageMappingMessageHandler
for handling RSocket
requests with @ConnectMapping
and
@MessageMapping
methods.
For server scenarios this class can be declared as a bean in Spring
configuration and that would detect @MessageMapping
methods in
@Controller
beans. What beans are checked can be changed through a
handlerPredicate
. Given an instance
of this class, you can then use responder()
to obtain a
SocketAcceptor
adapter to register with the
RSocketServer
.
For a client, possibly in the same process as a server, consider using the
static factory method responder(RSocketStrategies, Object...)
to
obtain a client responder to be registered via
RSocketRequester.Builder
.
For @MessageMapping
methods, this class automatically determines
the RSocket interaction type based on the input and output cardinality of the
method. See the
"Annotated Responders" section of the Spring Framework reference for more details.
- Since:
- 5.2
- Author:
- Rossen Stoyanchev
-
Field Summary
Fields inherited from class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
logger
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.protected CompositeMessageCondition
extendMapping
(CompositeMessageCondition composite, HandlerMethod handler) This method is invoked just before mappings are added.protected CompositeMessageCondition
getCondition
(AnnotatedElement element) Determine the mapping condition for the given annotated element.Return the configureddefaultDataMimeType
, ornull
.Return the configureddefaultMetadataMimeType
.Return the configuredencoders
.Return the configuredMetadataExtractor
.Return theconfigured
RSocketStrategies
.protected void
handleNoMatch
(RouteMatcher.Route destination, Message<?> message) Invoked when no matching handler is found.protected List<? extends HandlerMethodReturnValueHandler>
Return the list of return value handlers to use.Return an RSocketSocketAcceptor
backed by thisRSocketMessageHandler
instance that can be plugged in as aclient
orserver
RSocket responder.static SocketAcceptor
responder
(RSocketStrategies strategies, Object... candidateHandlers) Static factory method to create an RSocketSocketAcceptor
backed by handlers with annotated methods.void
setDecoders
(List<? extends Decoder<?>> decoders) Configure the decoders to use for incoming payloads.void
setDefaultDataMimeType
(MimeType mimeType) Configure the default content type to use for data payloads if theSETUP
frame did not specify one.void
setDefaultMetadataMimeType
(MimeType mimeType) Configure the defaultMimeType
for payload data if theSETUP
frame did not specify one.void
setEncoders
(List<? extends Encoder<?>> encoders) Configure the encoders to use for encoding handler method return values.void
setMetadataExtractor
(MetadataExtractor extractor) Configure aMetadataExtractor
to extract the route along with other metadata.void
Configure the registry for adapting various reactive types.void
setRouteMatcher
(RouteMatcher routeMatcher) Set theRouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with.void
setRSocketStrategies
(RSocketStrategies rsocketStrategies) Configure this handler through anRSocketStrategies
instance which can be re-used to initialize a client-sideRSocketRequester
.Methods inherited from class org.springframework.messaging.handler.annotation.reactive.MessageMappingMessageHandler
createExceptionMethodResolverFor, getConversionService, getDecoders, getDestination, getDirectLookupMappings, getMappingComparator, getMappingForMethod, getMatchingMapping, getRouteMatcher, getValidator, handleMatch, initArgumentResolvers, obtainRouteMatcher, processDestinations, registerMessagingAdvice, setConversionService, setEmbeddedValueResolver, setValidator
Methods inherited from class org.springframework.messaging.handler.invocation.reactive.AbstractMethodMessageHandler
detectHandlerMethods, getApplicationContext, getArgumentResolverConfigurer, getArgumentResolvers, getBeanName, getDestinationLookup, getHandlerMethods, getHandlerPredicate, getReactiveAdapterRegistry, getReturnValueHandlerConfigurer, handleMessage, registerExceptionHandlerAdvice, registerHandlerMethod, setApplicationContext, setArgumentResolverConfigurer, setBeanName, setHandlerPredicate, setHandlers, setReturnValueHandlerConfigurer
-
Constructor Details
-
RSocketMessageHandler
public RSocketMessageHandler()
-
-
Method Details
-
setEncoders
Configure the encoders to use for encoding handler method return values.When
rsocketStrategies
is set, this property is re-initialized with the encoders in it, and likewise when this property is set theRSocketStrategies
are mutated to change the encoders in it.By default this is set to the defaults from
RSocketStrategies
. -
getEncoders
Return the configuredencoders
. -
setDecoders
Configure the decoders to use for incoming payloads.When
rsocketStrategies
is set, this property is re-initialized with the decoders in it, and likewise when this property is set theRSocketStrategies
are mutated to change the decoders in them.By default this is set to the defaults from
RSocketStrategies
.- Overrides:
setDecoders
in classMessageMappingMessageHandler
-
setRouteMatcher
Set theRouteMatcher
to use for mapping messages to handlers based on the route patterns they're configured with.By default,
SimpleRouteMatcher
is used, backed byAntPathMatcher
with "." as separator. For greater efficiency consider using thePathPatternRouteMatcher
fromspring-web
instead.When
rsocketStrategies
is set, this property is re-initialized with the route matcher in it, and likewise when this property is set theRSocketStrategies
are mutated to change the matcher in it.By default this is set to the defaults from
RSocketStrategies
.- Overrides:
setRouteMatcher
in classMessageMappingMessageHandler
-
setReactiveAdapterRegistry
Configure the registry for adapting various reactive types.When
rsocketStrategies
is set, this property is re-initialized with the registry in it, and likewise when this property is set theRSocketStrategies
are mutated to change the registry in it.By default this is set to the
defaults
fromRSocketStrategies
.- Overrides:
setReactiveAdapterRegistry
in classAbstractMethodMessageHandler<CompositeMessageCondition>
-
setMetadataExtractor
Configure aMetadataExtractor
to extract the route along with other metadata.When
rsocketStrategies
is set, this property is re-initialized with the extractor in it, and likewise when this property is set theRSocketStrategies
are mutated to change the extractor in it.By default this is set to the
RSocketStrategies.Builder.metadataExtractor(MetadataExtractor)
defaults} fromRSocketStrategies
.- Parameters:
extractor
- the extractor to use
-
getMetadataExtractor
Return the configuredMetadataExtractor
. -
setRSocketStrategies
Configure this handler through anRSocketStrategies
instance which can be re-used to initialize a client-sideRSocketRequester
.When this property is set, in turn it sets the following:
setDecoders(List)
setEncoders(List)
setRouteMatcher(RouteMatcher)
setMetadataExtractor(MetadataExtractor)
setReactiveAdapterRegistry(ReactiveAdapterRegistry)
By default this is set to
RSocketStrategies.create()
which in turn sets default settings for all related properties. -
getRSocketStrategies
Return theconfigured
RSocketStrategies
. -
setDefaultDataMimeType
Configure the default content type to use for data payloads if theSETUP
frame did not specify one.By default this is not set.
- Parameters:
mimeType
- the MimeType to use
-
getDefaultDataMimeType
Return the configureddefaultDataMimeType
, ornull
. -
setDefaultMetadataMimeType
Configure the defaultMimeType
for payload data if theSETUP
frame did not specify one.By default this is set to
"message/x.rsocket.composite-metadata.v0"
- Parameters:
mimeType
- the MimeType to use
-
getDefaultMetadataMimeType
Return the configureddefaultMetadataMimeType
. -
afterPropertiesSet
public void afterPropertiesSet()Description copied from interface:InitializingBean
Invoked by the containingBeanFactory
after it has set all bean properties and satisfiedBeanFactoryAware
,ApplicationContextAware
etc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSet
in interfaceInitializingBean
- Overrides:
afterPropertiesSet
in classMessageMappingMessageHandler
-
initReturnValueHandlers
Description copied from class:AbstractMethodMessageHandler
Return the list of return value handlers to use.Subclasses should also take into account custom return value types configured via
AbstractMethodMessageHandler.setReturnValueHandlerConfigurer(org.springframework.messaging.handler.invocation.reactive.ReturnValueHandlerConfigurer)
.- Overrides:
initReturnValueHandlers
in classMessageMappingMessageHandler
-
getCondition
Description copied from class:MessageMappingMessageHandler
Determine the mapping condition for the given annotated element.- Overrides:
getCondition
in classMessageMappingMessageHandler
- Parameters:
element
- the element to check- Returns:
- the condition, or
null
-
extendMapping
protected CompositeMessageCondition extendMapping(CompositeMessageCondition composite, HandlerMethod handler) Description copied from class:AbstractMethodMessageHandler
This method is invoked just before mappings are added. It allows sub-classes to update the mapping with theHandlerMethod
in mind. This can be useful when the method signature is used to refine the mapping, e.g. based on the cardinality of input and output.By default this method returns the mapping that is passed in.
- Overrides:
extendMapping
in classAbstractMethodMessageHandler<CompositeMessageCondition>
- Parameters:
composite
- the mapping to be addedhandler
- the target handler for the mapping- Returns:
- a new mapping or the same
-
handleNoMatch
Description copied from class:AbstractMethodMessageHandler
Invoked when no matching handler is found.- Overrides:
handleNoMatch
in classAbstractMethodMessageHandler<CompositeMessageCondition>
- Parameters:
destination
- the destinationmessage
- the message
-
responder
Return an RSocketSocketAcceptor
backed by thisRSocketMessageHandler
instance that can be plugged in as aclient
orserver
RSocket responder.The initial
ConnectionSetupPayload
is handled through@ConnectionMapping
methods that can be asynchronous and returnMono<Void>
with an error signal preventing the connection. Such a method can also start requests to the client but that must be done decoupled from handling and from the current thread.Subsequent requests on the connection can be handled with
MessageMapping
methods. -
responder
Static factory method to create an RSocketSocketAcceptor
backed by handlers with annotated methods. Effectively a shortcut for:RSocketMessageHandler handler = new RSocketMessageHandler(); handler.setHandlers(handlers); handler.setRSocketStrategies(strategies); handler.afterPropertiesSet(); SocketAcceptor acceptor = handler.responder();
This is intended for programmatic creation and registration of a client-side responder. For example:
SocketAcceptor responder = RSocketMessageHandler.responder(strategies, new ClientHandler()); RSocketRequester.builder() .rsocketConnector(connector -> connector.acceptor(responder)) .connectTcp("localhost", server.address().getPort());
Note that the given handlers do not need to have any stereotype annotations such as
@Controller
which helps to avoid overlap with server side handlers that may be used in the same application. However, for more advanced scenarios, e.g. discovering handlers through a custom stereotype annotation, consider declaringRSocketMessageHandler
as a bean, and then obtain the responder from it.- Parameters:
strategies
- the strategies to set on the createdRSocketMessageHandler
candidateHandlers
- a list of Objects and/or Classes with annotated handler methods; used to callAbstractMethodMessageHandler.setHandlers(List)
with on the createdRSocketMessageHandler
- Returns:
- a configurer that may be passed into
RSocketRequester.Builder.rsocketConnector(org.springframework.messaging.rsocket.RSocketConnectorConfigurer)
- Since:
- 5.2.6
-