com.linecorp.armeria.server.healthcheck

Class ManagedHttpHealthCheckService

java.lang.Object

com.linecorp.armeria.server.AbstractHttpService

com.linecorp.armeria.server.healthcheck.HttpHealthCheckService

com.linecorp.armeria.server.healthcheck.ManagedHttpHealthCheckService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>, TransientHttpService, TransientService<HttpRequest,HttpResponse>

Deprecated.

Use HealthCheckService.

@Deprecated
public class ManagedHttpHealthCheckService
extends HttpHealthCheckService

An HttpHealthCheckService which allows overriding its status via a PUT request.

Example

 Server server = Server.builder()
                       .serviceUnder("/health", new ManagedHttpHealthCheckService())
                       .build();
 

Default config uses content on or off. You can also use your own path matching.

 > Server server =
 >     Server.builder()
 >           .serviceUnder("health", new ManagedHttpHealthCheckService() {
 >               @Override
 >               public CompletionStage<Optional<Boolean>> mode(HttpRequest req) {
 >                   return CompletableFuture.completedFuture(Optional.empty());
 >               }
 >           })
 >           .build();
 

Constructor Summary

Constructors

Constructor and Description
ManagedHttpHealthCheckService() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected HttpResponse	doPut(ServiceRequestContext ctx, HttpRequest req) Deprecated. Handles a PUT request.
protected CompletionStage<Optional<Boolean>>	mode(ServiceRequestContext ctx, HttpRequest req) Deprecated. Judge the turning mode.

Methods inherited from class com.linecorp.armeria.server.healthcheck.HttpHealthCheckService

doGet, doHead, newHealthyResponse, newUnhealthyResponse, serviceAdded

Methods inherited from class com.linecorp.armeria.server.AbstractHttpService

doDelete, doDelete, doGet, doHead, doOptions, doOptions, doPatch, doPatch, doPost, doPost, doPut, doTrace, doTrace, serve

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, serve

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

as, decorate, shouldCachePath

Constructor Detail

ManagedHttpHealthCheckService

public ManagedHttpHealthCheckService()

Deprecated.

Method Detail

doPut

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

Deprecated.

Description copied from class: AbstractHttpService

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

Overrides:

doPut in class AbstractHttpService

Throws:

Exception

mode

protected CompletionStage<Optional<Boolean>> mode(ServiceRequestContext ctx,
                                                  HttpRequest req)

Deprecated.

Judge the turning mode. True means turn on, False is turn off. If not present, Not supported. Default implementation is check content is on/off for PUT method

Parameters:

req - HttpRequest