wt.intersvrcom
Interface SiteMonitorMBean

All Superinterfaces:

SelfEmailingMBean

public interface SiteMonitorMBean
extends SelfEmailingMBean

Provides status and statistics for vaulting sites. Data is gathered by periodically "pinging" the sites, i.e. issuing short, simple HTTP gateway servlet requests. These requests are similar to vaulting requests (though much simpler and faster) and will not receive responses unless the given site's web server(s), servlet engine(s), and method servers are running and communicating with one another.

Supported API: true

Extendable: true

Field Summary

static String	NO_RESPONSE_FROM_SITE_NOTIF_TYPE Type of notification produced when a site does not respond to a ping Supported API: true
static String	OK_STATUS Value of site status string that signifies that a site is reachable (and thus "OK") Supported API: true
static String	SITE_RESPONDING_AGAIN_NOTIF_TYPE Type of notification produced when a site is responding again after a period of being unresponsive Supported API: true

Method Summary

double	getConnectTimeoutSeconds() Ping connection timeout (in seconds) Supported API: true
Timestamp	getLastResetTime() Time at which cumulative statistics were last reset Supported API: true
String	getLoggerLevel() Ping result logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
String	getLoggerName() Name of ping result logger Supported API: true
int	getPingIntervalSeconds() Interval at which sites are pinged (in seconds); periodic pings are disabled if this is non-positive Supported API: true
double	getReadTimeoutSeconds() Ping read timeout (in seconds) Supported API: true
String	getSiteStatus(String siteURLString) Get site status string for a given site URL Supported API: true
CompositeData	getSiteStatusInfo() Site statuses and statistics from last periodic ping (if periodic pings are disabled, then a ping is performed) Supported API: true
void	resetStatistics() Reset cumulative statistics Supported API: true
void	setConnectTimeoutSeconds(double connectTimeoutSeconds) Ping connection timeout (in seconds) Supported API: true
void	setLoggerLevel(String level) Ping result logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified) Supported API: true
void	setPingIntervalSeconds(int pingIntervalSeconds) Interval at which sites are pinged (in seconds); periodic pings are disabled if this is non-positive Supported API: true
void	setReadTimeoutSeconds(double readTimeoutSeconds) Ping read timeout (in seconds) Supported API: true

Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

emailThisMBean

Field Detail

OK_STATUS

static final String OK_STATUS

Value of site status string that signifies that a site is reachable (and thus "OK")

Supported API: true

See Also:

Constant Field Values

NO_RESPONSE_FROM_SITE_NOTIF_TYPE

static final String NO_RESPONSE_FROM_SITE_NOTIF_TYPE

Type of notification produced when a site does not respond to a ping

Supported API: true

SITE_RESPONDING_AGAIN_NOTIF_TYPE

static final String SITE_RESPONDING_AGAIN_NOTIF_TYPE

Type of notification produced when a site is responding again after a period of being unresponsive

Supported API: true

Method Detail

getLoggerName

String getLoggerName()

Name of ping result logger

Supported API: true

getLoggerLevel

String getLoggerLevel()

Ping result logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true

setLoggerLevel

void setLoggerLevel(String level)

Ping result logging level (not persisted with MBean); valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified)

Supported API: true

getConnectTimeoutSeconds

double getConnectTimeoutSeconds()

Ping connection timeout (in seconds)

Supported API: true

setConnectTimeoutSeconds

void setConnectTimeoutSeconds(double connectTimeoutSeconds)

Ping connection timeout (in seconds)

Supported API: true

getReadTimeoutSeconds

double getReadTimeoutSeconds()

Ping read timeout (in seconds)

Supported API: true

setReadTimeoutSeconds

void setReadTimeoutSeconds(double readTimeoutSeconds)

Ping read timeout (in seconds)

Supported API: true

getPingIntervalSeconds

int getPingIntervalSeconds()

Interval at which sites are pinged (in seconds); periodic pings are disabled if this is non-positive

Supported API: true

setPingIntervalSeconds

void setPingIntervalSeconds(int pingIntervalSeconds)

Interval at which sites are pinged (in seconds); periodic pings are disabled if this is non-positive

Supported API: true

getSiteStatusInfo

CompositeData getSiteStatusInfo()
                                throws Exception

Site statuses and statistics from last periodic ping (if periodic pings are disabled, then a ping is performed)

Supported API: true

Throws:

Exception

getLastResetTime

Timestamp getLastResetTime()

Time at which cumulative statistics were last reset

Supported API: true

getSiteStatus

String getSiteStatus(String siteURLString)
                     throws Exception

Get site status string for a given site URL

Supported API: true

Parameters:

siteURLString - URL of site to get status for

Throws:

Exception

resetStatistics

void resetStatistics()

Reset cumulative statistics

Supported API: true