Modifier and Type	Class and Description
private class	DefaultRSocketRequester.DefaultRequestSpec

Modifier and Type	Field and Description
private final MimeType	dataMimeType
private static final Map<String, Object>	EMPTY_HINTS
private final Mono<DataBuffer>	emptyBufferMono
private final MimeType	metadataMimeType
private final RSocket	rsocket
private final RSocketClient	rsocketClient
private final RSocketStrategies	strategies

Access	Constructor and Description
pack-priv	DefaultRSocketRequester(RSocketClient rsocketClient, RSocket rsocket, MimeType dataMimeType, MimeType metadataMimeType, RSocketStrategies strategies)

Modifier and Type	Method and Description
private DataBufferFactory	bufferFactory()
public MimeType	dataMimeType() Implements org.springframework.messaging.rsocket.RSocketRequester.dataMimeType. Return the data `MimeType` selected for the underlying RSocket at connection time.
private static boolean	isVoid(ResolvableType elementType)
public RSocketRequester.RequestSpec	metadata(Object the metadata value to encode metadata, MimeType the mime type that describes the metadata; This is required for connection using composite metadata. Otherwise, the value is encoded according to the mime type for the connection and this argument may be left as `null`. mimeType) Implements org.springframework.messaging.rsocket.RSocketRequester.metadata. 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` via `ReactiveAdapterRegistry`.
public MimeType	metadataMimeType() Implements org.springframework.messaging.rsocket.RSocketRequester.metadataMimeType. Return the metadata `MimeType` selected for the underlying RSocket at connection time.
public RSocketRequester.RequestSpec	route(String the route expressing a remote handler mapping route, Object... variables to be expanded into the route template vars) Implements org.springframework.messaging.rsocket.RSocketRequester.route. Begin to specify a new request with the given route to a remote handler.
public RSocket	rsocket() Implements org.springframework.messaging.rsocket.RSocketRequester.rsocket. Return the underlying `RSocket` if the requester was created with a "live" RSocket via `wrap(RSocket, MimeType, MimeType, RSocketStrategies)` or via one of the (deprecated) connect methods on the `RSocketRequester` builder, or otherwise return `null`.
public RSocketClient	rsocketClient() Implements org.springframework.messaging.rsocket.RSocketRequester.rsocketClient. Return the underlying `RSocketClient` used to make requests with.
public RSocketStrategies	strategies() Implements org.springframework.messaging.rsocket.RSocketRequester.strategies. Return the configured `RSocketStrategies`.

dataMimeType	back to summary
private final MimeType dataMimeType

EMPTY_HINTS	back to summary
private static final Map<String, Object> EMPTY_HINTS

emptyBufferMono	back to summary
private final Mono<DataBuffer> emptyBufferMono

rsocket	back to summary
private final RSocket rsocket Annotations @Nullable

rsocketClient	back to summary
private final RSocketClient rsocketClient

strategies	back to summary
private final RSocketStrategies strategies

DefaultRSocketRequester	back to summary
pack-priv DefaultRSocketRequester(RSocketClient rsocketClient, RSocket rsocket, MimeType dataMimeType, MimeType metadataMimeType, RSocketStrategies strategies)

Method Detail

bufferFactory	back to summary
private DataBufferFactory bufferFactory()

dataMimeType back to summary

dataMimeType	back to summary
public MimeType dataMimeType() Implements org.springframework.messaging.rsocket.RSocketRequester.dataMimeType. Doc from org.springframework.messaging.rsocket.RSocketRequester.dataMimeType. Return the data `MimeType` selected for the underlying RSocket at connection time. On the client side this is configured via `RSocketRequester.Builder#dataMimeType(MimeType)` while on the server side it's obtained from the `ConnectionSetupPayload`. Annotations @Override

public MimeType dataMimeType()

Implements org.springframework.messaging.rsocket.RSocketRequester.dataMimeType.

Doc from org.springframework.messaging.rsocket.RSocketRequester.dataMimeType.

Return the data MimeType selected for the underlying RSocket at connection time. On the client side this is configured via RSocketRequester.Builder#dataMimeType(MimeType) while on the server side it's obtained from the ConnectionSetupPayload.

