Class DefaultMetadataExtractor

java.lang.Object

org.springframework.messaging.rsocket.DefaultMetadataExtractor

All Implemented Interfaces:

MetadataExtractor, MetadataExtractorRegistry

public class DefaultMetadataExtractor
extends Object
implements MetadataExtractor, MetadataExtractorRegistry

Default MetadataExtractor implementation that relies on Decoders to deserialize the content of metadata entries.

By default only "message/x.rsocket.routing.v0" is extracted and saved under MetadataExtractor.ROUTE_KEY. Use metadataToExtract methods to specify other metadata mime types of interest to extract.

since:

5.2

Author:

Rossen stoyanchev

Field summary

Fields inherited from interface MetadataExtractor

ROUTE_KEY

Constructor summary

Constructors

Constructor	Description
DefaultMetadataExtractor(List<Decoder<?>>&nbsp;decoders)	Constructor with list of decoders for de-serializing metadata entries.
DefaultMetadataExtractor(Decoder<?>...&nbsp;decoders)	Constructor with decoders for de-serializing metadata entries.

Method summary

Modifier and Type	Method	Description
Map<string,Object>	extract(io.rsocket.Payload&nbsp;payload, MimeType&nbsp;metadataMimeType)	Extract a map of values from the given Payload metadata.
List<? extends Decoder<?>>	getDecoders()	Return a read-only list with the configured decoders.
<T>&nbsp;void	metadataToExtract(MimeType&nbsp;mimeType, Class<T>&nbsp;targetType, BiConsumer<T, Map<string,Object>>&nbsp;mapper)	Variant of MetadataExtractorRegistry.metadataToExtract(MimeType, Class, string) that allows custom logic to be used to map the decoded value to any number of values in the output map.
<T>&nbsp;void	metadataToExtract(MimeType&nbsp;mimeType, ParameterizedTypeReference<T>&nbsp;type, BiConsumer<T, Map<string,Object>>&nbsp;mapper)	Variant of MetadataExtractorRegistry.metadataToExtract(MimeType, Class, BiConsumer) that accepts ParameterizedTypeReference instead of Class for specifying a target type with generic parameters.

Methods inherited from class Object

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

Methods inherited from interface MetadataExtractorRegistry

metadataToExtract, metadataToExtract

Constructor Details

DefaultMetadataExtractor

public&nbsp;DefaultMetadataExtractor(Decoder<?>...&nbsp;decoders)

Constructor with decoders for de-serializing metadata entries.

DefaultMetadataExtractor

public&nbsp;DefaultMetadataExtractor(List<Decoder<?>>&nbsp;decoders)

Constructor with list of decoders for de-serializing metadata entries.

Method Details

getDecoders

public&nbsp;List<? extends Decoder<?>>&nbsp;getDecoders()

Return a read-only list with the configured decoders.

metadataToExtract

public&nbsp;<T>&nbsp;void&nbsp;metadataToExtract(MimeType&nbsp;mimeType,
 Class<T>&nbsp;targetType,
 BiConsumer<T, Map<string,Object>>&nbsp;mapper)

Description copied from interface: MetadataExtractorRegistry

Variant of MetadataExtractorRegistry.metadataToExtract(MimeType, Class, string) that allows custom logic to be used to map the decoded value to any number of values in the output map.

specified by:

metadataToExtract in interface MetadataExtractorRegistry

Type Parameters:

T - the target value type

Parameters:

mimeType - the mime type of metadata entries to extract

targetType - the target value type to decode to

mapper - custom logic to add the decoded value to the output map

metadataToExtract

public&nbsp;<T>&nbsp;void&nbsp;metadataToExtract(MimeType&nbsp;mimeType,
 ParameterizedTypeReference<T>&nbsp;type,
 BiConsumer<T, Map<string,Object>>&nbsp;mapper)

Description copied from interface: MetadataExtractorRegistry

Variant of MetadataExtractorRegistry.metadataToExtract(MimeType, Class, BiConsumer) that accepts ParameterizedTypeReference instead of Class for specifying a target type with generic parameters.

specified by:

metadataToExtract in interface MetadataExtractorRegistry

Type Parameters:

T - the target value type

Parameters:

mimeType - the mime type of metadata entries to extract

type - the target value type to decode to

mapper - custom logic to add the decoded value to the output map

extract

public&nbsp;Map<string,Object>&nbsp;extract(io.rsocket.Payload&nbsp;payload,
 MimeType&nbsp;metadataMimeType)

Description copied from interface: MetadataExtractor

Extract a map of values from the given Payload metadata. The Payload "route", if present, should be saved under MetadataExtractor.ROUTE_KEY.

specified by:

extract in interface MetadataExtractor

Parameters:

payload - the payload whose metadata should be read

metadataMimeType - the metadata MimeType for the connection.

Returns:

name values pairs extracted from the metadata