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

public Class FormParserFactory

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Arrays, .List, io.undertow.server.HttpServerExchange, io.undertow.util.AttachmentKey

Factory class that can create a form data parser for a given request.

It does this by iterating the available parser definitions, and returning the first parser that is created.

Author
Stuart Douglas

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
public static interface

Field Summary

Modifier and TypeField and Description
private static final AttachmentKey<FormDataParser>
private final FormParserFactory.ParserDefinition<T>[]

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public static FormParserFactory.Builder
public static FormParserFactory.Builder
builder(boolean includeDefault)

public FormDataParser

Returns:

A form data parser, or null if there is no parser registered for the request content type
createParser
(final HttpServerExchange
The exchange
exchange
)

Creates a form data parser for this request.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ATTACHMENT_KEYback to summary
private static final AttachmentKey<FormDataParser> ATTACHMENT_KEY
parserDefinitionsback to summary
private final FormParserFactory.ParserDefinition<T>[] parserDefinitions

Constructor Detail

FormParserFactoryback to summary
pack-priv FormParserFactory(final List<FormParserFactory.ParserDefinition<T>> parserDefinitions)

Method Detail

builderback to summary
public static FormParserFactory.Builder builder()
builderback to summary
public static FormParserFactory.Builder builder(boolean includeDefault)
createParserback to summary
public FormDataParser createParser(final HttpServerExchange exchange)

Creates a form data parser for this request. If a parser has already been created for the request the existing parser will be returned rather than creating a new one.

Parameters
exchange:HttpServerExchange

The exchange

Returns:FormDataParser

A form data parser, or null if there is no parser registered for the request content type

io.undertow.server.handlers.form back to summary

public Class FormParserFactory.Builder

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
private String
private List<FormParserFactory.ParserDefinition<T>>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public FormParserFactory.Builder
public FormParserFactory.Builder
public FormParserFactory.Builder
public FormParserFactory
public String
public List<FormParserFactory.ParserDefinition<T>>
public void
setDefaultCharset(String defaultCharset)

public void
public FormParserFactory.Builder
withDefaultCharset(String defaultCharset)

A chainable version of setDefaultCharset.

public FormParserFactory.Builder
withParsers(List<FormParserFactory.ParserDefinition<T>> parsers)

A chainable version of setParsers.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

defaultCharsetback to summary
private String defaultCharset
parsersback to summary
private List<FormParserFactory.ParserDefinition<T>> parsers

Constructor Detail

Builderback to summary
public Builder()

Method Detail

addParserback to summary
public FormParserFactory.Builder addParser(final FormParserFactory.ParserDefinition<T> definition)
addParsersback to summary
public FormParserFactory.Builder addParsers(final FormParserFactory.ParserDefinition<T>... definition)
addParsersback to summary
public FormParserFactory.Builder addParsers(final List<FormParserFactory.ParserDefinition<T>> definition)
buildback to summary
public FormParserFactory build()
getDefaultCharsetback to summary
public String getDefaultCharset()
getParsersback to summary
public List<FormParserFactory.ParserDefinition<T>> getParsers()
setDefaultCharsetback to summary
public void setDefaultCharset(String defaultCharset)
setParsersback to summary
public void setParsers(List<FormParserFactory.ParserDefinition<T>> parsers)
withDefaultCharsetback to summary
public FormParserFactory.Builder withDefaultCharset(String defaultCharset)

A chainable version of setDefaultCharset.

withParsersback to summary
public FormParserFactory.Builder withParsers(List<FormParserFactory.ParserDefinition<T>> parsers)

A chainable version of setParsers.

io.undertow.server.handlers.form back to summary

public Interface FormParserFactory.ParserDefinition<T>

Known Direct Implementers
io.undertow.server.handlers.form.MultiPartParserDefinition, io.undertow.server.handlers.form.FormEncodedDataDefinition

Method Summary

Modifier and TypeMethod and Description
public FormDataParser
create(final HttpServerExchange exchange)

public T

Method Detail

createback to summary
public FormDataParser create(final HttpServerExchange exchange)
setDefaultEncodingback to summary
public T setDefaultEncoding(String charset)