Package com.linecorp.armeria.server.protobuf

Class ProtobufRequestConverterFunction

java.lang.Object

com.linecorp.armeria.server.protobuf.ProtobufRequestConverterFunction

All Implemented Interfaces:

RequestConverterFunction

@UnstableApi
public final class ProtobufRequestConverterFunction
extends Object
implements RequestConverterFunction

A RequestConverterFunction which converts a Protocol Buffers or JSON body of the AggregatedHttpRequest to an object. The built-in parser of Message for Protocol Buffers is applied only when the content-type of RequestHeaders is either one of MediaType.PROTOBUF or MediaType.OCTET_STREAM or the MediaType.subtype() contains "protobuf". The JsonFormat.Parser for JSON is applied only when the content-type of the RequestHeaders is either MediaType.JSON or ends with +json.

Conversion of multiple Protobuf messages

A sequence of Protocol Buffer messages can not be handled by this RequestConverterFunction, because Protocol Buffers wire format is not self-delimiting. See Streaming Multiple Messages for more information. However, Collection types such as List<Message> and Set<Message> are supported when converted from JSON array.

Note that this RequestConverterFunction is applied to an annotated service by default, so you don't have to specify this converter explicitly unless you want to use your own JsonFormat.Parser and ExtensionRegistry.

Constructor Summary

Constructors

Constructor	Description
ProtobufRequestConverterFunction()	Creates an instance with the default JsonFormat.Parser and ExtensionRegistry.
ProtobufRequestConverterFunction(JsonFormat.Parser jsonParser, ExtensionRegistry extensionRegistry)	Creates an instance with the specified JsonFormat.Parser and ExtensionRegistry.

Method Summary

Modifier and Type	Method	Description
@Nullable Object	convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType, @Nullable ParameterizedType expectedParameterizedResultType)	Converts the specified request to an object of expectedResultType.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProtobufRequestConverterFunction

public ProtobufRequestConverterFunction()

Creates an instance with the default JsonFormat.Parser and ExtensionRegistry.

ProtobufRequestConverterFunction

public ProtobufRequestConverterFunction(JsonFormat.Parser jsonParser,
 ExtensionRegistry extensionRegistry)

Creates an instance with the specified JsonFormat.Parser and ExtensionRegistry.

Method Details

convertRequest

@Nullable
public @Nullable Object convertRequest(ServiceRequestContext ctx,
 AggregatedHttpRequest request,
 Class<?> expectedResultType,
 @Nullable
 @Nullable ParameterizedType expectedParameterizedResultType)
                                throws Exception

Description copied from interface: RequestConverterFunction

Converts the specified request to an object of expectedResultType. Calls RequestConverterFunction.fallthrough() or throws a FallthroughException if this converter cannot convert the request to an object.

Specified by:

convertRequest in interface RequestConverterFunction

Parameters:

ctx - the ServiceRequestContext of request.

request - the AggregatedHttpRequest being handled.

expectedResultType - the desired type of the conversion result.

expectedParameterizedResultType - the desired parameterized type of the conversion result. null will be given if expectedResultType doesn't have any type parameters.

Throws:

Exception