com.github.sbugat.rundeckmonitor

Class RundeckMonitorTrayIcon

java.lang.Object

com.github.sbugat.rundeckmonitor.RundeckMonitorTrayIcon

Direct Known Subclasses:

RundeckMonitorAWTTrayIcon, RundeckMonitorSwingTrayIcon

public abstract class RundeckMonitorTrayIcon
extends Object

Tray icon common class with no-AWT/Swing components.

Author:

Sylvain Bugat

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ActionListener	aboutListener About menu listener.
(package private) ActionListener	configurationListener Edit configuration listener.
(package private) Desktop	desktop Desktop to get the default browser.
(package private) ActionListener	exitListener Exit menu listener.
(package private) JDialog	hiddenDialog Dialog to auto-hade the popup menu.
(package private) static Icon	ICON_KO_SMALL
(package private) static Icon	ICON_LATE_SMALL
private static Image	IMAGE_DISCONNECTED Disconnected from rundeck image.
private static Image	IMAGE_KO KO image when a job has failed.
private static Image	IMAGE_KO_LATE KO image when a job has failed and a job seems to be blocked.
private static Image	IMAGE_LATE WARNING image when a job seems to be blocked.
(package private) static Image	IMAGE_OK OK image.
private static org.slf4j.ext.XLogger	LOG SLF4J XLogger.
(package private) static String	LONG_EXECUTION_MARKER Marker on the job when it is too long.
(package private) ActionListener	menuListener Menu failed item listener.
(package private) static String	NEW_FAILED_JOB_ALERT Alert message when a new failed job is detected.
(package private) static String	NEW_LONG_EXECUTION_ALERT Alert message when a new long execution is detected.
(package private) Set<Long>	newFailedProcess Already known failed process.
(package private) Set<Long>	newLateProcess Already known late/long process.
(package private) static String	RUNDECK_JOB_EXECUTION_URL URL to access job execution details.
(package private) static String	RUNDECK_MONITOR_PROJECT_URL GitHub Project URL.
(package private) RundeckMonitorConfiguration	rundeckMonitorConfiguration Date format to use for printing the Job start date.
(package private) RundeckMonitorState	rundeckMonitorState Current state of the trayIcon.
(package private) SystemTray	tray System tray.
(package private) TrayIcon	trayIcon Task bar tray icon.

Constructor Summary

Constructors

Constructor and Description
RundeckMonitorTrayIcon(RundeckMonitorConfiguration rundeckMonitorConfigurationArg, RundeckMonitorState rundeckMonitorStateArg) Initialize the tray icon for the rundeckMonitor if the OS is compatible with it.

Method Summary

Methods

Modifier and Type	Method and Description
void	disposeTrayIcon() remove the RundeckMonitor icon from the system tray.
(package private) void	openBrowser(JobExecutionInfo jobExecutionInfo) Open a browser page using the default browser to a job execution.
void	reloadConfiguration() Called when configuration is reloaded, clear all known process and reinitialize the tooltip.
abstract void	updateExecutionIdsList(List<JobExecutionInfo> listJobExecutionInfo) Update the list of failed/late jobs.
void	updateTrayIcon() Update the image of the tray icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.ext.XLogger LOG

SLF4J XLogger.

RUNDECK_JOB_EXECUTION_URL

static final String RUNDECK_JOB_EXECUTION_URL

URL to access job execution details.

See Also:

Constant Field Values

RUNDECK_MONITOR_PROJECT_URL

static final String RUNDECK_MONITOR_PROJECT_URL

GitHub Project URL.

See Also:

Constant Field Values

LONG_EXECUTION_MARKER

static final String LONG_EXECUTION_MARKER

Marker on the job when it is too long.

See Also:

Constant Field Values

NEW_FAILED_JOB_ALERT

static final String NEW_FAILED_JOB_ALERT

Alert message when a new failed job is detected.

See Also:

Constant Field Values

NEW_LONG_EXECUTION_ALERT

static final String NEW_LONG_EXECUTION_ALERT

Alert message when a new long execution is detected.

See Also:

Constant Field Values

IMAGE_OK

static final Image IMAGE_OK

OK image.

IMAGE_LATE

private static final Image IMAGE_LATE

WARNING image when a job seems to be blocked.

ICON_LATE_SMALL

static final Icon ICON_LATE_SMALL

IMAGE_KO

private static final Image IMAGE_KO

KO image when a job has failed.

ICON_KO_SMALL

static final Icon ICON_KO_SMALL

IMAGE_KO_LATE

private static final Image IMAGE_KO_LATE

KO image when a job has failed and a job seems to be blocked.

IMAGE_DISCONNECTED

private static final Image IMAGE_DISCONNECTED

Disconnected from rundeck image.

tray

final SystemTray tray

System tray.

trayIcon

TrayIcon trayIcon

Task bar tray icon.

desktop

final Desktop desktop

Desktop to get the default browser.

menuListener

ActionListener menuListener

Menu failed item listener.

configurationListener

final ActionListener configurationListener

Edit configuration listener.

aboutListener

final ActionListener aboutListener

About menu listener.

exitListener

final ActionListener exitListener

Exit menu listener.

hiddenDialog

JDialog hiddenDialog

Dialog to auto-hade the popup menu.

rundeckMonitorConfiguration

final RundeckMonitorConfiguration rundeckMonitorConfiguration

Date format to use for printing the Job start date.

rundeckMonitorState

final RundeckMonitorState rundeckMonitorState

Current state of the trayIcon.

newLateProcess

final Set<Long> newLateProcess

Already known late/long process.

newFailedProcess

final Set<Long> newFailedProcess

Already known failed process.

Constructor Detail

RundeckMonitorTrayIcon

public RundeckMonitorTrayIcon(RundeckMonitorConfiguration rundeckMonitorConfigurationArg,
                      RundeckMonitorState rundeckMonitorStateArg)

Initialize the tray icon for the rundeckMonitor if the OS is compatible with it.

Parameters:

rundeckMonitorConfigurationArg - loaded configuration

rundeckMonitorStateArg - state of the rundeck monitor

Method Detail

updateExecutionIdsList

public abstract void updateExecutionIdsList(List<JobExecutionInfo> listJobExecutionInfo)

Update the list of failed/late jobs.

Parameters:

listJobExecutionInfo - list of failed and late jobs informations

updateTrayIcon

public final void updateTrayIcon()

Update the image of the tray icon.

reloadConfiguration

public void reloadConfiguration()

Called when configuration is reloaded, clear all known process and reinitialize the tooltip.

disposeTrayIcon

public final void disposeTrayIcon()

remove the RundeckMonitor icon from the system tray.

openBrowser

final void openBrowser(JobExecutionInfo jobExecutionInfo)

Open a browser page using the default browser to a job execution.

Parameters:

jobExecutionInfo - the job exeuction to open