Module org.eclipse.jetty.http

Package org.eclipse.jetty.http

Class MultiPartByteRanges

java.lang.Object

java.util.concurrent.CompletableFuture<MultiPartByteRanges.Parts>

org.eclipse.jetty.http.MultiPartByteRanges

All Implemented Interfaces:

CompletionStage<MultiPartByteRanges.Parts>, Future<MultiPartByteRanges.Parts>

public class MultiPartByteRanges
extends CompletableFuture<MultiPartByteRanges.Parts>

A CompletableFuture that is completed when a multipart/byteranges content has been parsed asynchronously from a Content.Source via parse(Content.Source).

Once the parsing of the multipart/byteranges content completes successfully, objects of this class are completed with a MultiPartByteRanges.Parts object.

Typical usage:

 // Some headers that include Content-Type.
 HttpFields headers = ...;
 String boundary = MultiPart.extractBoundary(headers.get(HttpHeader.CONTENT_TYPE));

 // Some multipart/byteranges content.
 Content.Source content = ...;

 // Create and configure MultiPartByteRanges.
 MultiPartByteRanges byteRanges = new MultiPartByteRanges(boundary);

 // Parse the content.
 byteRanges.parse(content)
     // When complete, use the parts.
     .thenAccept(parts -> ...);
 

See Also:

• MultiPartByteRanges.Parts

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiPartByteRanges.ContentSource	The multipart/byteranges specific content source.
static class	MultiPartByteRanges.Part	A MultiPart.Part whose content is a byte range of a file.
static class	MultiPartByteRanges.Parts	An ordered list of MultiPart.Parts that can be accessed by index, or iterated over.
static class	MultiPartByteRanges.PathContentSource	A specialized PathContentSource whose content is sliced by a byte range.

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
MultiPartByteRanges(String boundary)

Method Summary

Modifier and Type	Method	Description
boolean	completeExceptionally(Throwable failure)
String	getBoundary()
MultiPartByteRanges	parse(org.eclipse.jetty.io.Content.Source content)	Parses the given multipart/byteranges content.

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Constructor Details

MultiPartByteRanges

public MultiPartByteRanges(String boundary)

Method Details

getBoundary

public String getBoundary()

Returns:

the boundary string

completeExceptionally

public boolean completeExceptionally(Throwable failure)

Overrides:

completeExceptionally in class CompletableFuture<MultiPartByteRanges.Parts>

parse

public MultiPartByteRanges parse(org.eclipse.jetty.io.Content.Source content)

Parses the given multipart/byteranges content.

Returns this MultiPartByteRanges object, so that it can be used in the typical "fluent" style of CompletableFuture.

Parameters:

content - the multipart/byteranges content to parse

Returns:

this MultiPartByteRanges object