Annotations

@Override

isVoid	back to summary
private static boolean isVoid(ResolvableType elementType)

metadata back to summary

public RSocketRequester.RequestSpec metadata(Object metadata, MimeType mimeType)

Implements org.springframework.messaging.rsocket.RSocketRequester.metadata.

Doc from org.springframework.messaging.rsocket.RSocketRequester.metadata.

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 via ReactiveAdapterRegistry.

Parameters

metadata:Object: the metadata value to encode
mimeType:MimeType: the mime type that describes the metadata; This is required for connection using composite metadata. Otherwise, the value is encoded according to the mime type for the connection and this argument may be left as null.

Annotations

@Override

metadataMimeType back to summary

public MimeType metadataMimeType()

Implements org.springframework.messaging.rsocket.RSocketRequester.metadataMimeType.

Doc from org.springframework.messaging.rsocket.RSocketRequester.metadataMimeType.

Return the metadata MimeType selected for the underlying RSocket at connection time. On the client side this is configured via RSocketRequester.Builder#metadataMimeType(MimeType) while on the server side it's obtained from the ConnectionSetupPayload.

Annotations

@Override

route back to summary

route	back to summary
public RSocketRequester.RequestSpec route(String route, Object... vars) Implements org.springframework.messaging.rsocket.RSocketRequester.route. Doc from org.springframework.messaging.rsocket.RSocketRequester.route. Begin to specify a new request with the given route to a remote handler. The route can be a template with placeholders, e.g. `"flight.{code}"` in which case the supplied route variables are formatted via `toString()` and expanded into the template. If a formatted variable contains a "." it is replaced with the escape sequence "%2E" to avoid treating it as separator by the responder. If the connection is set to use composite metadata, the route is encoded as `"message/x.rsocket.routing.v0"`. Otherwise, the route is encoded according to the mime type for the connection. Parameters route:String the route expressing a remote handler mapping vars:Object[] variables to be expanded into the route template Returns:RSocketRequester.RequestSpec a spec for further defining and executing the request Annotations @Override

public RSocketRequester.RequestSpec route(String route, Object... vars)

Implements org.springframework.messaging.rsocket.RSocketRequester.route.

Doc from org.springframework.messaging.rsocket.RSocketRequester.route.

Begin to specify a new request with the given route to a remote handler.

The route can be a template with placeholders, e.g. "flight.{code}" in which case the supplied route variables are formatted via toString() and expanded into the template. If a formatted variable contains a "." it is replaced with the escape sequence "%2E" to avoid treating it as separator by the responder.

If the connection is set to use composite metadata, the route is encoded as "message/x.rsocket.routing.v0". Otherwise, the route is encoded according to the mime type for the connection.

Parameters

route:String: the route expressing a remote handler mapping
vars:Object[]: variables to be expanded into the route template

Returns:RSocketRequester.RequestSpec

a spec for further defining and executing the request

Annotations

@Override

rsocket back to summary

rsocket	back to summary
public RSocket rsocket() Implements org.springframework.messaging.rsocket.RSocketRequester.rsocket. Doc from org.springframework.messaging.rsocket.RSocketRequester.rsocket. Return the underlying `RSocket` if the requester was created with a "live" RSocket via `wrap(RSocket, MimeType, MimeType, RSocketStrategies)` or via one of the (deprecated) connect methods on the `RSocketRequester` builder, or otherwise return `null`. Annotations @Nullable @Override

public RSocket rsocket()

Implements org.springframework.messaging.rsocket.RSocketRequester.rsocket.

Doc from org.springframework.messaging.rsocket.RSocketRequester.rsocket.

Return the underlying RSocket if the requester was created with a "live" RSocket via wrap(RSocket, MimeType, MimeType, RSocketStrategies) or via one of the (deprecated) connect methods on the RSocketRequester builder, or otherwise return null.

Annotations

@Nullable
@Override

rsocketClient back to summary

rsocketClient	back to summary
public RSocketClient rsocketClient() Implements org.springframework.messaging.rsocket.RSocketRequester.rsocketClient. Doc from org.springframework.messaging.rsocket.RSocketRequester.rsocketClient. Return the underlying `RSocketClient` used to make requests with. Annotations @Override

