Package com.linecorp.armeria.server

Class AbstractHttpService

java.lang.Object

com.linecorp.armeria.server.AbstractHttpService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

Direct Known Subclasses:

AbstractGraphqlService, AbstractUnsafeUnaryGrpcService, FileService, ManagementService, PrometheusExpositionService, PrometheusExpositionService

public abstract class AbstractHttpService
extends Object
implements HttpService

A skeletal HttpService for easier HTTP service implementation.

This class provides the methods that handles the HTTP requests of the methods their names signify. For example, doGet() method handles a GET request.

• doOptions(ServiceRequestContext, HttpRequest)
• doGet(ServiceRequestContext, HttpRequest)
• doHead(ServiceRequestContext, HttpRequest)
• doPost(ServiceRequestContext, HttpRequest)
• doPut(ServiceRequestContext, HttpRequest)
• doPatch(ServiceRequestContext, HttpRequest)
• doDelete(ServiceRequestContext, HttpRequest)
• doTrace(ServiceRequestContext, HttpRequest)

These methods reject requests with a 405 Method Not Allowed response by default. Override one of them to handle requests properly.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpService()

Method Summary

Modifier and Type	Method	Description
protected HttpResponse	doConnect(ServiceRequestContext ctx, HttpRequest req)	Handles a CONNECT request.
protected HttpResponse	doDelete(ServiceRequestContext ctx, HttpRequest req)	Handles a DELETE request.
protected HttpResponse	doGet(ServiceRequestContext ctx, HttpRequest req)	Handles a GET request.
protected HttpResponse	doHead(ServiceRequestContext ctx, HttpRequest req)	Handles a HEAD request.
protected HttpResponse	doOptions(ServiceRequestContext ctx, HttpRequest req)	Handles an OPTIONS request.
protected HttpResponse	doPatch(ServiceRequestContext ctx, HttpRequest req)	Handles a PATCH request.
protected HttpResponse	doPost(ServiceRequestContext ctx, HttpRequest req)	Handles a POST request.
protected HttpResponse	doPut(ServiceRequestContext ctx, HttpRequest req)	Handles a PUT request.
protected HttpResponse	doTrace(ServiceRequestContext ctx, HttpRequest req)	Handles a TRACE request.
final HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.

Methods inherited from class java.lang.Object

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

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

decorate, decorate, exchangeType, options

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

Constructor Details

AbstractHttpService

public AbstractHttpService()

Method Details

serve

public final HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                         throws Exception

Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method.

Specified by:

serve in interface HttpService

Specified by:

serve in interface Service<HttpRequest,HttpResponse>

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

doOptions

protected HttpResponse doOptions(ServiceRequestContext ctx,
 HttpRequest req)
                          throws Exception

Handles an OPTIONS request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doGet

protected HttpResponse doGet(ServiceRequestContext ctx,
 HttpRequest req)
                      throws Exception

Handles a GET request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doHead

protected HttpResponse doHead(ServiceRequestContext ctx,
 HttpRequest req)
                       throws Exception

Handles a HEAD request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doPost

protected HttpResponse doPost(ServiceRequestContext ctx,
 HttpRequest req)
                       throws Exception

Handles a POST request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doPut

protected HttpResponse doPut(ServiceRequestContext ctx,
 HttpRequest req)
                      throws Exception

Handles a PUT request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doPatch

protected HttpResponse doPatch(ServiceRequestContext ctx,
 HttpRequest req)
                        throws Exception

Handles a PATCH request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doDelete

protected HttpResponse doDelete(ServiceRequestContext ctx,
 HttpRequest req)
                         throws Exception

Handles a DELETE request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doTrace

protected HttpResponse doTrace(ServiceRequestContext ctx,
 HttpRequest req)
                        throws Exception

Handles a TRACE request. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception

doConnect

protected HttpResponse doConnect(ServiceRequestContext ctx,
 HttpRequest req)
                          throws Exception

Handles a CONNECT request. Note that Armeria handles only a CONNECT request with a :protocol HTTP/2 pseudo header, as defined in RFC8441, Bootstrapping WebSockets with HTTP/2. This method sends a 405 Method Not Allowed response by default.

Throws:

Exception