org.apache.pekko.http.scaladsl.common

Class JsonEntityStreamingSupport

java.lang.Object

org.apache.pekko.http.javadsl.common.EntityStreamingSupport

org.apache.pekko.http.scaladsl.common.EntityStreamingSupport

org.apache.pekko.http.javadsl.common.JsonEntityStreamingSupport

org.apache.pekko.http.scaladsl.common.JsonEntityStreamingSupport

public final class JsonEntityStreamingSupport
extends JsonEntityStreamingSupport

Constructor Summary

Constructors

Constructor and Description
JsonEntityStreamingSupport(int maxObjectSize)
JsonEntityStreamingSupport(int maxObjectSize, ContentTypeRange supported, ContentType contentType, org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRenderer, int parallelism, boolean unordered)

Method Summary

Modifier and Type	Method and Description
ContentType	contentType() Write-side, defines what Content-Type the Marshaller should offer and the final Content-Type of the response.
org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed>	framingDecoder() Read-side, decode incoming framed entity.
org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed>	framingRenderer() Write-side, apply framing to outgoing entity stream.
int	parallelism() Write-side / read-side, defines if (un)marshalling should be done in parallel.
ContentTypeRange	supported() Read-side, what content types it is able to frame and unmarshall.
java.lang.String	toString()
boolean	unordered() Write-side / read-side, defines if (un)marshalling should preserve ordering of incoming stream elements.
JsonEntityStreamingSupport	withContentType(ContentType ct) Write-side, defines what Content-Type the Marshaller should offer and the final Content-Type of the response.
JsonEntityStreamingSupport	withFramingRenderer(org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRendererFlow)
JsonEntityStreamingSupport	withFramingRendererFlow(org.apache.pekko.stream.javadsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRendererFlow) Java API: Write-side, apply framing to outgoing entity stream.
JsonEntityStreamingSupport	withParallelMarshalling(int parallelism, boolean unordered) Write-side / read-side, defines parallelism and if ordering should be preserved or not of Source element marshalling.
JsonEntityStreamingSupport	withSupported(ContentTypeRange range) Read-side, allows changing what content types are accepted by this framing.

Methods inherited from class org.apache.pekko.http.scaladsl.common.EntityStreamingSupport

csv, csv, getFramingDecoder, getFramingRenderer, json, json

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonEntityStreamingSupport

public JsonEntityStreamingSupport(int maxObjectSize,
                                  ContentTypeRange supported,
                                  ContentType contentType,
                                  org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRenderer,
                                  int parallelism,
                                  boolean unordered)

JsonEntityStreamingSupport

public JsonEntityStreamingSupport(int maxObjectSize)

Method Detail

contentType

public ContentType contentType()

Description copied from class: EntityStreamingSupport

Write-side, defines what Content-Type the Marshaller should offer and the final Content-Type of the response.

Specified by:

contentType in class EntityStreamingSupport

framingDecoder

public org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingDecoder()

Description copied from class: EntityStreamingSupport

Read-side, decode incoming framed entity. For example with an incoming JSON array, chunk it up into JSON objects contained within that array.

Specified by:

framingDecoder in class EntityStreamingSupport

Returns:

(undocumented)

framingRenderer

public org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRenderer()

Description copied from class: EntityStreamingSupport

Write-side, apply framing to outgoing entity stream.

Most typical usage will be a variant of Flow[ByteString].intersperse.

For example for rendering a JSON array one would return Flow[ByteString].intersperse(ByteString("["), ByteString(","), ByteString("]")) and for rendering a new-line separated CSV simply Flow[ByteString].intersperse(ByteString("\n")).

Specified by:

framingRenderer in class EntityStreamingSupport

Returns:

(undocumented)

parallelism

public int parallelism()

Description copied from class: EntityStreamingSupport

Write-side / read-side, defines if (un)marshalling should be done in parallel.

This may be beneficial marshalling the bottleneck in the pipeline.

See also parallelism and withParallelMarshalling.

Specified by:

parallelism in class EntityStreamingSupport

Returns:

(undocumented)

supported

public ContentTypeRange supported()

Description copied from class: EntityStreamingSupport

Read-side, what content types it is able to frame and unmarshall.

Specified by:

supported in class EntityStreamingSupport

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

unordered

public boolean unordered()

Description copied from class: EntityStreamingSupport

Write-side / read-side, defines if (un)marshalling should preserve ordering of incoming stream elements.

Allowing for parallel and unordered (un)marshalling often yields higher throughput and also allows avoiding head-of-line blocking if some elements are much larger than others.

See also parallelism and withParallelMarshalling.

Specified by:

unordered in class EntityStreamingSupport

Returns:

(undocumented)

withContentType

public JsonEntityStreamingSupport withContentType(ContentType ct)

Description copied from class: EntityStreamingSupport

Write-side, defines what Content-Type the Marshaller should offer and the final Content-Type of the response.

EntityStreamingSupport traits MUST support re-configuring the offered ContentType. This is due to the need integrating with existing systems which sometimes expect custom Content-Types, however really are just plain JSON or something else internally (perhaps with slight extensions).

NOTE: Implementations should specialize the return type to their own Type!

Specified by:

withContentType in class EntityStreamingSupport

Parameters:

ct - (undocumented)

Returns:

(undocumented)

withFramingRenderer

public JsonEntityStreamingSupport withFramingRenderer(org.apache.pekko.stream.scaladsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRendererFlow)

withFramingRendererFlow

public JsonEntityStreamingSupport withFramingRendererFlow(org.apache.pekko.stream.javadsl.Flow<org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed> framingRendererFlow)

Description copied from class: JsonEntityStreamingSupport

Java API: Write-side, apply framing to outgoing entity stream.

Most typical usage will be a variant of Flow[ByteString].intersperse.

For example for rendering a JSON array one would return Flow[ByteString].intersperse(ByteString("["), ByteString(","), ByteString("]")) and for rendering a new-line separated CSV simply Flow[ByteString].intersperse(ByteString("\n")).

Specified by:

withFramingRendererFlow in class JsonEntityStreamingSupport

Parameters:

framingRendererFlow - (undocumented)

Returns:

(undocumented)

withParallelMarshalling

public JsonEntityStreamingSupport withParallelMarshalling(int parallelism,
                                                          boolean unordered)

Description copied from class: EntityStreamingSupport

Write-side / read-side, defines parallelism and if ordering should be preserved or not of Source element marshalling.

Sometimes marshalling multiple elements at once (esp. when elements are not evenly sized, and ordering is not enforced) may yield in higher throughput.

NOTE: Implementations should specialize the return type to their own Type!

Specified by:

withParallelMarshalling in class EntityStreamingSupport

Parameters:

parallelism - (undocumented)

unordered - (undocumented)

Returns:

(undocumented)

withSupported

public JsonEntityStreamingSupport withSupported(ContentTypeRange range)

Description copied from class: EntityStreamingSupport

Read-side, allows changing what content types are accepted by this framing.

EntityStreamingSupport traits MUST support re-configuring the accepted ContentTypeRange.

This is in order to support a-typical APIs which users still want to communicate with using the provided support trait. Typical examples include APIs which return valid application/json however advertise the content type as being application/javascript or vendor specific content types, which still parse correctly as JSON, CSV or something else that a provided support trait is built for.

NOTE: Implementations should specialize the return type to their own Type!

Specified by:

withSupported in class EntityStreamingSupport

Parameters:

range - (undocumented)

Returns:

(undocumented)