fish.payara.monitoring.adapt

Interface MonitoringConsolePageConfig

public interface MonitoringConsolePageConfig

Abstraction to manipulate page configuration. The implementation should store this configuration in a persistent manner.

Since:

1.1 (Payara 5.202)

Author:

Jan Bernitt

Method Summary

Modifier and Type	Method and Description
default boolean	existsPage(String name) Check if a page exists
String	getPage(String name) Access the JSON definition of the named page.
Iterable<String>	listPages()
void	putPage(String name, String pageJson) Adds a page in JSON form to the configuration.
default void	removePage(String name) Removes a page from the configuration.

Method Detail

getPage

String getPage(String name)

Access the JSON definition of the named page.

Parameters:

name - name of the page to access

Returns:

JSON value of the named page

Throws:

NoSuchElementException

existsPage

default boolean existsPage(String name)

Check if a page exists

Parameters:

name - page name to check

Returns:

true in case the page exists, false otherwise

putPage

void putPage(String name,
             String pageJson)

Adds a page in JSON form to the configuration.

Parameters:

name - name of the page

pageJson - page configuration

removePage

default void removePage(String name)

Removes a page from the configuration.

Parameters:

name - watch name

listPages

Iterable<String> listPages()

Returns:

lists then name of all existing pages.