Package com.linecorp.armeria.server.annotation

Class StringResponseConverterFunction

java.lang.Object

com.linecorp.armeria.server.annotation.StringResponseConverterFunction

All Implemented Interfaces:

ResponseConverterFunction

public final class StringResponseConverterFunction
extends Object
implements ResponseConverterFunction

A ResponseConverterFunction which creates an HttpResponse when:

• the result is instance of CharSequence
• the "content-type" of the ResponseHeaders is MediaType.ANY_TEXT_TYPE

Note that this ResponseConverterFunction is applied to the annotated service by default, so you don't have to set explicitly.

Constructor Summary

Constructors

Constructor	Description
StringResponseConverterFunction()

Method Summary

Modifier and Type	Method	Description
HttpResponse	convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, Object result, HttpHeaders trailers)	Returns HttpResponse instance corresponds to the given result.

Methods inherited from class java.lang.Object

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

Constructor Details

StringResponseConverterFunction

public StringResponseConverterFunction()

Method Details

convertResponse

public HttpResponse convertResponse(ServiceRequestContext ctx, ResponseHeaders headers, @Nullable Object result, HttpHeaders trailers) throws Exception

Description copied from interface: ResponseConverterFunction

Returns HttpResponse instance corresponds to the given result. Calls ResponseConverterFunction.fallthrough() or throws a FallthroughException if this converter cannot convert the result to the HttpResponse.

Specified by:

convertResponse in interface ResponseConverterFunction

headers - The HTTP headers that you might want to use to create the HttpResponse. The status of headers is HttpStatus.OK by default or HttpStatus.NO_CONTENT if the annotated method returns void, unless you specify it with StatusCode on the method. The headers also will include a MediaType if ServiceRequestContext.negotiatedResponseMediaType() returns it. If the method returns HttpResult, this headers is the same headers from HttpResult.headers() Please note that the additional headers set by ServiceRequestContext.mutateAdditionalResponseHeaders(Consumer) and AdditionalHeader are not included in this headers.

result - The result of the service method.

trailers - The HTTP trailers that you might want to use to create the HttpResponse. If the annotated method returns HttpResult, this trailers is the same trailers from HttpResult.trailers(). Please note that the additional trailers set by ServiceRequestContext.mutateAdditionalResponseTrailers(Consumer) and AdditionalTrailer are not included in this trailers.

Throws:

Exception