Package com.linecorp.armeria.server.annotation

Interface AnnotatedService

All Superinterfaces:

HttpService, Service<HttpRequest,HttpResponse>, Unwrappable

@Nullable
public interface AnnotatedService
extends HttpService

An HttpService which is defined by a Path or HTTP method annotations. This class is designed to provide a common interface and expose as public for Annotated HTTP Service. Please check out the documentation at Annotated HTTP Service to use this.

Method Summary

Modifier and Type	Method	Description
HttpStatus	defaultStatus()	Returns the default HttpStatus specified with StatusCode.
Method	method()	Returns the target Method invoked when a request is received.
default String	methodName()	Returns the name of the target method invoked when a request is received.
@Nullable String	name()	Returns the name of this annotated service specified with ServiceName.
Route	route()	Returns the Route for this AnnotatedService.
Class<?>	serviceClass()	Returns the Class of the annotated service object specified with ServerBuilder.annotatedService(Object).
Object	serviceObject()	Returns the annotated service object specified with ServerBuilder.annotatedService(Object).

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate, exchangeType, options, serve

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

name

@Nullable
@Nullable String name()

Returns the name of this annotated service specified with ServiceName.

serviceObject

Object serviceObject()

Returns the annotated service object specified with ServerBuilder.annotatedService(Object).

serviceClass

Class<?> serviceClass()

Returns the Class of the annotated service object specified with ServerBuilder.annotatedService(Object).

method

Method method()

Returns the target Method invoked when a request is received.

methodName

default String methodName()

Returns the name of the target method invoked when a request is received.

route

Route route()

Returns the Route for this AnnotatedService.

defaultStatus

HttpStatus defaultStatus()

Returns the default HttpStatus specified with StatusCode. If StatusCode is not given, HttpStatus.OK is returned by default. If the method returns a void type such as Void or Kotlin Unit, HttpStatus.NO_CONTENT is returned.