public RSocketClient rsocketClient()

Implements org.springframework.messaging.rsocket.RSocketRequester.rsocketClient.

Doc from org.springframework.messaging.rsocket.RSocketRequester.rsocketClient.

Return the underlying RSocketClient used to make requests with.

Annotations

@Override

strategies back to summary

strategies	back to summary
public RSocketStrategies strategies() Implements org.springframework.messaging.rsocket.RSocketRequester.strategies. Doc from org.springframework.messaging.rsocket.RSocketRequester.strategies. Return the configured `RSocketStrategies`. Annotations @Override

public RSocketStrategies strategies()

Implements org.springframework.messaging.rsocket.RSocketRequester.strategies.

Doc from org.springframework.messaging.rsocket.RSocketRequester.strategies.

Return the configured RSocketStrategies.

Annotations

@Override

org.springframework.messaging.rsocket back to summary

private Class DefaultRSocketRequester.DefaultRequestSpec

Class Inheritance

extends Object
implements RequestSpec

java.lang.Object
org.springframework.messaging.rsocket.DefaultRSocketRequester.DefaultRequestSpec

All Implemented Interfaces

org.springframework.messaging.rsocket.RSocketRequester.RequestSpec, org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec, org.springframework.messaging.rsocket.RSocketRequester.MetadataSpec

Field Summary

Modifier and Type	Field and Description
private final MetadataEncoder	metadataEncoder
private Flux<Payload>	payloadFlux
private Mono<Payload>	payloadMono

Constructor Summary

Access	Constructor and Description
public	DefaultRequestSpec(String route, Object... vars)
public	DefaultRequestSpec(Object metadata, MimeType mimeType)

Method Summary

