wt.manager.jmx
Interface ServerManagerMonitorMBean

All Superinterfaces:

SelfEmailingMBean

public interface ServerManagerMonitorMBean
extends SelfEmailingMBean

Provides ability to manage a ServerManager. Also provides statistics about the ServerManager.

Supported API: true

Extendable: true

Field Summary

static String	PING_FAILED_NOTIFY_TYPE String PING_FAILED_NOTIFY_TYPE - Notification for when a ping fails.
static String	PING_SUCCESS_NOTIFY_TYPE String PING_SUCCESS_NOTIFY_TYPE - Notification for when a ping succeeds.

Method Summary

boolean	getAllowInitialAutoStartup() Allows/disallows auto startup of the ServerManager if it is not already running.
double	getAvgPingResponseSeconds() The average response time of ServerManager pings (in seconds).
int	getFailedPingsUntilRestart() The number of failed pings before attempting to restart the ServerManager.
double	getLastPingResponseSeconds() The response time of the most recent ping of the ServerManager (in seconds).
Timestamp	getLastResetTime() Time at which cumulative statistics were last reset.
String	getLoggerLevel() The current level of the logger.
String	getLoggerName() The logger name.
double	getPercentageServerManagerUpTime() The percentage of time the ServerManager is up.
int	getPingIntervalSeconds() The current interval between pings (in seconds).
CompositeData	getServerManagerInfo() Usage information and statistics about the ServerManager.
int	getServerManagerPings() The total number of ServerManager pings attempted.
String	pingServerManager() Ping the ServerManager.
void	resetStatistics() Reset ping response time statistics.
String	restartServerManger() Restart the ServerManager.
void	setAllowInitialAutoStartup(boolean allowAutoStartup) Allows/disallows auto startup of the ServerManager if it is not already running.
void	setFailedPingsUntilRestart(int newFailedPingsUntilRestart) The number of failed pings before attempting to restart the ServerManager.
void	setLoggerLevel(String logLevel) The current level of the logger.
void	setPingIntervalSeconds(int pingIntervalSeconds) The current interval between pings (in seconds).
String	startServerManager() Start the ServerManager.
String	stopServerManager() Stop the ServerManager.

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

emailThisMBean

Field Detail

PING_FAILED_NOTIFY_TYPE

static final String PING_FAILED_NOTIFY_TYPE

String PING_FAILED_NOTIFY_TYPE - Notification for when a ping fails.

Supported API: true

PING_SUCCESS_NOTIFY_TYPE

static final String PING_SUCCESS_NOTIFY_TYPE

String PING_SUCCESS_NOTIFY_TYPE - Notification for when a ping succeeds.

Supported API: true

Method Detail

getLoggerLevel

String getLoggerLevel()

The current level of the logger. Valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified). (not persisted with MBean)

Supported API: true

Returns:

String - The logger level.

setLoggerLevel

void setLoggerLevel(String logLevel)

The current level of the logger. Valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF (or blank/unspecified). (not persisted with MBean)

Supported API: true

Parameters:

logLevel - - The new log level.

getLoggerName

String getLoggerName()

The logger name.

Supported API: true

Returns:

String - The logger name.

getPingIntervalSeconds

int getPingIntervalSeconds()

The current interval between pings (in seconds).

Supported API: true

Returns:

int - The number of seconds between pings.

setPingIntervalSeconds

void setPingIntervalSeconds(int pingIntervalSeconds)

The current interval between pings (in seconds).

Supported API: true

Parameters:

pingIntervalSeconds - - Number of seconds between pings.

getFailedPingsUntilRestart

int getFailedPingsUntilRestart()

The number of failed pings before attempting to restart the ServerManager. A negative or zero value implies restarts will not be attempted.

Supported API: true

Returns:

int - The number of failed pings before attempting to restart the ServerManager.

getAllowInitialAutoStartup

boolean getAllowInitialAutoStartup()

Allows/disallows auto startup of the ServerManager if it is not already running.

Supported API: true

Returns:

boolean - Allows/disallows auto startup of the ServerManager if it is not already running.

setAllowInitialAutoStartup

void setAllowInitialAutoStartup(boolean allowAutoStartup)

Allows/disallows auto startup of the ServerManager if it is not already running.

Supported API: true

Parameters:

allowAutoStartup - - Allows/disallows auto startup of the ServerManager if it is not already running.

setFailedPingsUntilRestart

void setFailedPingsUntilRestart(int newFailedPingsUntilRestart)

The number of failed pings before attempting to restart the ServerManager. A negative or zero value implies restarts will not be attempted.

Supported API: true

Parameters:

newFailedPingsUntilRestart - - Number of failed pings allowed before attempting to restart the ServerManager.

getLastPingResponseSeconds

double getLastPingResponseSeconds()

The response time of the most recent ping of the ServerManager (in seconds).

Supported API: true

Returns:

double - The number of seconds the last ping took.

getAvgPingResponseSeconds

double getAvgPingResponseSeconds()

The average response time of ServerManager pings (in seconds).

Supported API: true

Returns:

double - The average number of seconds pings take.

getPercentageServerManagerUpTime

double getPercentageServerManagerUpTime()

The percentage of time the ServerManager is up.

Supported API: true

Returns:

double - The percentage of the time the ServerManager was up.

getServerManagerPings

int getServerManagerPings()

The total number of ServerManager pings attempted.

Supported API: true

Returns:

int - The number of attempted pings to the ServerManager.

getLastResetTime

Timestamp getLastResetTime()

Time at which cumulative statistics were last reset.

Supported API: true

getServerManagerInfo

CompositeData getServerManagerInfo()
                                   throws Exception

Usage information and statistics about the ServerManager.

Supported API: true

Returns:

CompositeData - Data and descriptions about the ServerManager.

Throws:

Exception - - If there is an error getting the ServerManager info.

stopServerManager

String stopServerManager()
                         throws Exception

Stop the ServerManager.

Supported API: true

Returns:

String - A message about the success of the stop request.

Throws:

WTException - - Contains message describing the problem and the original exception.

Exception

startServerManager

String startServerManager()
                          throws Exception

Start the ServerManager.

Supported API: true

Returns:

String - A message about the success of the start request.

Throws:

WTException - - Contains message describing the problem and the original exception.

Exception

restartServerManger

String restartServerManger()
                           throws Exception

Restart the ServerManager.

Supported API: true

Returns:

String - A message about the success of the restart request.

Throws:

WTException - - Contains message describing the problem and the original exception.

Exception

pingServerManager

String pingServerManager()
                         throws Exception

Ping the ServerManager.

Supported API: true

Returns:

String - A message about the success or failure of the ping request.

Throws:

Exception - - When error occurrs while attempting to ping the ServerManager. Contains message describing the problem and the original Exception.

resetStatistics

void resetStatistics()

Reset ping response time statistics.

Supported API: true