Class ServerRSocketConnector

java.lang.Object

org.springframework.integration.rsocket.AbstractRSocketConnector

org.springframework.integration.rsocket.ServerRSocketConnector

All Implemented Interfaces:

Aware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle

public class ServerRSocketConnector
extends AbstractRSocketConnector
implements ApplicationEventPublisherAware

A server AbstractRSocketConnector extension to accept and manage client RSocket connections.

Since:

5.2

Author:

Artem Bilan

See Also:

• RSocketConnector

Field Summary

Fields inherited from class org.springframework.integration.rsocket.AbstractRSocketConnector

rSocketMessageHandler

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ServerRSocketConnector(io.rsocket.transport.ServerTransport<io.rsocket.transport.netty.server.CloseableChannel> serverTransport)	Instantiate a server connector based on the provided ServerTransport.
ServerRSocketConnector(String bindAddress, int port)	Instantiate a server connector based on the TcpServerTransport.
ServerRSocketConnector(ServerRSocketMessageHandler serverRSocketMessageHandler)	Instantiate a server connector based on a provided ServerRSocketMessageHandler with an assumption that RSocket server is created externally as well.
ServerRSocketConnector(reactor.netty.http.server.HttpServer server)	Instantiate a server connector based on the WebsocketServerTransport.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	afterSingletonsInstantiated()
void	destroy()
protected void	doStart()
reactor.core.publisher.Mono<Integer>	getBoundPort()	Return the port this internal server is bound or empty Mono.
RSocketRequester	getClientRSocketRequester(Object key)	Return connected RSocketRequester mapped by key or null.
Map<Object,RSocketRequester>	getClientRSocketRequesters()	Return connected RSocketRequesters mapped by keys.
void	setApplicationContext(ApplicationContext applicationContext)
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setClientRSocketKeyStrategy(BiFunction<Map<String,Object>,DataBuffer,Object> clientRSocketKeyStrategy)	Configure a strategy to determine a key for the client RSocketRequester connected.
void	setDataMimeType(MimeType dataMimeType)	Configure a MimeType for data exchanging.
void	setMetadataMimeType(MimeType metadataMimeType)	Configure a MimeType for metadata exchanging.
void	setRSocketStrategies(RSocketStrategies rsocketStrategies)	Configure a RSocketStrategies for data encoding/decoding.
void	setServerConfigurer(Consumer<io.rsocket.core.RSocketServer> serverConfigurer)	Provide a Consumer to configure the RSocketServer.

Methods inherited from class org.springframework.integration.rsocket.AbstractRSocketConnector

addEndpoint, getDataMimeType, getMetadataMimeType, getRSocketStrategies, isAutoStartup, isRunning, setAutoStartup, setEndpoints, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, stop

Constructor Details

ServerRSocketConnector

public ServerRSocketConnector(ServerRSocketMessageHandler serverRSocketMessageHandler)

Instantiate a server connector based on a provided ServerRSocketMessageHandler with an assumption that RSocket server is created externally as well. All other options are ignored in favor of provided ServerRSocketMessageHandler and its external RSocket server configuration.

Parameters:

serverRSocketMessageHandler - the ServerRSocketMessageHandler to rely on.

Since:

5.2.1

ServerRSocketConnector

public ServerRSocketConnector(String bindAddress,
 int port)

Instantiate a server connector based on the TcpServerTransport.

Parameters:

bindAddress - the local address to bind TCP server onto.

port - the local TCP port to bind.

See Also:

• ServerRSocketConnector(ServerTransport)

ServerRSocketConnector

public ServerRSocketConnector(reactor.netty.http.server.HttpServer server)

Instantiate a server connector based on the WebsocketServerTransport.

Parameters:

server - the HttpServer to use.

See Also:

• ServerRSocketConnector(ServerTransport)

ServerRSocketConnector

public ServerRSocketConnector(io.rsocket.transport.ServerTransport<io.rsocket.transport.netty.server.CloseableChannel> serverTransport)

Instantiate a server connector based on the provided ServerTransport.

Parameters:

serverTransport - the ServerTransport to make server based on.

Method Details

setServerConfigurer

public void setServerConfigurer(Consumer<io.rsocket.core.RSocketServer> serverConfigurer)

Provide a Consumer to configure the RSocketServer.

Parameters:

serverConfigurer - the Consumer to configure the RSocketServer.

Since:

5.2.6

setClientRSocketKeyStrategy

public void setClientRSocketKeyStrategy(BiFunction<Map<String,Object>,DataBuffer,Object> clientRSocketKeyStrategy)

Configure a strategy to determine a key for the client RSocketRequester connected. Defaults to the destination to which a client is connected.

Parameters:

clientRSocketKeyStrategy - the BiFunction to determine a key for client RSocketRequesters.

setDataMimeType

public void setDataMimeType(@Nullable
 MimeType dataMimeType)

Description copied from class: AbstractRSocketConnector

Configure a MimeType for data exchanging.

Overrides:

setDataMimeType in class AbstractRSocketConnector

Parameters:

dataMimeType - the MimeType to use.

setMetadataMimeType

public void setMetadataMimeType(MimeType metadataMimeType)

Description copied from class: AbstractRSocketConnector

Configure a MimeType for metadata exchanging. Default to "message/x.rsocket.composite-metadata.v0".

Overrides:

setMetadataMimeType in class AbstractRSocketConnector

Parameters:

metadataMimeType - the MimeType to use.

setRSocketStrategies

public void setRSocketStrategies(RSocketStrategies rsocketStrategies)

Description copied from class: AbstractRSocketConnector

Configure a RSocketStrategies for data encoding/decoding.

Overrides:

setRSocketStrategies in class AbstractRSocketConnector

Parameters:

rsocketStrategies - the RSocketStrategies to use.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Overrides:

setApplicationContext in class AbstractRSocketConnector

Throws:

BeansException

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractRSocketConnector

getClientRSocketRequesters

public Map<Object,RSocketRequester> getClientRSocketRequesters()

Return connected RSocketRequesters mapped by keys.

Returns:

connected RSocketRequesters mapped by keys.

See Also:

• ServerRSocketMessageHandler.getClientRSocketRequesters()

getClientRSocketRequester

@Nullable
public RSocketRequester getClientRSocketRequester(Object key)

Return connected RSocketRequester mapped by key or null.

Parameters:

key - the mapping key.

Returns:

the RSocketRequester or null.

See Also:

• ServerRSocketMessageHandler.getClientRSocketRequester(Object)

getBoundPort

public reactor.core.publisher.Mono<Integer> getBoundPort()

Return the port this internal server is bound or empty Mono.

Returns:

the port this internal server is bound or empty Mono if an external server is used.

doStart

protected void doStart()

Specified by:

doStart in class AbstractRSocketConnector

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

Overrides:

afterSingletonsInstantiated in class AbstractRSocketConnector