org.tanukisoftware.wrapper.jmx
Interface WrapperManagerMBean
- All Known Implementing Classes:
- WrapperManager
- public interface WrapperManagerMBean
Method Summary |
String |
getBuildTime()
Obtain the build time of Wrapper. |
boolean |
getHasShutdownHookBeenTriggered()
Returns true if the ShutdownHook for the JVM has already been triggered. |
int |
getJVMId()
Returns the Id of the current JVM. |
String |
getVersion()
Obtain the current version of Wrapper. |
boolean |
isControlledByNativeWrapper()
Returns true if the JVM was launched by the Wrapper application. |
boolean |
isDebugEnabled()
Returns true if the wrapper.debug property, or any of the logging
channels are set to DEBUG in the wrapper configuration file. |
boolean |
isLaunchedAsService()
Returns true if the Wrapper was launched as an NT service on Windows or
as a daemon process on UNIX platforms. |
void |
requestThreadDump()
Requests that the current JVM process request a thread dump. |
void |
restart()
Tells the native wrapper that the JVM wants to restart, then informs
all listeners that the JVM is about to shutdown before killing the JVM. |
void |
stop(int exitCode)
Tells the native wrapper that the JVM wants to shut down, then informs
all listeners that the JVM is about to shutdown before killing the JVM. |
getVersion
public String getVersion()
- Obtain the current version of Wrapper.
- Returns:
- The version of the Wrapper.
getBuildTime
public String getBuildTime()
- Obtain the build time of Wrapper.
- Returns:
- The time that the Wrapper was built.
getJVMId
public int getJVMId()
- Returns the Id of the current JVM. JVM Ids increment from 1 each time
the wrapper restarts a new one.
- Returns:
- The Id of the current JVM.
requestThreadDump
public void requestThreadDump()
- Requests that the current JVM process request a thread dump. This is
the same as pressing CTRL-BREAK (under Windows) or CTRL-\ (under Unix)
in the the console in which Java is running. This method does nothing
if the native library is not loaded.
isControlledByNativeWrapper
public boolean isControlledByNativeWrapper()
- Returns true if the JVM was launched by the Wrapper application. False
if the JVM was launched manually without the Wrapper controlling it.
- Returns:
- True if the current JVM was launched by the Wrapper.
isLaunchedAsService
public boolean isLaunchedAsService()
- Returns true if the Wrapper was launched as an NT service on Windows or
as a daemon process on UNIX platforms. False if launched as a console.
This can be useful if you wish to display a user interface when in
Console mode. On UNIX platforms, this is not as useful because an
X display may not be visible even if launched in a console.
- Returns:
- True if the Wrapper is running as an NT service or daemon
process.
isDebugEnabled
public boolean isDebugEnabled()
- Returns true if the wrapper.debug property, or any of the logging
channels are set to DEBUG in the wrapper configuration file. Useful
for deciding whether or not to output certain information to the
console.
- Returns:
- True if the Wrapper is logging any Debug level output.
restart
public void restart()
- Tells the native wrapper that the JVM wants to restart, then informs
all listeners that the JVM is about to shutdown before killing the JVM.
stop
public void stop(int exitCode)
- Tells the native wrapper that the JVM wants to shut down, then informs
all listeners that the JVM is about to shutdown before killing the JVM.
- Parameters:
exitCode
- The exit code that the Wrapper will return when it exits.
getHasShutdownHookBeenTriggered
public boolean getHasShutdownHookBeenTriggered()
- Returns true if the ShutdownHook for the JVM has already been triggered.
Some code needs to know whether or not the system is shutting down.
- Returns:
- True if the ShutdownHook for the JVM has already been triggered.
Copyright 1999, 2006 Tanuki Software Inc., All Rights Reserved.