Class FormFields

java.lang.Object

java.util.concurrent.CompletableFuture<Fields>

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

org.eclipse.jetty.server.FormFields

All Implemented Interfaces:

Runnable, CompletionStage<Fields>, Future<Fields>, Invocable, Invocable.Task

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 CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Nested classes/interfaces inherited from interface Future

Future.State

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Nested classes/interfaces inherited from interface Invocable.Task

Invocable.Task.Abstract

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

Fields inherited from interface Invocable

__nonBlocking, NOOP

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<Fields>	from(Request request)	Deprecated, for removal: This API element is subject to removal in a future version. use onFields(Request, Promise.Invocable) instead.
static CompletableFuture<Fields>	from(Request request, int maxFields, int maxLength)	Deprecated, for removal: This API element is subject to removal in a future version. use onFields(Request, Charset, int, int, Promise.Invocable) instead.
static CompletableFuture<Fields>	from(Request request, Charset charset)	Deprecated, for removal: This API element is subject to removal in a future version. use onFields(Request, Charset, Promise.Invocable) instead.
static CompletableFuture<Fields>	from(Request request, Charset charset, int maxFields, int maxLength)	Deprecated, for removal: This API element is subject to removal in a future version. use onFields(Request, Charset, int, int, Promise.Invocable) instead.
static CompletableFuture<Fields>	get(Request request)	Deprecated, for removal: This API element is subject to removal in a future version. use getFields(Request) instead.
static Fields	getFields(Request request)	Get the Fields from a request.
static Fields	getFields(Request request, int maxFields, int maxLength)	Get the Fields from a request.
static Charset	getFormEncodedCharset(Request request)
static void	onFields(Request request, Charset charset, int maxFields, int maxLength, Promise.Invocable<Fields> promise)	Asynchronously reads and parses FormFields from a Request.
static void	onFields(Request request, Charset charset, Promise.Invocable<Fields> promise)	Asynchronously read and parse FormFields from a Request.
static void	onFields(Request request, Promise.Invocable<Fields> promise)	Asynchronously read and parse FormFields from a Request.
protected Fields	parse(Content.Chunk chunk)	Called by ContentSourceCompletableFuture.parse() to parse a Content.Chunk.
static void	set(Request request, CompletableFuture<Fields> fields)	Deprecated, for removal: This API element is subject to removal in a future version. do not use it, no replacement.
static void	setFields(Request request, Fields fields)	Set a Fields or related failure for the request

Methods inherited from class ContentSourceCompletableFuture

acceptEither, applyToEither, get, get, getInvocationType, handle, join, onTransientFailure, parse, run, runAfterBoth, runAfterEither, thenAccept, thenAcceptBoth, thenApply, thenCombine, thenCompose, thenRun, whenComplete

Methods inherited from class CompletableFuture

acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEitherAsync, applyToEitherAsync, cancel, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, exceptionNow, failedFuture, failedStage, getNow, getNumberOfDependents, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, resultNow, runAfterBothAsync, runAfterBothAsync, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, state, supplyAsync, supplyAsync, thenAcceptAsync, thenAcceptAsync, thenAcceptBothAsync, thenAcceptBothAsync, thenApplyAsync, thenApplyAsync, thenCombineAsync, thenCombineAsync, thenComposeAsync, thenComposeAsync, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenCompleteAsync, whenCompleteAsync

Methods inherited from class 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

@Deprecated(forRemoval=true,
            since="12.0.15")
public static void set(Request request,
 CompletableFuture<Fields> fields)

Deprecated, for removal: This API element is subject to removal in a future version.

do not use it, no replacement.

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.

setFields

