Package com.linecorp.armeria.common.multipart

Interface BodyPart

public interface BodyPart

A body part entity.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AggregatedBodyPart>	aggregate()	Aggregates this BodyPart.
CompletableFuture<AggregatedBodyPart>	aggregate(EventExecutor executor)	Aggregates this BodyPart.
CompletableFuture<AggregatedBodyPart>	aggregateWithPooledObjects(ByteBufAllocator alloc)	(Advanced users only) Aggregates this BodyPart.
CompletableFuture<AggregatedBodyPart>	aggregateWithPooledObjects(EventExecutor executor, ByteBufAllocator alloc)	(Advanced users only) Aggregates this BodyPart.
static BodyPartBuilder	builder()	Returns a new BodyPartBuilder.
ByteStreamMessage	content()	Returns the reactive representation of the part content.
default @Nullable String	filename()	Returns the file name.
HttpHeaders	headers()	Returns HTTP part headers.
default @Nullable String	name()	Returns the control name.
static BodyPart	of(ContentDisposition contentDisposition, HttpData content)	Returns a new BodyPart using the specified ContentDisposition and HttpData.
static BodyPart	of(ContentDisposition contentDisposition, MediaType contentType, HttpData content)	Returns a new BodyPart using the specified ContentDisposition, MediaType and HttpData.
static BodyPart	of(ContentDisposition contentDisposition, MediaType contentType, CharSequence content)	Returns a new UTF-8-encoded BodyPart using the specified ContentDisposition, MediaType and CharSequence.
static BodyPart	of(ContentDisposition contentDisposition, MediaType contentType, org.reactivestreams.Publisher<? extends HttpData> publisher)	Returns a new BodyPart using the specified ContentDisposition, MediaType and Publisher of HttpData.
static BodyPart	of(ContentDisposition contentDisposition, CharSequence content)	Returns a new UTF-8-encoded BodyPart using the specified ContentDisposition and CharSequence.
static BodyPart	of(ContentDisposition contentDisposition, org.reactivestreams.Publisher<? extends HttpData> publisher)	Returns a new BodyPart using the specified ContentDisposition and Publisher of HttpData.
static BodyPart	of(HttpHeaders headers, HttpData content)	Returns a new BodyPart using the specified HttpHeaders and bytes.
static BodyPart	of(HttpHeaders headers, CharSequence content)	Returns a new UTF-8-encoded BodyPart using the specified HttpHeaders and CharSequence.
static BodyPart	of(HttpHeaders headers, org.reactivestreams.Publisher<? extends HttpData> publisher)	Returns a new BodyPart using the specified HttpHeaders and Publisher of HttpData.
CompletableFuture<Void>	writeTo(Path path, EventExecutor eventExecutor, ExecutorService blockingTaskExecutor, OpenOption... options)	Writes this BodyPart to the given Path with OpenOptions.
CompletableFuture<Void>	writeTo(Path path, OpenOption... options)	Writes this BodyPart to the given Path with OpenOptions.

Method Details

of

static BodyPart of(ContentDisposition contentDisposition,
 CharSequence content)

Returns a new UTF-8-encoded BodyPart using the specified ContentDisposition and CharSequence.

of

static BodyPart of(ContentDisposition contentDisposition,
 MediaType contentType,
 CharSequence content)

Returns a new UTF-8-encoded BodyPart using the specified ContentDisposition, MediaType and CharSequence.

of

static BodyPart of(HttpHeaders headers,
 CharSequence content)

Returns a new UTF-8-encoded BodyPart using the specified HttpHeaders and CharSequence.

of

static BodyPart of(ContentDisposition contentDisposition,
 HttpData content)

Returns a new BodyPart using the specified ContentDisposition and HttpData.

of

static BodyPart of(ContentDisposition contentDisposition,
 MediaType contentType,
 HttpData content)

Returns a new BodyPart using the specified ContentDisposition, MediaType and HttpData.

of

static BodyPart of(HttpHeaders headers,
 HttpData content)

Returns a new BodyPart using the specified HttpHeaders and bytes.

of

static BodyPart of(ContentDisposition contentDisposition,
 org.reactivestreams.Publisher<? extends HttpData> publisher)

Returns a new BodyPart using the specified ContentDisposition and Publisher of HttpData.

of

static BodyPart of(ContentDisposition contentDisposition,
 MediaType contentType,
 org.reactivestreams.Publisher<? extends HttpData> publisher)

Returns a new BodyPart using the specified ContentDisposition, MediaType and Publisher of HttpData.

of

static BodyPart of(HttpHeaders headers,
 org.reactivestreams.Publisher<? extends HttpData> publisher)

Returns a new BodyPart using the specified HttpHeaders and Publisher of HttpData.

builder

static BodyPartBuilder builder()

Returns a new BodyPartBuilder.

headers

HttpHeaders headers()

Returns HTTP part headers.

content

@CheckReturnValue
ByteStreamMessage content()

Returns the reactive representation of the part content.

writeTo

CompletableFuture<Void> writeTo(Path path,
 EventExecutor eventExecutor,
 ExecutorService blockingTaskExecutor,
 OpenOption... options)

Writes this BodyPart to the given Path with OpenOptions. If the OpenOptions are not specified, they default to StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING and StandardOpenOption.WRITE.

Parameters:

path - the Path to write to

eventExecutor - the EventExecutor to subscribe to this given publisher

blockingTaskExecutor - the ExecutorService to which blocking tasks are submitted to handle file I/O events and write operations

options - the OpenOptions specifying how the file is opened

Returns:

a CompletableFuture to handle asynchronous result

writeTo

CompletableFuture<Void> writeTo(Path path,
 OpenOption... options)

Writes this BodyPart to the given Path with OpenOptions. If the OpenOptions are not specified, they default to StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING and StandardOpenOption.WRITE.

Parameters:

path - the Path to write to

options - the OpenOptions specifying how the file is opened

Returns:

a CompletableFuture to handle asynchronous result

aggregate

CompletableFuture<AggregatedBodyPart> aggregate()

Aggregates this BodyPart. The returned CompletableFuture will be notified when the BodyPart is received fully.

aggregate

CompletableFuture<AggregatedBodyPart> aggregate(EventExecutor executor)

Aggregates this BodyPart. The returned CompletableFuture will be notified when the BodyPart is received fully.

aggregateWithPooledObjects

CompletableFuture<AggregatedBodyPart> aggregateWithPooledObjects(ByteBufAllocator alloc)

(Advanced users only) Aggregates this BodyPart. The returned CompletableFuture will be notified when the BodyPart is received fully. AggregatedHttpObject.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().

aggregateWithPooledObjects

CompletableFuture<AggregatedBodyPart> aggregateWithPooledObjects(EventExecutor executor,
 ByteBufAllocator alloc)

(Advanced users only) Aggregates this BodyPart. The returned CompletableFuture will be notified when the BodyPart is received fully. AggregatedHttpObject.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().

name

@Nullable
default @Nullable String name()

Returns the control name.

Returns:

the name parameter of the "content-disposition" header, or null if not present.

filename

@Nullable
default @Nullable String filename()

Returns the file name.

Returns:

the filename parameter of the "content-disposition" header, or null if not present.