An Iterable wrapper around a ByteBuf that exposes metadata entry information at each decoding step. This is only possible on frame types used to initiate interactions, if the SETUP metadata mime type was WellKnownMimeType#MESSAGE_RSOCKET_COMPOSITE_METADATA.

This allows efficient incremental decoding of the entries (without moving the source's io.netty.buffer.ByteBuf#readerIndex()). The buffer is assumed to contain just enough bytes to represent one or more entries (mime type compressed or not). The decoding stops when the buffer reaches 0 readable bytes, and fails if it contains bytes but not enough to correctly decode an entry.

A note on future-proofness: it is possible to come across a compressed mime type that this implementation doesn't recognize. This is likely to be due to the use of a byte id that is merely reserved in this implementation, but maps to a WellKnownMimeType in the implementation that encoded the metadata. This can be detected by detecting that an entry is a ReservedMimeTypeEntry. In this case Entry#getMimeType() will return null. The encoded id can be retrieved using ReservedMimeTypeEntry#getType(). The byte and content buffer should be kept around and re-encoded using CompositeMetadataCodec#encodeAndAddMetadata(CompositeByteBuf, ByteBufAllocator, byte, ByteBuf) in case passing that entry through is required.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	CompositeMetadata.Entry An entry in the `CompositeMetadata`.
public static class	CompositeMetadata.ExplicitMimeTimeEntry An `Entry` backed by an explicitly declared MIME type.
public static class	CompositeMetadata.ReservedMimeTypeEntry An `Entry` backed by a `WellKnownMimeType` entry, but one that is not understood by this implementation.
public static class	CompositeMetadata.WellKnownMimeTypeEntry An `Entry` backed by a `WellKnownMimeType`.

Modifier and Type	Field and Description
private final boolean	retainSlices
private final ByteBuf	source

Constructor Summary

Access	Constructor and Description
public	CompositeMetadata(ByteBuf source, boolean retainSlices)

Method Summary

Modifier and Type	Method and Description
public Iterator<CompositeMetadata.Entry>	Returns: the composite metadata `Iterator` iterator() Implements java.lang.Iterable.iterator. An `Iterator` that lazily decodes `Entry` in this composite metadata.
public Stream<CompositeMetadata.Entry>	Returns: the composite metadata sequential `Stream` stream() Turn this `CompositeMetadata` into a sequential `Stream`.

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

retainSlices	back to summary
private final boolean retainSlices

source	back to summary
private final ByteBuf source

Constructor Detail

CompositeMetadata	back to summary
public CompositeMetadata(ByteBuf source, boolean retainSlices)

Method Detail

iterator back to summary

iterator	back to summary
public Iterator<CompositeMetadata.Entry> iterator() Implements java.lang.Iterable.iterator. An `Iterator` that lazily decodes `Entry` in this composite metadata. Returns:Iterator<CompositeMetadata.Entry> the composite metadata `Iterator` Annotations @Override

public Iterator<CompositeMetadata.Entry> iterator()

Implements java.lang.Iterable.iterator.

An Iterator that lazily decodes Entry in this composite metadata.

Returns:Iterator<CompositeMetadata.Entry>

the composite metadata Iterator

Annotations

@Override

stream back to summary

stream	back to summary
public Stream<CompositeMetadata.Entry> stream() Turn this `CompositeMetadata` into a sequential `Stream`. Returns:Stream<CompositeMetadata.Entry> the composite metadata sequential `Stream`

public Stream<CompositeMetadata.Entry> stream()

Turn this CompositeMetadata into a sequential Stream.

Returns:Stream<CompositeMetadata.Entry>: the composite metadata sequential Stream

io.rsocket.metadata back to summary

public Interface CompositeMetadata.Entry

Known Direct Implementers: io.rsocket.metadata.CompositeMetadata.ExplicitMimeTimeEntry, io.rsocket.metadata.CompositeMetadata.ReservedMimeTypeEntry, io.rsocket.metadata.CompositeMetadata.WellKnownMimeTypeEntry, io.rsocket.metadata.TaggingMetadata

An entry in the CompositeMetadata.

Method Summary

Modifier and Type	Method and Description
public ByteBuf	Returns: the un-decoded content of the `Entry` getContent() Returns the un-decoded content of the `Entry`.
public String	Returns: the MIME type of the entry, if it can be decoded, otherwise `null`. getMimeType() Returns the MIME type of the entry, if it can be decoded.

Method Detail

getContent back to summary

getContent	back to summary
public ByteBuf getContent() Returns the un-decoded content of the `Entry`. Returns:ByteBuf the un-decoded content of the `Entry`

public ByteBuf getContent()

Returns the un-decoded content of the Entry.

Returns:ByteBuf: the un-decoded content of the Entry

getMimeType back to summary

getMimeType	back to summary
public String getMimeType() Returns the MIME type of the entry, if it can be decoded. Returns:String the MIME type of the entry, if it can be decoded, otherwise `null`. Annotations @Nullable

public String getMimeType()

Returns the MIME type of the entry, if it can be decoded.

Returns:String

the MIME type of the entry, if it can be decoded, otherwise null.

Annotations

@Nullable

io.rsocket.metadata back to summary

public final Class CompositeMetadata.ExplicitMimeTimeEntry

Class Inheritance

extends Object
implements Entry

java.lang.Object
io.rsocket.metadata.CompositeMetadata.ExplicitMimeTimeEntry

All Implemented Interfaces

io.rsocket.metadata.CompositeMetadata.Entry

An Entry backed by an explicitly declared MIME type.

Field Summary

Modifier and Type	Field and Description
private final ByteBuf	content
private final String	type

Constructor Summary

Access	Constructor and Description
public	ExplicitMimeTimeEntry(ByteBuf content, String type)

Method Summary

Modifier and Type	Method and Description
public ByteBuf	getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`.
public String	getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded.

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

Field Detail

content	back to summary
private final ByteBuf content

type	back to summary
private final String type

Constructor Detail

ExplicitMimeTimeEntry	back to summary
public ExplicitMimeTimeEntry(ByteBuf content, String type)

Method Detail

getContent back to summary

getContent	back to summary
public ByteBuf getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`. Returns:ByteBuf the un-decoded content of the `Entry` Annotations @Override

public ByteBuf getContent()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Returns the un-decoded content of the Entry.

Returns:ByteBuf

the un-decoded content of the Entry

Annotations

@Override

getMimeType back to summary

getMimeType	back to summary
public String getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded. Returns:String the MIME type of the entry, if it can be decoded, otherwise `null`. Annotations @Override

public String getMimeType()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Returns the MIME type of the entry, if it can be decoded.

Returns:String

the MIME type of the entry, if it can be decoded, otherwise null.

Annotations

@Override

io.rsocket.metadata back to summary

public final Class CompositeMetadata.ReservedMimeTypeEntry

Class Inheritance

extends Object
implements Entry

java.lang.Object
io.rsocket.metadata.CompositeMetadata.ReservedMimeTypeEntry

All Implemented Interfaces

io.rsocket.metadata.CompositeMetadata.Entry

An Entry backed by a WellKnownMimeType entry, but one that is not understood by this implementation.

Field Summary

Modifier and Type	Field and Description
private final ByteBuf	content
private final int	type

Constructor Summary

Access	Constructor and Description
public	ReservedMimeTypeEntry(ByteBuf content, int type)

Method Summary

Modifier and Type	Method and Description
public ByteBuf	getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`.
public String	getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded.
public int	Returns: the reserved, but unknown `WellKnownMimeType` for this entry getType() Returns the reserved, but unknown `WellKnownMimeType` for this entry.

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

Field Detail

content	back to summary
private final ByteBuf content

type	back to summary
private final int type

Constructor Detail

ReservedMimeTypeEntry	back to summary
public ReservedMimeTypeEntry(ByteBuf content, int type)

Method Detail

getContent back to summary

getContent	back to summary
public ByteBuf getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`. Returns:ByteBuf the un-decoded content of the `Entry` Annotations @Override

public ByteBuf getContent()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Returns the un-decoded content of the Entry.

Returns:ByteBuf

the un-decoded content of the Entry

Annotations

@Override

getMimeType back to summary

getMimeType	back to summary
public String getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded. Since this entry represents a compressed id that couldn't be decoded, this is always `null`. Returns:String the MIME type of the entry, if it can be decoded, otherwise `null`. Annotations @Override

public String getMimeType()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Returns the MIME type of the entry, if it can be decoded. Since this entry represents a compressed id that couldn't be decoded, this is always null.

Returns:String

the MIME type of the entry, if it can be decoded, otherwise null.

Annotations

@Override

getType back to summary

getType	back to summary
public int getType() Returns the reserved, but unknown `WellKnownMimeType` for this entry. Range is 0-127 (inclusive). Returns:int the reserved, but unknown `WellKnownMimeType` for this entry

public int getType()

Returns the reserved, but unknown WellKnownMimeType for this entry. Range is 0-127 (inclusive).

Returns:int: the reserved, but unknown WellKnownMimeType for this entry

io.rsocket.metadata back to summary

public final Class CompositeMetadata.WellKnownMimeTypeEntry

Class Inheritance

extends Object
implements Entry

java.lang.Object
io.rsocket.metadata.CompositeMetadata.WellKnownMimeTypeEntry

All Implemented Interfaces

io.rsocket.metadata.CompositeMetadata.Entry

An Entry backed by a WellKnownMimeType.

Field Summary

Modifier and Type	Field and Description
private final ByteBuf	content
private final WellKnownMimeType	type

Constructor Summary

Access	Constructor and Description
public	WellKnownMimeTypeEntry(ByteBuf content, WellKnownMimeType type)

Method Summary

Modifier and Type	Method and Description
public ByteBuf	getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`.
public String	getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded.
public WellKnownMimeType	Returns: the `WellKnownMimeType` for this entry getType() Returns the `WellKnownMimeType` for this entry.

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

Field Detail

content	back to summary
private final ByteBuf content

type	back to summary
private final WellKnownMimeType type

Constructor Detail

WellKnownMimeTypeEntry	back to summary
public WellKnownMimeTypeEntry(ByteBuf content, WellKnownMimeType type)

Method Detail

getContent back to summary

getContent	back to summary
public ByteBuf getContent() Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent. Returns the un-decoded content of the `Entry`. Returns:ByteBuf the un-decoded content of the `Entry` Annotations @Override

public ByteBuf getContent()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getContent.

Returns the un-decoded content of the Entry.

Returns:ByteBuf

the un-decoded content of the Entry

Annotations

@Override

getMimeType back to summary

getMimeType	back to summary
public String getMimeType() Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType. Returns the MIME type of the entry, if it can be decoded. Returns:String the MIME type of the entry, if it can be decoded, otherwise `null`. Annotations @Override

public String getMimeType()

Implements io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Doc from io.rsocket.metadata.CompositeMetadata.Entry.getMimeType.

Returns the MIME type of the entry, if it can be decoded.

Returns:String

the MIME type of the entry, if it can be decoded, otherwise null.

Annotations

@Override

getType back to summary

getType	back to summary
public WellKnownMimeType getType() Returns the `WellKnownMimeType` for this entry. Returns:WellKnownMimeType the `WellKnownMimeType` for this entry

public WellKnownMimeType getType()

Returns the WellKnownMimeType for this entry.

Returns:WellKnownMimeType: the WellKnownMimeType for this entry