Class ClientRSocketConnector

java.lang.Object

org.springframework.integration.rsocket.AbstractRSocketConnector

org.springframework.integration.rsocket.ClientRSocketConnector

All Implemented Interfaces:

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

public class ClientRSocketConnector
extends AbstractRSocketConnector

A client AbstractRSocketConnector extension to the RSocket connection.

Since:

5.2

Author:

Artem Bilan

See Also:

• RSocketConnector
• RSocketRequester

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
ClientRSocketConnector(io.rsocket.transport.ClientTransport clientTransport)	Instantiate a connector based on the provided ClientTransport.
ClientRSocketConnector(String host, int port)	Instantiate a connector based on the TcpClientTransport.
ClientRSocketConnector(URI uri)	Instantiate a connector based on the WebsocketClientTransport.

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
void	afterSingletonsInstantiated()
void	connect()	Perform subscription into the RSocket server for incoming requests.
void	destroy()
protected void	doStart()
RSocketRequester	getRequester()	Return the RSocketRequester this connector is built on.
void	setConnectorConfigurer(RSocketConnectorConfigurer connectorConfigurer)	Callback to configure the ClientRSocketFactory directly.
void	setSetupData(Object setupData)	Set the data for the setup payload.
void	setSetupMetadata(Map<Object,MimeType> setupMetadata)	Add metadata to the setup payload.
void	setSetupRoute(String setupRoute)	Set the route for the setup payload.
void	setSetupRouteVariables(Object... setupRouteVars)	Set the variables for route template to expand with.

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

addEndpoint, getDataMimeType, getMetadataMimeType, getRSocketStrategies, isAutoStartup, isRunning, setApplicationContext, setAutoStartup, setDataMimeType, setEndpoints, setMetadataMimeType, setRSocketStrategies, 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

ClientRSocketConnector

public ClientRSocketConnector(String host,
 int port)

Instantiate a connector based on the TcpClientTransport.

Parameters:

host - the TCP host to connect.

port - the TCP port to connect.

See Also:

• ClientRSocketConnector(ClientTransport)

ClientRSocketConnector

public ClientRSocketConnector(URI uri)

Instantiate a connector based on the WebsocketClientTransport.

Parameters:

uri - the WebSocket URI to connect.

See Also:

• ClientRSocketConnector(ClientTransport)

ClientRSocketConnector

public ClientRSocketConnector(io.rsocket.transport.ClientTransport clientTransport)

Instantiate a connector based on the provided ClientTransport.

Parameters:

clientTransport - the ClientTransport to use.

See Also:

• RSocketRequester.Builder.transport(ClientTransport)

Method Details

setConnectorConfigurer

public void setConnectorConfigurer(RSocketConnectorConfigurer connectorConfigurer)

Callback to configure the ClientRSocketFactory directly. Note: this class adds extra RSocketConnectorConfigurer to the target RSocketRequester to populate a reference to an internal RSocketMessageHandler.responder(). This overrides possible external RSocketConnector.acceptor(io.rsocket.SocketAcceptor)

Parameters:

connectorConfigurer - the RSocketConnectorConfigurer to configure the RSocketConnector.

Since:

5.2.6

See Also:

• RSocketRequester.Builder.rsocketConnector(RSocketConnectorConfigurer)

setSetupRoute

public void setSetupRoute(String setupRoute)

Set the route for the setup payload.

Parameters:

setupRoute - the route to connect to.

See Also:

• RSocketRequester.Builder.setupRoute(String, Object...)

setSetupRouteVariables

public void setSetupRouteVariables(Object... setupRouteVars)

Set the variables for route template to expand with.

Parameters:

setupRouteVars - the route to connect to.

See Also:

• RSocketRequester.Builder.setupRoute(String, Object...)

setSetupMetadata

public void setSetupMetadata(Map<Object,MimeType> setupMetadata)

Add metadata to the setup payload. Composite metadata must be in use if this is called more than once or in addition to setSetupRoute(String).

Parameters:

setupMetadata - the map of metadata to use.

See Also:

• RSocketRequester.Builder.setupMetadata(Object, MimeType)

setSetupData

public void setSetupData(Object setupData)

Set the data for the setup payload.

Parameters:

setupData - the data for connect frame.

See Also:

• RSocketRequester.Builder.setupData(Object)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class AbstractRSocketConnector

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

Overrides:

afterSingletonsInstantiated in class AbstractRSocketConnector

doStart

protected void doStart()

Specified by:

doStart in class AbstractRSocketConnector

destroy

public void destroy()

connect

public void connect()

Perform subscription into the RSocket server for incoming requests.

getRequester

public RSocketRequester getRequester()

Return the RSocketRequester this connector is built on.

Returns:

the RSocketRequester this connector is built on.

Since:

5.4