org.apache.juneau.urlencoding

Class UrlEncodingParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContext

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.uon.UonParser

org.apache.juneau.urlencoding.UrlEncodingParser

All Implemented Interfaces:

HttpPartParser

@ConfigurableContext
public class UrlEncodingParser
extends UonParser

Parses URL-encoded text into POJO models.

Media types

Handles Content-Type types: application/x-www-form-urlencoded

Description

Parses URL-Encoded text (e.g. "foo=bar&baz=bing") into POJOs.

Expects parameter values to be in UON notation.

This parser uses a state machine, which makes it very fast and efficient.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.juneau.uon.UonParser

UonParser.Decoding

Nested classes/interfaces inherited from interface org.apache.juneau.httppart.HttpPartParser

HttpPartParser.Null

Field Summary

Fields

Modifier and Type	Field and Description
static UrlEncodingParser	DEFAULT Reusable instance of UrlEncodingParser.
static String	URLENC_expandedParams Configuration property: Parser bean property collections/arrays as separate key/value pairs.

Fields inherited from class org.apache.juneau.uon.UonParser

DEFAULT_DECODING, UON_decoding, UON_validateEnd

Fields inherited from class org.apache.juneau.parser.ReaderParser

RPARSER_fileCharset, RPARSER_streamCharset

Fields inherited from class org.apache.juneau.parser.Parser

PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered

Fields inherited from class org.apache.juneau.BeanContext

BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_beanTypePropertyName, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_debug, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_locale, BEAN_mediaType, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_timeZone, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED

Constructor Summary

Constructors

Constructor and Description
UrlEncodingParser(PropertyStore ps) Constructor.

Method Summary

Modifier and Type	Method and Description
UrlEncodingParserBuilder	builder() Creates a builder from this context object.
static UrlEncodingParserBuilder	create() Instantiates a new clean-slate UrlEncodingParserBuilder object.
UrlEncodingParserSession	createSession() Create a new bean session based on the properties defined on this context.
UrlEncodingParserSession	createSession(ParserSessionArgs args) Create the session object that will be passed in to the parse method.
protected boolean	isExpandedParams() Configuration property: Parser bean property collections/arrays as separate key/value pairs.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.uon.UonParser

createParameterSession, createPartSession, createPartSession, isDecoding, isValidateEnd, parse, parse, parse, parse

Methods inherited from class org.apache.juneau.parser.ReaderParser

getFileCharset, getStreamCharset, isReaderParser

Methods inherited from class org.apache.juneau.parser.Parser

canHandle, createDefaultSessionArgs, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

Methods inherited from class org.apache.juneau.BeanContext

_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getExamples, getImplClassConstructor, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getTimeZone, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string

Methods inherited from class org.apache.juneau.Context

equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

URLENC_expandedParams

public static final String URLENC_expandedParams

Configuration property: Parser bean property collections/arrays as separate key/value pairs.

Property:

• Name: "UrlEncodingParser.expandedParams.b"
• Data type: Boolean
• Default: false
• Session property: false
• Methods:
  • UrlEncodingParserBuilder.expandedParams(boolean)
  • UrlEncodingParserBuilder.expandedParams()
  • UrlEncoding.expandedParams()

Description:

This is the parser-side equivalent of the URLENC_expandedParams setting.

If false, serializing the array [1,2,3] results in ?key=$a(1,2,3).
If true, serializing the same array results in ?key=1&key=2&key=3.

Example:

public class A { public String[] f1; public List<String> f2; } UrlEncodingParser p1 = UrlEncodingParser.DEFAULT; UrlEncodingParser p2 = UrlEncodingParser.create().expandedParams().build(); A a1 = p1.parse("f1=@(a,b)&f2=@(c,d)", A.class); A a2 = p2.parse("f1=a&f1=b&f2=c&f2=d", A.class);

This option only applies to beans.

• If parsing multi-part parameters, it's highly recommended to use Collections or Lists as bean property types instead of arrays since arrays have to be recreated from scratch every time a value is added to it.

See Also:

Constant Field Values

DEFAULT

public static final UrlEncodingParser DEFAULT

Reusable instance of UrlEncodingParser.

Constructor Detail

UrlEncodingParser

public UrlEncodingParser(PropertyStore ps)

Constructor.

Parameters:

ps - The property store containing all the settings for this object.

Method Detail

builder

public UrlEncodingParserBuilder builder()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

builder in class UonParser

Returns:

A new ContextBuilder object.

create

public static UrlEncodingParserBuilder create()

Instantiates a new clean-slate UrlEncodingParserBuilder object.

This is equivalent to simply calling new UrlEncodingParserBuilder().

Note that this method creates a builder initialized to all default settings, whereas builder() copies the settings of the object called on.

Returns:

A new UrlEncodingParserBuilder object.

createSession

public UrlEncodingParserSession createSession()

Description copied from class: BeanContext

Create a new bean session based on the properties defined on this context.

Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.

Overrides:

createSession in class UonParser

Returns:

A new session object.

createSession

public UrlEncodingParserSession createSession(ParserSessionArgs args)

Description copied from class: Parser

Create the session object that will be passed in to the parse method.

It's up to implementers to decide what the session object looks like, although typically it's going to be a subclass of ParserSession.

Overrides:

createSession in class UonParser

Parameters:

args - Runtime arguments.

Returns:

The new session.

isExpandedParams

protected final boolean isExpandedParams()

Configuration property: Parser bean property collections/arrays as separate key/value pairs.

Returns:

false if serializing the array [1,2,3] results in ?key=$a(1,2,3).
true if serializing the same array results in ?key=1&key=2&key=3.

See Also:

URLENC_expandedParams

toMap

public ObjectMap toMap()

Description copied from class: Context

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class UonParser

Returns:

A new map containing the properties defined on this context.