de.xima.fc.plugin.interfaces.monitoring

Interface IPluginMonitor

All Superinterfaces:

IFCPlugin, INameProviding, ITransferable, Serializable

public interface IPluginMonitor
extends IFCPlugin

Author:

xima media GmbH, Dresden - Ralf Theurich - 27.02.2017

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_ERROR Konstante für NICHT erfolgreiches Prüfen.
static String	CHECK_SUCCESS Konstante für erfolgreiches Prüfen.

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME

Method Summary

Modifier and Type	Method and Description
String	check() Methode wird bei jedem Aktualisieren der Anzeige des Monitors aufgerufen.
default String	getObjectName()

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Field Detail

CHECK_SUCCESS

static final String CHECK_SUCCESS

Konstante für erfolgreiches Prüfen. Liefert "success" zurück.

See Also:

Constant Field Values

CHECK_ERROR

static final String CHECK_ERROR

Konstante für NICHT erfolgreiches Prüfen. Liefert "error" zurück.

See Also:

Constant Field Values

Method Detail

getObjectName

default String getObjectName()

check

String check()
      throws Exception

Methode wird bei jedem Aktualisieren der Anzeige des Monitors aufgerufen. Muss im Fall einer erfolgreichen Prüfung "ok" (siehe Konstante IPluginMonitor.CHECK_SUCCESS) zurückliefern. Für den Fehlerfall bestehen folgende Möglichkeiten:

1. Es kann eine Exception geworfen werden.
2. Es kann eine Fehlernachricht zurückgegeben werden. Diese wird in der Monitoring MBean dargestellt. Die Zeichenkette kann selbst definiert sein, oder es kann die Konstante IPluginMonitor.CHECK_ERROR verwendet werden. In jeden Fall muss der Wert der zurückgelieferten Zeichenkette ungleich dem Wert der Konstante IPluginMonitor.CHECK_SUCCESS sein.

Throws:

Exception