Top Description Inners Fields Constructors Methods
io.undertow.server.handlers.form

public Class EagerFormParsingHandler

extends Object
implements HttpHandler
Class Inheritance
All Implemented Interfaces
io.undertow.server.HttpHandler
Imports
java.util.Collections, .Map, .Set, io.undertow.Handlers, io.undertow.server.HandlerWrapper, .HttpHandler, .HttpServerExchange, io.undertow.server.handlers.ResponseCodeHandler, io.undertow.server.handlers.builder.HandlerBuilder
Handler that eagerly parses form data. The request chain will pause while the data is being read, and then continue when the form data is fully passed.

NOTE: This is not strictly compatible with servlet, as it removes the option for the user to parse the request themselves, however in practice this requirement is probably rare, and using this handler gives a significant performance advantage in that a thread is not blocked for the duration of the upload.

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
EagerFormParsingHandler.Builder

Field Summary

Modifier and TypeField and Description
private final FormParserFactory
formParserFactory

private volatile HttpHandler
next

public static final HandlerWrapper
WRAPPER

Constructor Summary

AccessConstructor and Description
public
EagerFormParsingHandler(final FormParserFactory formParserFactory)

public
EagerFormParsingHandler()

public
EagerFormParsingHandler(HttpHandler next)

Method Summary

Modifier and TypeMethod and Description
public HttpHandler
getNext()

public void
handleRequest(final HttpServerExchange
the HTTP request/response exchange
exchange)

Implements io.undertow.server.HttpHandler.handleRequest.

Handle the request.

public EagerFormParsingHandler
setNext(final HttpHandler next)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

formParserFactoryback to summary
private final FormParserFactory formParserFactory
nextback to summary
private volatile HttpHandler next
WRAPPERback to summary
public static final HandlerWrapper WRAPPER

Constructor Detail

EagerFormParsingHandlerback to summary
public EagerFormParsingHandler(final FormParserFactory formParserFactory)
EagerFormParsingHandlerback to summary
public EagerFormParsingHandler()
EagerFormParsingHandlerback to summary
public EagerFormParsingHandler(HttpHandler next)

Method Detail

getNextback to summary
public HttpHandler getNext()
handleRequestback to summary
public void handleRequest(final HttpServerExchange exchange) throws Exception

Implements io.undertow.server.HttpHandler.handleRequest.

Doc from io.undertow.server.HttpHandler.handleRequest.

Handle the request.

Parameters
exchange:HttpServerExchange

the HTTP request/response exchange

Annotations
@Override
setNextback to summary
public EagerFormParsingHandler setNext(final HttpHandler next)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
io.undertow.server.handlers.form back to summary

public Class EagerFormParsingHandler.Builder

extends Object
implements HandlerBuilder
Class Inheritance
  • java.lang.Object
  • io.undertow.server.handlers.form.EagerFormParsingHandler.Builder
All Implemented Interfaces
io.undertow.server.handlers.builder.HandlerBuilder

Constructor Summary

AccessConstructor and Description
public
Builder()

Method Summary

Modifier and TypeMethod and Description
public HandlerWrapper
build(Map<String, Object>
The handler config
config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

public String
defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

public String
name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

public Map<String, Class<?>>
parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

public Set<String>
requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Builderback to summary
public Builder()

Method Detail

buildback to summary
public HandlerWrapper build(Map<String, Object> config)

Implements io.undertow.server.handlers.builder.HandlerBuilder.build.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.build.

Creates the handler

Parameters
config:Map<String, Object>

The handler config

Returns:HandlerWrapper

The new predicate

Annotations
@Override
defaultParameterback to summary
public String defaultParameter()

Implements io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

Returns:String

Doc from io.undertow.server.handlers.builder.HandlerBuilder.defaultParameter.

The default parameter name, or null if it does not have a default parameter

Annotations
@Override
nameback to summary
public String name()

Implements io.undertow.server.handlers.builder.HandlerBuilder.name.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.name.

The string representation of the handler name.

Returns:String

The handler name

Annotations
@Override
parametersback to summary
public Map<String, Class<?>> parameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Doc from io.undertow.server.handlers.builder.HandlerBuilder.parameters.

Returns a map of parameters and their types.

Annotations
@Override
requiredParametersback to summary
public Set<String> requiredParameters()

Implements io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

Returns:Set<String>

Doc from io.undertow.server.handlers.builder.HandlerBuilder.requiredParameters.

The required parameters

Annotations
@Override