Class DisabledObserverFeature

java.lang.Object

io.helidon.webserver.observe.DisabledObserverFeature

All Implemented Interfaces:

HttpFeature, ServerLifecycle, Supplier<HttpFeature>

public class DisabledObserverFeature
extends Object
implements HttpFeature

An HttpFeature that marks endpoint as disabled.

Method Summary

Modifier and Type	Method	Description
static DisabledObserverFeature	create(String observerName, String endpoint)	Create a new disabled feature.
void	setup(HttpRouting.Builder routing)	Method to set up a feature.

Methods inherited from class Object

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

Methods inherited from interface HttpFeature

get, socket, socketRequired

Modifier and Type	Method	Description
default HttpFeature	get()
default String	socket()	Name of the listener socket this feature should be registered on, for automatically discovered features.
default boolean	socketRequired()	Whether the socket defined in HttpFeature.socket() must be present for this feature, or it can be exposed on default socket.

Methods inherited from interface ServerLifecycle

afterStart, afterStop, beforeStart

Modifier and Type	Method	Description
default void	afterStart(WebServer webServer)	After server start.
default void	afterStop()	After server stop.
default void	beforeStart()	Before server start.

Method Details

create

public static DisabledObserverFeature create(String observerName,
 String endpoint)

Create a new disabled feature. Any requests to the endpoint will end with Status.SERVICE_UNAVAILABLE_503.

Parameters:

observerName - name of the observer, such as Health

endpoint - endpoint of the observer, such as /observe/health/*

Returns:

a new feature that returns unavailable for the endpoint for any method

setup

public void setup(HttpRouting.Builder routing)

Description copied from interface: HttpFeature

Method to set up a feature.

Specified by:

setup in interface HttpFeature

Parameters:

routing - routing builder