Class Management

java.lang.Object

com.codename1.backend.Management

All Implemented Interfaces:

HttpServer.Handler

public final class Management
extends Object
implements HttpServer.Handler

The server's management endpoints: health for the load balancer, metrics for a scraper, and the jobs and managed beans for an operator.

  GET  /manage/health          public; 503 while draining
  GET  /manage/metrics         every metric, as JSON
  GET  /manage/prometheus      every metric, in the Prometheus text format
  GET  /manage/jobs            the scheduled jobs and their last runs
  GET  /manage/managed         the managed beans, with their attributes' values
  POST /manage/managed/{bean}/{operation}   calls an operation; body: arguments

Off by default outside a development profile; cn1.management.enabled turns it on or off explicitly, and cn1.management.path moves it. Everything but health needs Authorization: Bearer . Without a token, a development profile serves the read-only views to anyone who can reach the port -- a laptop -- and no profile serves an operation, since an operation changes the running server.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED
static final String	PATH
static final String	TOKEN

Method Summary

Modifier and Type	Method	Description
static List	describeBeans(List all)	Each of all -- a server's managed beans, from Backend.getManagedBeans() -- with its attributes' current values and its operations.
static Management	fromConfig(Config config)	The endpoints this configuration asks for, or null when they are off.
HttpServer.Response	handle(HttpServer.Request request)
static Object	invoke(List all, String objectName, String operation, Map arguments)

Methods inherited from class Object

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

Field Details

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

PATH

public static final String PATH

See Also:

• Constant Field Values

TOKEN

public static final String TOKEN

See Also:

• Constant Field Values

Method Details

fromConfig

public static Management fromConfig(Config config)
                             throws IOException

The endpoints this configuration asks for, or null when they are off.

Throws

• IOException: when they are on outside development with no token, which would publish the server's internals to anyone

Throws:

IOException

describeBeans

public static List describeBeans(List all)

Each of all -- a server's managed beans, from Backend.getManagedBeans() -- with its attributes' current values and its operations.

invoke

public static Object invoke(List all,
 String objectName,
 String operation,
 Map arguments)
                     throws Exception

Throws:

Exception

handle

public HttpServer.Response handle(HttpServer.Request request)
                           throws Exception

Specified by:

handle in interface HttpServer.Handler

Throws:

Exception