Package com.linecorp.armeria.server.annotation

@NonNullByDefault package com.linecorp.armeria.server.annotation

Annotations for building a RESTful service.

Interface Summary

Interface	Description
DecoratorFactoryFunction<T extends Annotation>	A decorator factory which is used for a user-defined decorator annotation.
ExceptionHandlerFunction	An interface for exception handler.
HttpResult<T>	An interface which helps a user specify an HttpStatus or ResponseHeaders for a response produced by an annotated HTTP service method.
RequestConverterFunction	Converts an AggregatedHttpRequest to an object.
RequestConverterFunctionProvider	A RequestConverterFunction provider interface which creates a new RequestConverterFunction for converting an AggregatedHttpRequest to an object of the given type.
ResponseConverterFunction	Converts a result object to HttpResponse.
ResponseConverterFunctionProvider	A ResponseConverterFunction provider interface which creates a new ResponseConverterFunction for converting an object of the given type and functions.

Class Summary

Class	Description
ByteArrayRequestConverterFunction	A RequestConverterFunction which converts a binary body of the AggregatedHttpRequest to one of byte[] or HttpData depending on the expectedResultType.
ByteArrayResponseConverterFunction	A ResponseConverterFunction which creates an HttpResponse when: the result is an instance of HttpData or byte[] the result is an instance of Publisher or Stream while the "content-type" of the ResponseHeaders is "application/binary" or "application/octet-stream" Note that this ResponseConverterFunction is applied to an annotated service by default, so you don't have to specify this converter explicitly.
HttpFileResponseConverterFunction	A response converter implementation which creates an HttpResponse when the result is an instance of HttpFile.
JacksonRequestConverterFunction	A RequestConverterFunction which converts a JSON body of the AggregatedHttpRequest to an object using the default ObjectMapper.
JacksonResponseConverterFunction	A response converter implementation which creates an HttpResponse with content-type: application/json; charset=utf-8 or content-type: application/json-seq.
NullToNoContentResponseConverterFunction	A response converter implementation which creates an HttpResponse of HttpStatus.NO_CONTENT when the specified result is null.
ServerSentEventResponseConverterFunction	A response converter implementation which creates an HttpResponse with content-type: text/event-stream.
StringRequestConverterFunction	A RequestConverterFunction which converts a text body of the AggregatedHttpRequest to a String.
StringResponseConverterFunction	A ResponseConverterFunction which creates an HttpResponse when: the result is an instance of CharSequence the "content-type" of the ResponseHeaders is MediaType.ANY_TEXT_TYPE Note that this ResponseConverterFunction is applied to an annotated service by default, so you don't have to specify this converter explicitly.

Enum Class Summary

Enum Class	Description
ExceptionVerbosity	Deprecated. Use LoggingService or log exceptions using ServerBuilder.errorHandler(ServerErrorHandler) instead.

Exception Summary

Exception	Description
FallthroughException	A RuntimeException raised for falling through to the next something.

Annotation Interfaces Summary

Annotation Interface	Description
AdditionalHeader	Annotation for an additional HTTP header.
AdditionalHeaders	The containing annotation type for AdditionalHeader.
AdditionalTrailer	Annotation for an additional HTTP trailer.
AdditionalTrailers	The containing annotation type for AdditionalTrailer.
Blocking	Specifies that the annotated service method must be invoked from the blocking task executor instead of an event loop thread.
Consumes	Specifies a media type which would be consumed by the service method or class.
ConsumesBinary	An alias for @Consumes(MediaTypeNames.APPLICATION_BINARY).
ConsumesGroup	The containing annotation type for Consumes.
ConsumesJson	An alias for @Consumes(MediaTypeNames.JSON).
ConsumesOctetStream	An alias for @Consumes(MediaTypeNames.OCTET_STREAM).
ConsumesProtobuf	An alias for @Consumes(MediaTypeNames.PROTOBUF).
ConsumesText	An alias for @Consumes(MediaTypeNames.PLAIN_TEXT_UTF_8).
Decorator	Specifies a DecoratingHttpServiceFunction class which handles an HttpRequest before invoking an annotated service method.
DecoratorFactory	Specifies a DecoratorFactoryFunction class which is a factory to create a decorator.
Decorators	The containing annotation type for Decorator.
Default	Specifies the default value of an optional parameter.
Delete	Annotation for mapping HttpMethod.DELETE onto specific method.
Description	An annotation used in annotated HTTP service.
ExceptionHandler	Specifies an ExceptionHandlerFunction class which handles exceptions throwing from an annotated service method.
ExceptionHandlers	The containing annotation type for ExceptionHandler.
Get	Annotation for mapping HttpMethod.GET onto specific method.
Head	Annotation for mapping HttpMethod.HEAD onto specific method.
Header	Annotation for mapping an HTTP request header onto the following elements.
MatchesHeader	Specifies a predicate which evaluates whether a request can be accepted by a service method.
MatchesHeaders	The containing annotation type for MatchesHeader.
MatchesParam	Specifies a predicate which evaluates whether a request can be accepted by a service method.
MatchesParams	The containing annotation type for MatchesParam.
Options	Annotation for mapping HttpMethod.OPTIONS onto specific method.
Order	Specifies an order which is used to sort the annotated service methods.
Param	Annotation for mapping a parameter of a request onto the following elements.
Patch	Annotation for mapping HttpMethod.PATCH onto specific method.
Path	Annotation for mapping dynamic web requests onto specific method.
PathPrefix	Annotation that can be used on a class as a path prefix for all the methods that handle http request.
Paths	The containing annotation type for Path.
Post	Annotation for mapping HttpMethod.POST onto specific method.
Produces	Specifies a media type which would be produced by the service method or class.
ProducesBinary	An alias for @Produces(MediaTypeNames.APPLICATION_BINARY).
ProducesEventStream	An alias for @Produces(MediaTypeNames.EVENT_STREAM) and @ResponseConverter(ServerSentEventResponseConverterFunction.class).
ProducesGroup	The containing annotation type for Produces.
ProducesJson	An alias for @Produces(MediaTypeNames.JSON_UTF_8).
ProducesJsonSequences	An alias for @Produces(MediaTypeNames.JSON_SEQ).
ProducesOctetStream	An alias for @Produces(MediaTypeNames.OCTET_STREAM).
ProducesProtobuf	An alias for @Produces(MediaTypeNames.PROTOBUF).
ProducesText	An alias for @Produces(MediaTypeNames.PLAIN_TEXT_UTF_8).
Put	Annotation for mapping HttpMethod.PUT onto specific method.
RequestConverter	Specifies a RequestConverterFunction class which converts an AggregatedHttpRequest to an object.
RequestConverters	The containing annotation type for RequestConverter.
RequestObject	Specifies which element should be converted by RequestConverterFunction.
ResponseConverter	Specifies a ResponseConverterFunction class which converts the result to HttpResponse.
ResponseConverters	The containing annotation type for ResponseConverter.
ServiceName	Annotation for service name that is often used as a meter tag or distributed trace's span name.
StatusCode	An annotation which specifies a default HTTP status code of a response produced by an annotated HTTP service.
Trace	Annotation for mapping HttpMethod.TRACE onto specific method.