de.xima.fc.plugin.interfaces.monitoring

Interface IPluginMonitor

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginMonitor
extends IFCPlugin

A plugin for checking the current status of the FORMCYCLE system via monitoring MBeans. Contains one main method, check(), which lets you return a custom error message in case a web service etc. is currently not available.

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHECK_ERROR The constant for a non-successful check.
static String	CHECK_SUCCESS The constant for a successful check.

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

CONFIG_FILENAME

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

ATTR_NAME, COL_NAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method and Description
String	check() This method is invoked each time the monitor is refreshed.
default String	getObjectName() Override this method to define a custom monitor name.

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

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

Field Detail

CHECK_SUCCESS

static final String CHECK_SUCCESS

The constant for a successful check. Evaluates to "success".

See Also:

Constant Field Values

CHECK_ERROR

static final String CHECK_ERROR

The constant for a non-successful check. Evaluates to "error".

See Also:

Constant Field Values

Method Detail

getObjectName

default String getObjectName()

Override this method to define a custom monitor name. Defaults to the name of this class. The monitor key is the key for which the error message returned by check() is displayed.

Returns:

The key for this monitor.

check

String check()
      throws Exception

This method is invoked each time the monitor is refreshed. In case the check was successful, this must return CHECK_SUCCESS. If the check was not successful, you have got the following options:

• Throw an Exception.
• Return an error message. This error message is shown by the monitoring MBean. You may return any arbitrary error message string, or use CHECK_ERROR. Make sure you do not return the value of CHECK_SUCCESS, as that is interpreted as a successful check.

Returns:

Whether the check was successful or not. To indicate success, return "success". Otherwise, return an appropriate error message.

Throws:

Exception - When the check was not successful. The error message is returned to the monitoring MBean.