fish.payara.monitoring.adapt

Interface MonitoringConsoleFactory

public interface MonitoringConsoleFactory

The monitoring console library provides an implementations for this interface that is accessed using the ServiceLoader mechanism, getInstance() can be used for convenience. This allows a monitored application to be in control of creating the MonitoringConsole using the resolved factory instance. This is usually needed so that the monitored application can bootstrap the MonitoringConsole at the right point in its bootstrapping process.

Since:

1.0 (Payara 5.201)

Author:

Jan Bernitt

Method Summary

Modifier and Type	Method and Description
MonitoringConsole	create(String instance, boolean receiver, MonitoringConsoleRuntime runtime, Supplier<? extends List<MonitoringDataSource>> dataSources, Supplier<? extends List<MonitoringWatchSource>> watchSources) Creates a new instance of a MonitoringConsole processing unit.
MonitoringConsole	getCreatedConsole()
static MonitoringConsoleFactory	getInstance()

Method Detail

create

MonitoringConsole create(String instance,
                         boolean receiver,
                         MonitoringConsoleRuntime runtime,
                         Supplier<? extends List<MonitoringDataSource>> dataSources,
                         Supplier<? extends List<MonitoringWatchSource>> watchSources)

Creates a new instance of a MonitoringConsole processing unit.

Parameters:

instance - the name of the instance the console represent, the instance it collects data from

receiver - true, if the created instance is the single receiver of the cluster (the central instance), false if it is one of the senders of the cluster.

runtime - the runtime to use by the created instance, cannot be null

Returns:

A new logical instance of the MonitoringConsole

getCreatedConsole

MonitoringConsole getCreatedConsole()
                             throws IllegalStateException

Returns:

The MonitoringConsole instance previously created using create(String, boolean, MonitoringConsoleRuntime, Supplier, Supplier)

Throws:

IllegalStateException - if this method is called before create(String, boolean, MonitoringConsoleRuntime, Supplier, Supplier) was

getInstance

static MonitoringConsoleFactory getInstance()

Returns:

A MonitoringConsoleFactory instance or null if none is available on classpath.