de.xima.fc.plugin.interfaces

Interface IMonitorPlugin

public interface IMonitorPlugin

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.

Method Summary

Modifier and Type	Method and Description
String	check() Methode wird bei jedem Aktualisieren der Anzeige des Monitors aufgerufen.
default String	getObjectName()
default void	init() Methode zum Initialisieren des Plugins
default void	shutdown() Methode die vor dem Zerstören der Instanz gerufen wird

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()

init

default void init()

Methode zum Initialisieren des Plugins

shutdown

default void shutdown()

Methode die vor dem Zerstören der Instanz gerufen wird

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 IMonitorPlugin.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 IMonitorPlugin.CHECK_ERROR verwendet werden. In jeden Fall muss der Wert der zurückgelieferten Zeichenkette ungleich dem Wert der Konstante IMonitorPlugin.CHECK_SUCCESS sein.

Throws:

Exception