Top Description Inners Fields Constructors Methods

org.springframework.messaging.rsocket

pack-priv final Class MetadataEncoder

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.rsocket.MetadataEncoder

Imports

java.util.ArrayList, .Collections, .List, .Map, java.util.regex.Matcher, .Pattern, io.netty.buffer.ByteBuf, .ByteBufAllocator, .CompositeByteBuf, io.rsocket.metadata.WellKnownMimeType, reactor.core.publisher.Mono, org.springframework.core.ReactiveAdapter, .ResolvableType, org.springframework.core.codec.Encoder, org.springframework.core.io.buffer.DataBuffer, .DataBufferFactory, .NettyDataBufferFactory, org.springframework.lang.Nullable, org.springframework.util.Assert, .CollectionUtils, .MimeType, .ObjectUtils

Helps to collect metadata values and mime types, and encode them.

Author: Rossen Stoyanchev
Since: 5.2

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	MetadataEncoder.MetadataEntry Holder for the metadata value and mime type.

Field Summary

Modifier and Type	Field and Description
private final ByteBufAllocator	allocator
private boolean	hasAsyncValues
private final boolean	isComposite
private final List<MetadataEncoder.MetadataEntry>	metadataEntries
private final MimeType	metadataMimeType
private static final Object	NO_VALUE
private String	route
private final RSocketStrategies	strategies
private static final Pattern	VARS_PATTERN For route variable replacement.

Constructor Summary

Access	Constructor and Description
pack-priv	MetadataEncoder(MimeType metadataMimeType, RSocketStrategies strategies)

Method Summary

Modifier and Type	Method and Description
private DataBuffer	asDataBuffer(ByteBuf byteBuf)
private void	assertMetadataEntryCount()
private DataBufferFactory	bufferFactory()
public Mono<DataBuffer>	encode() Encode the collected metadata entries to a `DataBuffer`.
private DataBuffer	encodeEntries(List<MetadataEncoder.MetadataEntry> entries)
private <T> DataBuffer	encodeEntry(MetadataEncoder.MetadataEntry entry)
private <T> DataBuffer	encodeEntry(Object value, MimeType mimeType)
private ByteBuf	encodeRoute()
private static String	expand(String route, Object... routeVars)
public MetadataEncoder	metadata(Object metadata, MimeType mimeType) Add a metadata entry.
public MetadataEncoder	metadataAndOrRoute(Map<Object, MimeType> metadata, String route, Object[] vars) Add route and/or metadata, both optional.
private Mono<List<MetadataEncoder.MetadataEntry>>	resolveAsyncMetadata()
public MetadataEncoder	route(String route, Object... routeVars) Set the route to a remote handler as described in `RSocketRequester#route(String, Object...)`.

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

Field Detail

allocator	back to summary
private final ByteBufAllocator allocator

hasAsyncValues	back to summary
private boolean hasAsyncValues

isComposite	back to summary
private final boolean isComposite

metadataEntries	back to summary
private final List<MetadataEncoder.MetadataEntry> metadataEntries

metadataMimeType	back to summary
private final MimeType metadataMimeType

NO_VALUE	back to summary
private static final Object NO_VALUE

route	back to summary
private String route Annotations @Nullable

strategies	back to summary
private final RSocketStrategies strategies

VARS_PATTERN	back to summary
private static final Pattern VARS_PATTERN For route variable replacement.

Constructor Detail

MetadataEncoder	back to summary
pack-priv MetadataEncoder(MimeType metadataMimeType, RSocketStrategies strategies)

Method Detail

asDataBuffer	back to summary
private DataBuffer asDataBuffer(ByteBuf byteBuf)

assertMetadataEntryCount	back to summary
private void assertMetadataEntryCount()

bufferFactory	back to summary
private DataBufferFactory bufferFactory()

encode back to summary

public Mono<DataBuffer> encode()

Encode the collected metadata entries to a DataBuffer.

See Also: PayloadUtils#createPayload(DataBuffer, DataBuffer)

encodeEntries	back to summary
private DataBuffer encodeEntries(List<MetadataEncoder.MetadataEntry> entries) Annotations @SuppressWarnings:deprecation

encodeEntry	back to summary
private <T> DataBuffer encodeEntry(MetadataEncoder.MetadataEntry entry)

encodeEntry	back to summary
private <T> DataBuffer encodeEntry(Object value, MimeType mimeType) Annotations @SuppressWarnings:unchecked

encodeRoute	back to summary
private ByteBuf encodeRoute()

expand	back to summary
private static String expand(String route, Object... routeVars)

metadata	back to summary
public MetadataEncoder metadata(Object metadata, MimeType mimeType) Add a metadata entry. If called more than once or in addition to route, composite metadata must be in use.

metadataAndOrRoute	back to summary
public MetadataEncoder metadataAndOrRoute(Map<Object, MimeType> metadata, String route, Object[] vars) Add route and/or metadata, both optional.

resolveAsyncMetadata	back to summary
private Mono<List<MetadataEncoder.MetadataEntry>> resolveAsyncMetadata()

route	back to summary
public MetadataEncoder route(String route, Object... routeVars) Set the route to a remote handler as described in `RSocketRequester#route(String, Object...)`.

org.springframework.messaging.rsocket back to summary

private Class MetadataEncoder.MetadataEntry

Class Inheritance

extends Object

java.lang.Object
org.springframework.messaging.rsocket.MetadataEncoder.MetadataEntry

Holder for the metadata value and mime type.

Since: 5.2.2

Field Summary

Modifier and Type	Field and Description
private final MimeType	mimeType
private final Object	value

Constructor Summary

Access	Constructor and Description
pack-priv	MetadataEntry(Object value, MimeType mimeType)

Method Summary

Modifier and Type	Method and Description
public MimeType	mimeType()
public Object	value()

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

Field Detail

mimeType	back to summary
private final MimeType mimeType

value	back to summary
private final Object value

Constructor Detail

MetadataEntry	back to summary
pack-priv MetadataEntry(Object value, MimeType mimeType)

Method Detail

mimeType	back to summary
public MimeType mimeType()

value	back to summary
public Object value()