Modifier and Type	Method and Description
private void	createPayload(Object input, ResolvableType elementType)
public RSocketRequester.RequestSpec	data(Object the Object value for the payload data data) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Provide payload data for the request.
public RSocketRequester.RequestSpec	data(Object the source of payload data value(s). This must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry` producer, Class<?> the type of values to be produced elementClass) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Variant of `data(Object)` that also accepts a hint for the types of values that will be produced.
public RSocketRequester.RequestSpec	data(Object the source of payload data value(s). This must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry` producer, ParameterizedTypeReference<?> the type of values to be produced elementTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Variant of `data(Object, Class)` for when the type hint has to have a generic type.
private <T> DataBuffer	encodeData(T value, ResolvableType elementType, Encoder<?> encoder)
private Mono<Payload>	firstPayload(Mono<DataBuffer> the encoded payload data; expected to not be empty! encodedData) Create the 1st request payload with encoded data and metadata.
private ReactiveAdapter	getAdapter(Class<?> aClass)
private Mono<Payload>	getPayloadMono()
public RSocketRequester.RequestSpec	metadata(Object an Object to be encoded with a suitable `Encoder`, or a `DataBuffer` metadata, MimeType the mime type that describes the metadata mimeType) Implements org.springframework.messaging.rsocket.RSocketRequester.MetadataSpec.metadata. Use this to append additional metadata entries when using composite metadata.
public RSocketRequester.RequestSpec	metadata(Consumer<RSocketRequester.MetadataSpec<?>> the configurer to apply configurer) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.metadata. Append additional metadata entries through a `Consumer`.
private DataBuffer	retainDataAndReleasePayload(Payload payload)
public <T> Flux<T>	retrieveFlux(Class<T> the expected type for values in the response dataType) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Perform an `requestStream` or a `requestChannel` exchange depending on whether the request input is single or multi-payload.
public <T> Flux<T>	retrieveFlux(ParameterizedTypeReference<T> dataTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Variant of `retrieveFlux(Class)` for when the dataType has to have a generic type.
private <T> Flux<T>	retrieveFlux(ResolvableType elementType)
public <T> Mono<T>	retrieveMono(Class<T> the expected data type for the response dataType) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Perform a `requestResponse` exchange.
public <T> Mono<T>	retrieveMono(ParameterizedTypeReference<T> dataTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Variant of `retrieveMono(Class)` for when the dataType has to have a generic type.
private <T> Mono<T>	retrieveMono(ResolvableType elementType)
public Mono<Void>	send() Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.send. Perform a `fireAndForget` sending the provided data and metadata.
public Mono<Void>	sendMetadata() Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.sendMetadata. Perform a `metadataPush`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

metadataEncoder	back to summary
private final MetadataEncoder metadataEncoder

payloadFlux	back to summary
private Flux<Payload> payloadFlux Annotations @Nullable

payloadMono	back to summary
private Mono<Payload> payloadMono Annotations @Nullable

Constructor Detail

DefaultRequestSpec	back to summary
public DefaultRequestSpec(String route, Object... vars)

DefaultRequestSpec	back to summary
public DefaultRequestSpec(Object metadata, MimeType mimeType)

Method Detail

createPayload	back to summary
private void createPayload(Object input, ResolvableType elementType)

data	back to summary
public RSocketRequester.RequestSpec data(Object data) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Doc from org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Provide payload data for the request. This can be one of: Concrete value `Publisher` of value(s) Any other producer of value(s) that can be adapted to a `Publisher` via `ReactiveAdapterRegistry` Parameters data:Object the Object value for the payload data Returns:RSocketRequester.RequestSpec spec to declare the expected response Annotations @Override

data	back to summary
public RSocketRequester.RequestSpec data(Object producer, Class<?> elementClass) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Doc from org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Variant of `data(Object)` that also accepts a hint for the types of values that will be produced. The class hint is used to find a compatible `Encoder` once, up front vs per value. Parameters producer:Object the source of payload data value(s). This must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry` elementClass:Class<?> the type of values to be produced Returns:RSocketRequester.RequestSpec spec to declare the expected response Annotations @Override

data	back to summary
public RSocketRequester.RequestSpec data(Object producer, ParameterizedTypeReference<?> elementTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Doc from org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.data. Variant of `data(Object, Class)` for when the type hint has to have a generic type. See `ParameterizedTypeReference`. Parameters producer:Object the source of payload data value(s). This must be a `Publisher` or another producer adaptable to a `Publisher` via `ReactiveAdapterRegistry` elementTypeRef:ParameterizedTypeReference<?> the type of values to be produced Returns:RSocketRequester.RequestSpec spec to declare the expected response Annotations @Override

encodeData	back to summary
private <T> DataBuffer encodeData(T value, ResolvableType elementType, Encoder<?> encoder) Annotations @SuppressWarnings:unchecked

firstPayload	back to summary
private Mono<Payload> firstPayload(Mono<DataBuffer> encodedData) Create the 1st request payload with encoded data and metadata. Parameters encodedData:Mono<DataBuffer> the encoded payload data; expected to not be empty!

firstPayload

back to summary

private Mono<Payload> firstPayload(Mono<DataBuffer> encodedData)

Create the 1st request payload with encoded data and metadata.

Parameters

encodedData:Mono<DataBuffer>: the encoded payload data; expected to not be empty!

getAdapter	back to summary
private ReactiveAdapter getAdapter(Class<?> aClass) Annotations @Nullable

getPayloadMono	back to summary
private Mono<Payload> getPayloadMono()

metadata back to summary

public RSocketRequester.RequestSpec metadata(Object metadata, MimeType mimeType)

Implements org.springframework.messaging.rsocket.RSocketRequester.MetadataSpec.metadata.

Doc from org.springframework.messaging.rsocket.RSocketRequester.MetadataSpec.metadata.

Use this to append additional metadata entries when using composite metadata. An IllegalArgumentException is raised if this method is used when not using composite metadata. The metadata value be a concrete value or any producer of a single value that can be adapted to a Publisher via ReactiveAdapterRegistry.

Parameters

metadata:Object: an Object to be encoded with a suitable Encoder, or a DataBuffer
mimeType:MimeType: the mime type that describes the metadata

Annotations

@Override

metadata back to summary

public RSocketRequester.RequestSpec metadata(Consumer<RSocketRequester.MetadataSpec<?>> configurer)

Implements org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.metadata.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RequestSpec.metadata.

Append additional metadata entries through a Consumer. This enables libraries such as Spring Security to provide shortcuts for applying a set of customizations.

Parameters

configurer:Consumer<RSocketRequester.MetadataSpec<?>>: the configurer to apply

Annotations

@Override

retainDataAndReleasePayload	back to summary
private DataBuffer retainDataAndReleasePayload(Payload payload)

retrieveFlux back to summary

retrieveFlux	back to summary
public <T> Flux<T> retrieveFlux(Class<T> dataType) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Perform an `requestStream` or a `requestChannel` exchange depending on whether the request input is single or multi-payload. If the return type is `Flux<Void>`, the `Flux` will complete after all data is consumed. Parameters <T> parameterize the expected type of values dataType:Class<T> the expected type for values in the response Returns:Flux<T> the decoded response Annotations @Override

public <T> Flux<T> retrieveFlux(Class<T> dataType)

Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux.

Perform an requestStream or a requestChannel exchange depending on whether the request input is single or multi-payload.

If the return type is Flux<Void>, the Flux will complete after all data is consumed.

Parameters

<T>: parameterize the expected type of values
dataType:Class<T>: the expected type for values in the response

Returns:Flux<T>

the decoded response

Annotations

@Override

retrieveFlux back to summary

retrieveFlux	back to summary
public <T> Flux<T> retrieveFlux(ParameterizedTypeReference<T> dataTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux. Variant of `retrieveFlux(Class)` for when the dataType has to have a generic type. See `ParameterizedTypeReference`. Annotations @Override

public <T> Flux<T> retrieveFlux(ParameterizedTypeReference<T> dataTypeRef)

Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveFlux.

Variant of retrieveFlux(Class) for when the dataType has to have a generic type. See ParameterizedTypeReference.

Annotations

@Override

retrieveFlux	back to summary
private <T> Flux<T> retrieveFlux(ResolvableType elementType) Annotations @SuppressWarnings:unchecked

retrieveMono back to summary

retrieveMono	back to summary
public <T> Mono<T> retrieveMono(Class<T> dataType) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Perform a `requestResponse` exchange. If the return type is `Mono<Void>`, the `Mono` will complete after all data is consumed. Note This method will raise an error if the request payload is a multivalued `Publisher` as there is no many-to-one RSocket interaction. Parameters <T> parameter for the expected data type dataType:Class<T> the expected data type for the response Returns:Mono<T> the decoded response Annotations @Override

public <T> Mono<T> retrieveMono(Class<T> dataType)

Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono.

Perform a requestResponse exchange.

If the return type is Mono<Void>, the Mono will complete after all data is consumed.

Note

This method will raise an error if the request payload is a multivalued Publisher as there is no many-to-one RSocket interaction.

Parameters

<T>: parameter for the expected data type
dataType:Class<T>: the expected data type for the response

Returns:Mono<T>

the decoded response

Annotations

@Override

retrieveMono back to summary

retrieveMono	back to summary
public <T> Mono<T> retrieveMono(ParameterizedTypeReference<T> dataTypeRef) Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono. Variant of `retrieveMono(Class)` for when the dataType has to have a generic type. See `ParameterizedTypeReference`. Annotations @Override

public <T> Mono<T> retrieveMono(ParameterizedTypeReference<T> dataTypeRef)

Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.retrieveMono.

Variant of retrieveMono(Class) for when the dataType has to have a generic type. See ParameterizedTypeReference.

Annotations

@Override

retrieveMono	back to summary
private <T> Mono<T> retrieveMono(ResolvableType elementType) Annotations @SuppressWarnings:unchecked

send back to summary

send	back to summary
public Mono<Void> send() Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.send. Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.send. Perform a `fireAndForget` sending the provided data and metadata. Returns:Mono<Void> a completion that indicates if the payload was sent successfully or not. Note, however that is a one-way send and there is no indication of whether or how the even was handled on the remote end. Annotations @Override

public Mono<Void> send()

Implements org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.send.

Doc from org.springframework.messaging.rsocket.RSocketRequester.RetrieveSpec.send.

Perform a fireAndForget sending the provided data and metadata.

Returns:Mono<Void>

a completion that indicates if the payload was sent successfully or not. Note, however that is a one-way send and there is no indication of whether or how the even was handled on the remote end.

Annotations