org.apache.juneau.httppart

Interface HttpPartSerializer

All Known Subinterfaces:

HttpPartSerializer.Null

All Known Implementing Classes:

BaseHttpPartSerializer, OpenApiSerializer, SimplePartSerializer, SimpleUonPartSerializer, UonPartSerializer, UonSerializer, UonSerializer.Encoding, UonSerializer.Readable, UrlEncodingSerializer, UrlEncodingSerializer.Expanded, UrlEncodingSerializer.PlainText, UrlEncodingSerializer.Readable

public interface HttpPartSerializer

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

The following default implementations are provided:

• OpenApiSerializer - Parts encoded based on OpenAPI schema.
• UonSerializer - Parts encoded in UON notation.
• SimplePartSerializer - Parts encoded in plain text.

This class is used in the following locations:

• FormData.serializer()
• Query.serializer()
• Header.serializer()
• Path.serializer()
• Request.partSerializer()
• Response.partSerializer()
• RestClientBuilder.partSerializer(Class)

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	HttpPartSerializer.Null Represent "no" part part serializer.

Method Summary

Modifier and Type	Method and Description
HttpPartSerializerSession	createPartSession() Creates a new no-argument serializer session.
HttpPartSerializerSession	createPartSession(SerializerSessionArgs args) Creates a new serializer session.
String	serialize(HttpPartSchema schema, Object value) Convenience method for creating a no-arg session and serializing a part with no specified part type.
String	serialize(HttpPartType partType, HttpPartSchema schema, Object value) Convenience method for creating a no-arg session and serializing a part.
String	serialize(HttpPartType type, Object value) Deprecated. Use serialize(HttpPartType, HttpPartSchema, Object)

Method Detail

createPartSession

HttpPartSerializerSession createPartSession(SerializerSessionArgs args)

Creates a new serializer session.

Parameters:

args - The runtime arguments for the session.

Returns:

A new serializer session.

createPartSession

HttpPartSerializerSession createPartSession()

Creates a new no-argument serializer session.

Returns:

A new serializer session.

serialize

String serialize(HttpPartType partType,
                 HttpPartSchema schema,
                 Object value)
          throws SchemaValidationException,
                 SerializeException

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

Parameters:

partType - The category of value being serialized.

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

value - The value being serialized.

Returns:

The serialized value.

Throws:

SerializeException - If a problem occurred while trying to parse the input.

SchemaValidationException - If the output fails schema validation.

serialize

String serialize(HttpPartSchema schema,
                 Object value)
          throws SchemaValidationException,
                 SerializeException

Convenience method for creating a no-arg session and serializing a part with no specified part type.

Parameters:

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

value - The value being serialized.

Returns:

The serialized value.

Throws:

SerializeException - If a problem occurred while trying to parse the input.

SchemaValidationException - If the output fails schema validation.

serialize

@Deprecated
String serialize(HttpPartType type,
                             Object value)

Deprecated. Use serialize(HttpPartType, HttpPartSchema, Object)