Package com.linecorp.armeria.server.annotation

Class JacksonRequestConverterFunction

java.lang.Object

com.linecorp.armeria.server.annotation.JacksonRequestConverterFunction

All Implemented Interfaces:

RequestConverterFunction

public final class JacksonRequestConverterFunction
extends Object
implements RequestConverterFunction

A RequestConverterFunction which converts a JSON body of the AggregatedHttpRequest to an object using the default ObjectMapper. The RequestConverterFunction is applied only when the content-type of the RequestHeaders is MediaType.JSON or ends with +json. 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 ObjectMapper.

Constructor Summary

Constructors

Constructor	Description
JacksonRequestConverterFunction()	Creates an instance with the default ObjectMapper.
JacksonRequestConverterFunction(ObjectMapper mapper)	Creates an instance with the specified ObjectMapper.

Method Summary

Modifier and Type	Method	Description
@Nullable Object	convertRequest(ServiceRequestContext ctx, AggregatedHttpRequest request, Class<?> expectedResultType, @Nullable ParameterizedType expectedParameterizedResultType)	Converts the specified AggregatedHttpRequest 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

JacksonRequestConverterFunction

public JacksonRequestConverterFunction()

Creates an instance with the default ObjectMapper.

JacksonRequestConverterFunction

public JacksonRequestConverterFunction(ObjectMapper mapper)

Creates an instance with the specified ObjectMapper.

Method Details

convertRequest

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

Converts the specified AggregatedHttpRequest to an object of expectedResultType.

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