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:

FileService, HttpHealthCheckService, PrometheusExpositionService, RedirectService

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 and Description
AbstractHttpService()

Method Summary

Modifier and Type	Method and Description
protected HttpResponse	doDelete(ServiceRequestContext ctx, HttpRequest req) Handles a DELETE request.
protected void	doDelete(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doDelete(ServiceRequestContext, HttpRequest).
protected HttpResponse	doGet(ServiceRequestContext ctx, HttpRequest req) Handles a GET request.
protected void	doGet(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doGet(ServiceRequestContext, HttpRequest).
protected HttpResponse	doHead(ServiceRequestContext ctx, HttpRequest req) Handles a HEAD request.
protected void	doHead(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doHead(ServiceRequestContext, HttpRequest).
protected HttpResponse	doOptions(ServiceRequestContext ctx, HttpRequest req) Handles an OPTIONS request.
protected void	doOptions(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doOptions(ServiceRequestContext, HttpRequest).
protected HttpResponse	doPatch(ServiceRequestContext ctx, HttpRequest req) Handles a PATCH request.
protected void	doPatch(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doPatch(ServiceRequestContext, HttpRequest).
protected HttpResponse	doPost(ServiceRequestContext ctx, HttpRequest req) Handles a POST request.
protected void	doPost(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doPost(ServiceRequestContext, HttpRequest).
protected HttpResponse	doPut(ServiceRequestContext ctx, HttpRequest req) Handles a PUT request.
protected void	doPut(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doPut(ServiceRequestContext, HttpRequest).
protected HttpResponse	doTrace(ServiceRequestContext ctx, HttpRequest req) Handles a TRACE request.
protected void	doTrace(ServiceRequestContext ctx, HttpRequest req, HttpResponseWriter res) Deprecated. Use doTrace(ServiceRequestContext, HttpRequest).
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

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

as, decorate, serviceAdded, shouldCachePath

Constructor Detail

AbstractHttpService

public AbstractHttpService()

Method Detail

serve

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

Serves the specified HttpRequest by delegating it to the matching 'doMETHOD()' method. Override this method to perform an action for the requests of any HTTP methods:

 > public class MyHttpService extends AbstractHttpService {
 >     private final Map<HttpMethod, AtomicInteger> handledRequests = new ConcurrentHashMap<>();
 >
 >     @Override
 >     public HttpResponse serve(ServiceRequestContext ctx, HttpRequest req) throws Exception {
 >         final HttpResponse res = super.serve(ctx, req);
 >         handledRequests.computeIfAbsent(
 >                 req.method(), method -> new AtomicInteger()).incrementAndGet();
 >         return res;
 >     }
 > }
 

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

doOptions

@Deprecated
protected void doOptions(ServiceRequestContext ctx,
                                     HttpRequest req,
                                     HttpResponseWriter res)
                              throws Exception

Deprecated. Use doOptions(ServiceRequestContext, HttpRequest).

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

doGet

@Deprecated
protected void doGet(ServiceRequestContext ctx,
                                 HttpRequest req,
                                 HttpResponseWriter res)
                          throws Exception

Deprecated. Use doGet(ServiceRequestContext, HttpRequest).

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

doHead

@Deprecated
protected void doHead(ServiceRequestContext ctx,
                                  HttpRequest req,
                                  HttpResponseWriter res)
                           throws Exception

Deprecated. Use doHead(ServiceRequestContext, HttpRequest).

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

doPost

@Deprecated
protected void doPost(ServiceRequestContext ctx,
                                  HttpRequest req,
                                  HttpResponseWriter res)
                           throws Exception

Deprecated. Use doPost(ServiceRequestContext, HttpRequest).

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

doPut

@Deprecated
protected void doPut(ServiceRequestContext ctx,
                                 HttpRequest req,
                                 HttpResponseWriter res)
                          throws Exception

Deprecated. Use doPut(ServiceRequestContext, HttpRequest).

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

doPatch

@Deprecated
protected void doPatch(ServiceRequestContext ctx,
                                   HttpRequest req,
                                   HttpResponseWriter res)
                            throws Exception

Deprecated. Use doPatch(ServiceRequestContext, HttpRequest).

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

doDelete

@Deprecated
protected void doDelete(ServiceRequestContext ctx,
                                    HttpRequest req,
                                    HttpResponseWriter res)
                             throws Exception

Deprecated. Use doDelete(ServiceRequestContext, HttpRequest).

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

doTrace

@Deprecated
protected void doTrace(ServiceRequestContext ctx,
                                   HttpRequest req,
                                   HttpResponseWriter res)
                            throws Exception

Deprecated. Use doTrace(ServiceRequestContext, HttpRequest).

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

Throws:

Exception