Package org.eclipse.jetty.server

Class FormFields

java.lang.Object

java.util.concurrent.CompletableFuture<X>

org.eclipse.jetty.io.content.ContentSourceCompletableFuture<Fields>

org.eclipse.jetty.server.FormFields

All Implemented Interfaces:

CompletionStage<Fields>, Future<Fields>

public class FormFields
extends ContentSourceCompletableFuture<Fields>

A CompletableFuture that is completed once a application/x-www-form-urlencoded content has been parsed asynchronously from the Content.Source.

Specification.

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MAX_FIELDS_ATTRIBUTE
static final int	MAX_FIELDS_DEFAULT
static final String	MAX_LENGTH_ATTRIBUTE
static final int	MAX_LENGTH_DEFAULT

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<Fields>	from(Request request)	Find or create a FormFields from a Content.Source.
static CompletableFuture<Fields>	from(Request request, int maxFields, int maxLength)	Find or create a FormFields from a Content.Source.
static CompletableFuture<Fields>	from(Request request, Charset charset)	Find or create a FormFields from a Content.Source.
static CompletableFuture<Fields>	from(Request request, Charset charset, int maxFields, int maxLength)	Find or create a FormFields from a Content.Source.
static CompletableFuture<Fields>	get(Request request)
static Charset	getFormEncodedCharset(Request request)
protected Fields	parse(Content.Chunk chunk)	Called by ContentSourceCompletableFuture.parse() to parse a Content.Chunk.
static void	set(Request request, CompletableFuture<Fields> fields)	Set a Fields or related failure for the request

Methods inherited from class org.eclipse.jetty.io.content.ContentSourceCompletableFuture

onTransientFailure, parse

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, 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

Field Details

MAX_FIELDS_ATTRIBUTE

public static final String MAX_FIELDS_ATTRIBUTE

See Also:

• Constant Field Values

MAX_LENGTH_ATTRIBUTE

public static final String MAX_LENGTH_ATTRIBUTE

See Also:

• Constant Field Values

MAX_FIELDS_DEFAULT

public static final int MAX_FIELDS_DEFAULT

See Also:

• Constant Field Values

MAX_LENGTH_DEFAULT

public static final int MAX_LENGTH_DEFAULT

See Also:

• Constant Field Values

Method Details

getFormEncodedCharset

public static Charset getFormEncodedCharset(Request request)

set

public static void set(Request request,
 CompletableFuture<Fields> fields)

Set a Fields or related failure for the request

Parameters:

request - The request to which to associate the fields with

fields - A CompletableFuture that will provide either the fields or a failure.

get

public static CompletableFuture<Fields> get(Request request)

Parameters:

request - The request to enquire from

Returns:

A CompletableFuture that will provide either the fields or a failure, or null if none set.

See Also:

• from(Request)

from

public static CompletableFuture<Fields> from(Request request)

Find or create a FormFields from a Content.Source.

Parameters:

request - The Request in which to look for an existing FormFields attribute, using the classname as the attribute name, else the request is used as a Content.Source from which to read the fields and set the attribute.

Returns:

A CompletableFuture that will provide the Fields or a failure.

See Also:

• from(Content.Source, Attributes, Charset, int, int)

from

public static CompletableFuture<Fields> from(Request request,
 Charset charset)

Find or create a FormFields from a Content.Source.

Parameters:

request - The Request in which to look for an existing FormFields attribute, using the classname as the attribute name, else the request is used as a Content.Source from which to read the fields and set the attribute.

charset - the Charset to use for byte to string conversion.

Returns:

A CompletableFuture that will provide the Fields or a failure.

See Also:

• from(Content.Source, Attributes, Charset, int, int)

from

public static CompletableFuture<Fields> from(Request request,
 int maxFields,
 int maxLength)

Find or create a FormFields from a Content.Source.

Parameters:

request - The Request in which to look for an existing FormFields attribute, using the classname as the attribute name, else the request is used as a Content.Source from which to read the fields and set the attribute.

maxFields - The maximum number of fields to be parsed

maxLength - The maximum total size of the fields

Returns:

A CompletableFuture that will provide the Fields or a failure.

See Also:

• from(Content.Source, Attributes, Charset, int, int)

from

public static CompletableFuture<Fields> from(Request request,
 Charset charset,
 int maxFields,
 int maxLength)

Find or create a FormFields from a Content.Source.

Parameters:

request - The Request in which to look for an existing FormFields attribute, using the classname as the attribute name, else the request is used as a Content.Source from which to read the fields and set the attribute.

charset - the Charset to use for byte to string conversion.

maxFields - The maximum number of fields to be parsed

maxLength - The maximum total size of the fields

Returns:

A CompletableFuture that will provide the Fields or a failure.

See Also:

• from(Content.Source, Attributes, Charset, int, int)

parse

protected Fields parse(Content.Chunk chunk)
                throws CharacterCodingException

Description copied from class: ContentSourceCompletableFuture

Called by ContentSourceCompletableFuture.parse() to parse a Content.Chunk.

Specified by:

parse in class ContentSourceCompletableFuture<Fields>

Parameters:

chunk - The chunk containing content to parse. The chunk will never be null nor a failure chunk. If the chunk is stored away to be used later beyond the scope of this call, then implementations must call Retainable.retain() and Retainable.release() as appropriate.

Returns:

The parsed X result instance or null if parsing is not yet complete

Throws:

CharacterCodingException