com.linecorp.armeria.server.http

Class AbstractHttpService

java.lang.Object

com.linecorp.armeria.server.http.AbstractHttpService

All Implemented Interfaces:

HttpService, Service<HttpRequest,HttpResponse>

Direct Known Subclasses:

HttpFileService, HttpHealthCheckService, THttpService

public abstract class AbstractHttpService
extends java.lang.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, HttpResponseWriter)
• doGet(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doHead(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doPost(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doPut(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doPatch(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doDelete(ServiceRequestContext, HttpRequest, HttpResponseWriter)
• doTrace(ServiceRequestContext, HttpRequest, HttpResponseWriter)

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

as, decorate, decorate, decorate, serviceAdded

Constructor Detail

AbstractHttpService

public AbstractHttpService()

Method Detail

serve

public HttpResponse serve(ServiceRequestContext ctx,
                          HttpRequest req)
                   throws java.lang.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:

java.lang.Exception

doOptions

protected void doOptions(ServiceRequestContext ctx,
                         HttpRequest req,
                         HttpResponseWriter res)
                  throws java.lang.Exception

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

Throws:

java.lang.Exception

doGet

protected void doGet(ServiceRequestContext ctx,
                     HttpRequest req,
                     HttpResponseWriter res)
              throws java.lang.Exception

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

Throws:

java.lang.Exception

doHead

protected void doHead(ServiceRequestContext ctx,
                      HttpRequest req,
                      HttpResponseWriter res)
               throws java.lang.Exception

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

Throws:

java.lang.Exception

doPost

protected void doPost(ServiceRequestContext ctx,
                      HttpRequest req,
                      HttpResponseWriter res)
               throws java.lang.Exception

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

Throws:

java.lang.Exception

doPut

protected void doPut(ServiceRequestContext ctx,
                     HttpRequest req,
                     HttpResponseWriter res)
              throws java.lang.Exception

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

Throws:

java.lang.Exception

doPatch

protected void doPatch(ServiceRequestContext ctx,
                       HttpRequest req,
                       HttpResponseWriter res)
                throws java.lang.Exception

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

Throws:

java.lang.Exception

doDelete

protected void doDelete(ServiceRequestContext ctx,
                        HttpRequest req,
                        HttpResponseWriter res)
                 throws java.lang.Exception

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

Throws:

java.lang.Exception

doTrace

protected void doTrace(ServiceRequestContext ctx,
                       HttpRequest req,
                       HttpResponseWriter res)
                throws java.lang.Exception

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

Throws:

java.lang.Exception