public static void setFields(Request request,
 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.

getFields

public static Fields getFields(Request request)

Get the Fields from a request. If the Fields have not been set, then attempt to parse them from the Request content, blocking if necessary. If the Fields have previously been read asynchronously by onFields(Request, Promise.Invocable) or similar, then those field will return and this method will not block.

Calls to onFields and getFields methods are idempotent, and can be called multiple times, with subsequent calls returning the results of the first call.

Parameters:

request - The request to get or read the Fields from

Returns:

the Fields

See Also:

• onFields(Request, Promise.Invocable)
• onFields(Request, Charset, Promise.Invocable)
• getFields(Request, int, int)

getFields

public static Fields getFields(Request request,
 int maxFields,
 int maxLength)

Get the Fields from a request. If the Fields have not been set, then attempt to parse them from the Request content, blocking if necessary. If the Fields have previously been read asynchronously by onFields(Request, Promise.Invocable) or similar, then those field will return and this method will not block.

Calls to onFields and getFields methods are idempotent, and can be called multiple times, with subsequent calls returning the results of the first call.

Parameters:

request - The request to get or read the Fields from

maxFields - The maximum number of fields to accept or -1 for unlimited

maxLength - The maximum length of fields or -1 for unlimited.

Returns:

the Fields

See Also:

• onFields(Request, Promise.Invocable)
• onFields(Request, Charset, Promise.Invocable)
• getFields(Request)

onFields

public static void onFields(Request request,
 Promise.Invocable<Fields> promise)

Asynchronously read and parse FormFields from a Request.

Calls to onFields and getFields methods are idempotent, and can be called multiple times, with subsequent calls returning the results of the first call.

Parameters:

request - The request to get or read the Fields from

promise - The action to take when the FormFields are available.

See Also:

• onFields(Request, Charset, Promise.Invocable)
• getFields(Request)
• getFields(Request, int, int)

onFields

public static void onFields(Request request,
 Charset charset,
 Promise.Invocable<Fields> promise)

Asynchronously read and parse FormFields from a Request.

Calls to onFields and getFields methods are idempotent, and can be called multiple times, with subsequent calls returning the results of the first call.

Parameters:

request - The request to get or read the Fields from

charset - The Charset of the request content, if previously extracted.

promise - The action to take when the FormFields are available.

See Also:

• onFields(Request, Charset, Promise.Invocable)
• getFields(Request)
• getFields(Request, int, int)

onFields

public static void onFields(Request request,
 Charset charset,
 int maxFields,
 int maxLength,
 Promise.Invocable<Fields> promise)

Asynchronously reads and parses FormFields from a Request.

Calls to onFields and getFields methods are idempotent, and can be called multiple times, with subsequent calls returning the results of the first call.

Parameters:

request - The request to get or read the Fields from

charset - The Charset of the request content, if previously extracted.

maxFields - The maximum number of fields to accept or -1 for unlimited

maxLength - The maximum length of fields or -1 for unlimited

promise - The action to take when the FormFields are available.

get

@Deprecated(forRemoval=true,
            since="12.0.15")
public static CompletableFuture<Fields> get(Request request)

Deprecated, for removal: This API element is subject to removal in a future version.

use getFields(Request) instead.

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

@Deprecated(forRemoval=true,
            since="12.0.15")
public static CompletableFuture<Fields> from(Request request)

Deprecated, for removal: This API element is subject to removal in a future version.

use onFields(Request, Promise.Invocable) instead.

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.

from

@Deprecated(forRemoval=true,
            since="12.0.15")
public static CompletableFuture<Fields> from(Request request,
 Charset charset)

Deprecated, for removal: This API element is subject to removal in a future version.

use onFields(Request, Charset, Promise.Invocable) instead.

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.

from

@Deprecated(forRemoval=true,
            since="12.0.15")
public static CompletableFuture<Fields> from(Request request,
 int maxFields,
 int maxLength)

Deprecated, for removal: This API element is subject to removal in a future version.

use onFields(Request, Charset, int, int, Promise.Invocable) instead.

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 or -1 for unlimited

maxLength - The maximum total size of the fields or -1 for unlimited

Returns:

A CompletableFuture that will provide the Fields or a failure.

from

@Deprecated(forRemoval=true,
            since="12.0.15")
public static CompletableFuture<Fields> from(Request request,
 Charset charset,
 int maxFields,
 int maxLength)

Deprecated, for removal: This API element is subject to removal in a future version.

use onFields(Request, Charset, int, int, Promise.Invocable) instead.

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 or -1 for unlimited

maxLength - The maximum total size of the fields or -1 for unlimited

Returns:

A CompletableFuture that will provide the Fields or a failure.

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