org.apache.juneau.httppart

Interface HttpPartParser

All Known Subinterfaces:

HttpPartParser.Null

All Known Implementing Classes:

BaseHttpPartParser, OpenApiParser, SimplePartParser, UonParser, UonParser.Decoding, UrlEncodingParser

public interface HttpPartParser

Interface used to convert HTTP headers, query parameters, form-data parameters, and URI path variables to POJOs

The following default implementations are provided:

• OpenApiParser - Parts encoded in based on OpenAPI schema.
• UonParser - Parts encoded in UON notation.
• SimplePartParser - Parts encoded in plain text.

Implementations must include either a public no-args constructor or a public constructor that takes in a single PropertyStore object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HttpPartParser.Null Represent "no" part parser.

Method Summary

Modifier and Type	Method and Description
HttpPartParserSession	createPartSession() Creates a new no-argument parser session.
HttpPartParserSession	createPartSession(ParserSessionArgs args) Creates a new parser session.
<T> T	parse(HttpPartSchema schema, String in, Class<T> toType) Convenience method for creating a no-arg session and parsing a part of an unspecified part type.
<T> T	parse(HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Convenience method for creating a no-arg session and parsing a part of an unspecified part type.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Class<T> toType) Convenience method for creating a no-arg session and parsing a part.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, Type toType, Type... toTypeArgs) Convenience method for creating a no-arg session and parsing a part.

Method Detail

createPartSession

HttpPartParserSession createPartSession(ParserSessionArgs args)

Creates a new parser session.

Parameters:

args - The runtime arguments for the session.

Returns:

A new parser session.

createPartSession

HttpPartParserSession createPartSession()

Creates a new no-argument parser session.

Returns:

A new parser session.

parse

<T> T parse(HttpPartType partType,
            HttpPartSchema schema,
            String in,
            Class<T> toType)
     throws ParseException,
            SchemaValidationException

Convenience method for creating a no-arg session and parsing a part.

Parameters:

partType - The category of value being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The value being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

<T> T parse(HttpPartType partType,
            HttpPartSchema schema,
            String in,
            Type toType,
            Type... toTypeArgs)
     throws ParseException,
            SchemaValidationException

Convenience method for creating a no-arg session and parsing a part.

Parameters:

partType - The category of value being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The value being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collections and Maps.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

<T> T parse(HttpPartSchema schema,
            String in,
            Class<T> toType)
     throws ParseException,
            SchemaValidationException

Convenience method for creating a no-arg session and parsing a part of an unspecified part type.

Parameters:

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The value being parsed.

toType - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.

parse

<T> T parse(HttpPartSchema schema,
            String in,
            Type toType,
            Type... toTypeArgs)
     throws ParseException,
            SchemaValidationException

Convenience method for creating a no-arg session and parsing a part of an unspecified part type.

Parameters:

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The value being parsed.

toType - The POJO type to transform the input into.

toTypeArgs - The POJO type arguments for Collections and Maps.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input fails schema validation.