com.github.sbugat.rundeckmonitor

Class RundeckMonitor

java.lang.Object

com.github.sbugat.rundeckmonitor.RundeckMonitor

All Implemented Interfaces:

Runnable

public final class RundeckMonitor
extends Object
implements Runnable

Primary and main class of the Rundeck Monitor.

Author:

Sylvain Bugat

Field Summary

Fields

Modifier and Type	Field and Description
private long	dateDelta Time zone difference between local machine and rundeck server to correctly detect late execution.
private Set<Long>	knownFailedExecutionIds Set for all known failed execution identifiers.
private Set<Long>	knownLateExecutionIds Set for all known late execution identifiers.
private static org.slf4j.ext.XLogger	LOG SLF4J XLogger.
private static long	ONE_SECOND One second in mille-seconds.
private RundeckClient	rundeckClient Rundeck client API used to interact with rundeck rest API.
private RundeckMonitorConfiguration	rundeckMonitorConfiguration Configuration of the rundeck monitor with default values if some properties are missing or are empty.
private RundeckMonitorState	rundeckMonitorState Current state (failed job/long process/disconnected) of the rundeck monitor.
private RundeckMonitorTrayIcon	rundeckMonitorTrayIcon Tray icon and his menu for updating jobs and state displayed.
private VersionChecker	versionChecker Version checker instance.

Constructor Summary

Constructors

Constructor and Description
RundeckMonitor(RundeckMonitorConfiguration rundeckMonitorConfigurationArg, VersionChecker versionCheckerArg) Initialize the rundeck monitor, load configuration and try to connect to the configured rundeck.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	checkNewConfiguration(Date lastConfigurationUpdateDate) Check if the configuration file has been modified and reload it if needed.
private static boolean	handleStartupException(Exception exception, boolean initialization) Rundeck launcher exception handler, display an error message based on the argument exception.
private void	initRundeckClient() Check the configuration and initialize a new rundeck client.
static void	main(String[] args) RundeckMonitor main method.
void	reloadConfiguration() Reload the configuration file and update the RunDeck Moinitor with new datas.
void	run() RundeckMonitor background process method executing the main loop.
private void	updateRundeckHistory(boolean init) Call Rundeck rest API and update the monitor state and displayed jobs if there are new failed/late jobs.

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.

ONE_SECOND

private static final long ONE_SECOND

One second in mille-seconds.

See Also:

Constant Field Values

versionChecker

private final VersionChecker versionChecker

Version checker instance.

rundeckMonitorConfiguration

private final RundeckMonitorConfiguration rundeckMonitorConfiguration

Configuration of the rundeck monitor with default values if some properties are missing or are empty.

dateDelta

private long dateDelta

Time zone difference between local machine and rundeck server to correctly detect late execution.

rundeckClient

private RundeckClient rundeckClient

Rundeck client API used to interact with rundeck rest API.

rundeckMonitorTrayIcon

private final RundeckMonitorTrayIcon rundeckMonitorTrayIcon

Tray icon and his menu for updating jobs and state displayed.

rundeckMonitorState

private final RundeckMonitorState rundeckMonitorState

Current state (failed job/long process/disconnected) of the rundeck monitor.

knownLateExecutionIds

private final Set<Long> knownLateExecutionIds

Set for all known late execution identifiers.

knownFailedExecutionIds

private final Set<Long> knownFailedExecutionIds

Set for all known failed execution identifiers.

Constructor Detail

RundeckMonitor

public RundeckMonitor(RundeckMonitorConfiguration rundeckMonitorConfigurationArg,
              VersionChecker versionCheckerArg)
               throws IOException,
                      MissingPropertyException,
                      InvalidPropertyException,
                      UnknownProjectException,
                      InvalidRundeckVersion

Initialize the rundeck monitor, load configuration and try to connect to the configured rundeck.

Parameters:

rundeckMonitorConfigurationArg - rundeck monitor loaded configuration

versionCheckerArg - optionaly launched automatic version checker

Throws:

IOException - in case of loading configuration error

InvalidPropertyException - in case of loading configuration property error

MissingPropertyException - in case of loading configuration property error

UnknownProjectException - in case of unknown RunDeck project

InvalidRundeckVersion - if the Rundeck version is not supported

Method Detail

reloadConfiguration

public void reloadConfiguration()
                         throws IOException,
                                MissingPropertyException,
                                InvalidPropertyException,
                                UnknownProjectException,
                                InvalidRundeckVersion

Reload the configuration file and update the RunDeck Moinitor with new datas.

Throws:

IOException - in case of loading configuration error

MissingPropertyException - in case of loading configuration property error

InvalidPropertyException - in case of loading configuration property error

UnknownProjectException - in case of unknown RunDeck project

InvalidRundeckVersion - if the Rundeck version is not supported

initRundeckClient

private void initRundeckClient()
                        throws MissingPropertyException,
                               InvalidPropertyException,
                               UnknownProjectException,
                               InvalidRundeckVersion

Check the configuration and initialize a new rundeck client.

Throws:

MissingPropertyException - when check configuration

InvalidPropertyException - when check configuration

UnknownProjectException - if the configured project is unknown

InvalidRundeckVersion - if the Rundeck version is not supported

checkNewConfiguration

private boolean checkNewConfiguration(Date lastConfigurationUpdateDate)

Check if the configuration file has been modified and reload it if needed.

Parameters:

lastConfigurationUpdateDate - last configuration update date

Returns:

true if the configuration has been reloaded, false otherwise

run

public void run()

RundeckMonitor background process method executing the main loop.

Specified by:

run in interface Runnable

updateRundeckHistory

private void updateRundeckHistory(boolean init)

Call Rundeck rest API and update the monitor state and displayed jobs if there are new failed/late jobs.

Parameters:

init - boolean to indicate if it's the first call to this method for the monitor initialization

handleStartupException

private static boolean handleStartupException(Exception exception,
                             boolean initialization)

Rundeck launcher exception handler, display an error message based on the argument exception.

Parameters:

exception - exception to analyze

initialization - indicate if the tray icon is not loaded yet

Returns:

true if the wizard needs to be launched

main

public static void main(String[] args)

RundeckMonitor main method.

Parameters:

args - program arguments: none is expected and used