org.apache.pekko.http.scaladsl.model

Interface Multipart

All Superinterfaces:

Multipart

All Known Subinterfaces:

Multipart.Strict

public interface Multipart
extends Multipart

The model of multipart content for media-types multipart/\* (general multipart content), multipart/form-data and multipart/byteranges.

The basic modelling classes for these media-types (Multipart.General, Multipart.FormData and Multipart.ByteRanges, respectively) are stream-based but each have a strict counterpart (namely Multipart$General$Strict, Multipart$FormData$Strict and Multipart$ByteRanges$Strict).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Multipart.BodyPart The general model for a single part of a multipart message.
static class	Multipart.BodyPart$
static class	Multipart.ByteRanges Model for multipart/byteranges content as defined by https://tools.ietf.org/html/rfc7233#section-5.4.1 and https://tools.ietf.org/html/rfc7233#appendix-A
static class	Multipart.ByteRanges$
static class	Multipart.FormData Model for multipart/form-data content as defined in http://tools.ietf.org/html/rfc2388.
static class	Multipart.FormData$
static class	Multipart.General Basic model for general multipart content as defined by http://tools.ietf.org/html/rfc2046.
static class	Multipart.General$
static interface	Multipart.Strict A type of multipart content for which all parts have already been loaded into memory and are therefore allow random access.

Method Summary

Modifier and Type	Method and Description
MediaType.Multipart	getMediaType() Java API
org.apache.pekko.stream.javadsl.Source<? extends Multipart.BodyPart,java.lang.Object>	getParts() Java API
MediaType.Multipart	mediaType() The media-type this multipart content carries.
org.apache.pekko.stream.scaladsl.Source<Multipart.BodyPart,java.lang.Object>	parts() The stream of body parts this content consists of.
RequestEntity	toEntity() Creates an entity from this multipart object using a random boundary.
RequestEntity	toEntity(java.lang.String boundary) Creates an entity from this multipart object using the specified boundary.
RequestEntity	toEntity(java.lang.String boundary, org.apache.pekko.event.LoggingAdapter log) Creates an entity from this multipart object using the specified boundary and logger.
scala.concurrent.Future<Multipart.Strict>	toStrict(scala.concurrent.duration.FiniteDuration timeout, org.apache.pekko.stream.Materializer fm) Converts this content into its strict counterpart.
java.util.concurrent.CompletionStage<? extends Multipart.Strict>	toStrict(long timeoutMillis, org.apache.pekko.stream.Materializer materializer) Java API

Method Detail

mediaType

MediaType.Multipart mediaType()

The media-type this multipart content carries.

Returns:

(undocumented)

parts

org.apache.pekko.stream.scaladsl.Source<Multipart.BodyPart,java.lang.Object> parts()

The stream of body parts this content consists of.

Returns:

(undocumented)

toStrict

scala.concurrent.Future<Multipart.Strict> toStrict(scala.concurrent.duration.FiniteDuration timeout,
                                                   org.apache.pekko.stream.Materializer fm)

Converts this content into its strict counterpart. The given timeout denotes the max time that an individual part must be read in. The Future is failed with an TimeoutException if one part isn't read completely after the given timeout.

Parameters:

timeout - (undocumented)

fm - (undocumented)

Returns:

(undocumented)

toEntity

RequestEntity toEntity(java.lang.String boundary,
                       org.apache.pekko.event.LoggingAdapter log)

Creates an entity from this multipart object using the specified boundary and logger.

Parameters:

boundary - (undocumented)

log - (undocumented)

Returns:

(undocumented)

toEntity

RequestEntity toEntity(java.lang.String boundary)

Creates an entity from this multipart object using the specified boundary.

Specified by:

toEntity in interface Multipart

Parameters:

boundary - (undocumented)

Returns:

(undocumented)

toEntity

RequestEntity toEntity()

Creates an entity from this multipart object using a random boundary.

Specified by:

toEntity in interface Multipart

Returns:

(undocumented)

getMediaType

MediaType.Multipart getMediaType()

Java API

Specified by:

getMediaType in interface Multipart

getParts

org.apache.pekko.stream.javadsl.Source<? extends Multipart.BodyPart,java.lang.Object> getParts()

Java API

Specified by:

getParts in interface Multipart

toStrict

java.util.concurrent.CompletionStage<? extends Multipart.Strict> toStrict(long timeoutMillis,
                                                                          org.apache.pekko.stream.Materializer materializer)

Java API

Specified by:

toStrict in interface Multipart