com.dpslink.base.tool

Class SiteMonitor

java.lang.Object

com.dpslink.base.tool.SiteMonitor

All Implemented Interfaces:

java.io.Serializable

public class SiteMonitor
extends java.lang.Object
implements java.io.Serializable

A command line utility that monitors one or more web sites for accessibility and sends email notifications for when site access failures are detected.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	SiteMonitor.SiteChecker A thread used to handle individual site accessibility checking.
(package private) class	SiteMonitor.SiteMonLogWriter A class to handle logging duties for site monitor.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.ResourceBundle	cvSM A reference to the "sitemonitor" resource properties.
private long	ivCheckInterval The amount of time to wait between web site checks.
protected SiteMonitor.SiteMonLogWriter	ivLogWriter The active LogWriter.
protected int	ivRetryAttempts The number of retry attempts.
protected long	ivRetryInterval The amount of time to wait between retry attempts.
protected java.util.ArrayList<java.lang.String>	ivSiteDescs A collection of web site descriptions.
protected java.util.ArrayList<java.lang.String>	ivSiteToAddrs A collection of web site email to addresses.
protected java.util.ArrayList<java.lang.String>	ivSiteToNames A collection of web site email to names.
protected java.util.ArrayList<java.lang.String>	ivSiteURLs A collection of web site urls.
private long	ivStartDelay The amount of time to wait before performing initial web site checks.
private static int	MAX_SITES The maximum number of the sites that can be monitored.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
SiteMonitor() Creates and initializes an instance of SiteMonitor.

Method Summary

Modifier and Type	Method and Description
private int	getParamAsNumber(java.lang.String key) Returns the configuration parameter numeric value for the given key in the sitemonitor.properties file.
private java.lang.String	getParamAsString(java.lang.String key) Returns the configuration parameter string value for the given key in the sitemonitor.properties file.
private java.lang.String	getProperty(java.lang.String key, boolean logerror) Returns the value for the given key in the sitemonitor.properties file.
private boolean	initIntervals() Initializes the monitor timing interval values.
private boolean	initLogFile() Initializes the monitor log file value.
private boolean	initWebSites() Initializes the monitor web site values.
private boolean	isKnownHost(java.lang.String hostname) Determines if a host name can be resolved to its IP address.
static void	main(java.lang.String[] args) Main entry point for when the class is started from a command line.
private void	monitor() Handles the monitor's main timing interval.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvSM

private static final java.util.ResourceBundle cvSM

A reference to the "sitemonitor" resource properties.

MAX_SITES

private static final int MAX_SITES

The maximum number of the sites that can be monitored.

See Also:

Constant Field Values

ivLogWriter

protected SiteMonitor.SiteMonLogWriter ivLogWriter

The active LogWriter.

ivStartDelay

private long ivStartDelay

The amount of time to wait before performing initial web site checks.

ivCheckInterval

private long ivCheckInterval

The amount of time to wait between web site checks.

ivRetryAttempts

protected int ivRetryAttempts

The number of retry attempts.

ivRetryInterval

protected long ivRetryInterval

The amount of time to wait between retry attempts.

ivSiteURLs

protected java.util.ArrayList<java.lang.String> ivSiteURLs

A collection of web site urls.

ivSiteDescs

protected java.util.ArrayList<java.lang.String> ivSiteDescs

A collection of web site descriptions.

ivSiteToAddrs

protected java.util.ArrayList<java.lang.String> ivSiteToAddrs

A collection of web site email to addresses.

ivSiteToNames

protected java.util.ArrayList<java.lang.String> ivSiteToNames

A collection of web site email to names.

Constructor Detail

SiteMonitor

public SiteMonitor()

Creates and initializes an instance of SiteMonitor.

Method Detail

initIntervals

private boolean initIntervals()

Initializes the monitor timing interval values.

Returns:

boolean - true if the initialization is successful, otherwise false.

initLogFile

private boolean initLogFile()

Initializes the monitor log file value.

Returns:

boolean - true if the initialization is successful, otherwise false.

initWebSites

private boolean initWebSites()

Initializes the monitor web site values.

Returns:

boolean - true if the initialization is successful, otherwise false.

getParamAsNumber

private int getParamAsNumber(java.lang.String key)

Returns the configuration parameter numeric value for the given key in the sitemonitor.properties file. Writes a message to the log file if the key is not found, if the key has no value, or if the key's value cannot be converted to numeric.

Parameters:

key - (String) The key associcated with the desired value.

Returns:

int - The key's numeric value, or -1 if the key is is not found, if the key has no value, or if its value cannot be converted to numeric.

getParamAsString

private java.lang.String getParamAsString(java.lang.String key)

Returns the configuration parameter string value for the given key in the sitemonitor.properties file. Writes a message to the log file if the key is not found or if the key has no value.

Parameters:

key - (String) The key associcated with the desired value.

Returns:

String - The key's value, or null if the key is is not found, or if the key has no value.

getProperty

private java.lang.String getProperty(java.lang.String key,
                                     boolean logerror)

Returns the value for the given key in the sitemonitor.properties file. Returns null if the key is not found (MissingResourceException).

Parameters:

key - (String) The key associated with the desired value.

logerror - (boolean) true if missing resource error messages are to be logged, otherwise false.

Returns:

String - The key's value, or null if the key is is not found.

isKnownHost

private boolean isKnownHost(java.lang.String hostname)

Determines if a host name can be resolved to its IP address.

Parameters:

hostname - (String) The host name to be resolved (xyz.company.com) or a web site url (http://www.company.com/stuff).

Returns:

boolean - true if the host name is successfully resolved, otherwise false.

monitor

private void monitor()

Handles the monitor's main timing interval. When first invoked or when the main timing interval elapses, each of the configured sites is checked for accessibility via a SiteChecker thread.

main

public static void main(java.lang.String[] args)

Main entry point for when the class is started from a command line.

Parameters:

args - (String[]) A String array of startup parameters for the class.