Service Control code which is received when permission to suspend the computer was denied by a process. Support for this event was removed from the Windows OS starting with Vista.
Service Control code which is received when the system has resumed operation. This event can indicate that some or all applications did not receive a SERVICE_CONTROL_CODE_POWEREVENT_SUSPEND event. Support for this event was removed from the Windows OS starting with Vista. See SERVICE_CONTROL_CODE_POWEREVENT_RESUMEAUTOMATIC.
Service Control code which is received when the battery power is low. Support for this event was removed from the Windows OS starting with Vista. See SERVICE_CONTROL_CODE_POWEREVENT_POWERSTATUSCHANGE.
Service Control code which is received when there is a change in the power status of the computer, such as a switch from battery power to A/C. The system also broadcasts this event when remaining battery power slips below the threshold specified by the user or if the battery power changes by a specified percentage.
Service Control code which is received when the APM BIOS has signaled an APM OEM event. Support for this event was removed from the Windows OS starting with Vista.
domain - Domain of the resource.
folder - Location of the resource.
The time that the Wrapper was built.
Returns the Id of the current JVM. JVM Ids increment from 1 each time the wrapper restarts a new one.
The Id of the current JVM.
When the JVM exits or is terminated for any reason, the Wrapper will clean up any child processes launched with this method automatically before shutting down or launching a new JVM.
The returned WrapperProcess object can be used to control the child process, supply input, or process output.
command - A specified system command in one String.
A new WrapperProcess object for managing the subprocess.
java.lang.NullPointerException - If command is null.
java.lang.SecurityException - If a SecurityManager is present and its checkExec method doesn't allow creation of a subprocess.
WrapperJNIError - If the native library has not been loaded or is in the process of shutting down.
WrapperLicenseError - If the function is called other than in the Professional Edition or if the native library has not been loaded.
By configuring the WrapperProcessConfig object, it is possible to control whether or not the child process will be automatically cleaned up when the JVM exits or is terminated. It is also possible to control how the child process is launched to work around memory issues on some platforms.
Please review the WrapperProcessConfig class for a full list of options.
cmdArray - A specified system command in array format for each parameter a single element.
java.io.IOException - Will be thrown at any error realated with Memory allocation, or if the command does not exist.
java.lang.NullPointerException - If cmdarray is null, or one of the elements of cmdarray is null.
java.lang.IllegalArgumentException - If there are any problems with the WrapperProcessConfig object.
cmdArray - A specified system command in array format, for each parameter a single element.
Returns true if the native library has been loaded successfully, false otherwise. This value can switch to false on shutdown when the native library can no longer be reliably referenced.
True if the native library is loaded and available.
Returns the OS that the Wrapper has resolved. This will be the same as the WRAPPER_OS environment variable. Used when resolving the platform specific native library name.
The resolved Wrapper OS name.
Returns the Architecture that the Wrapper has resolved. This will be the same as the WRAPPER_ARCH environment variable. Used when resolving the platform specific native library name.
The resolved Wrapper Architecture name.
True if this is Windows.
True if this is Mac OSX.
True if this is AIX.
Returns true if the current Wrapper edition has support for Professional Edition features. False will also be returned if the native library has not been initialized correctly.
True if professional features are supported.
Returns true if the current Wrapper edition has support for Standard Edition features. False will also be returned if the native library has not been initialized correctly.
True if standard features are supported.
eventNr - The user-event number to fire. Must be in the range of 1-32767.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("fireUserEvent") permission.
Sets the title of the console in which the Wrapper is running. This is currently only supported on Windows platforms.
As an alternative, it is also possible to set the console title from within the wrapper.conf file using the wrapper.console.title property.
title - The new title. The specified string will be encoded to a byte array using the default encoding for the current platform.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("setConsoleTitle") permission.
Returns a WrapperUser object which describes the user under which the Wrapper is currently running. Additional platform specific information can be obtained by casting the object to a platform specific subclass. WrapperWin32User, for example.
groups - True if the user's groups should be returned as well. Requesting the groups that a user belongs to increases the CPU load required to complete the call.
An object describing the current user.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("getUser") permission.
Returns a WrapperUser object which describes the interactive user whose desktop is being interacted with. When a service running on a Windows platform has its interactive flag set, this method will return the user who is currently logged in. Additional platform specific information can be obtained by casting the object to a platform specific subclass. WrapperWin32User, for example.
If a user is not currently logged on then this method will return null. User code can repeatedly call this method to detect when a user has logged in. To detect when a user has logged out, there are two options. 1) The user code can continue to call this method until it returns null. 2) Or if the WrapperListener method is being implemented, the WrapperListener.controlEvent method will receive a WRAPPER_CTRL_LOGOFF_EVENT event when the user logs out.
On XP systems, it is possible to switch to another account rather than actually logging out. In such a case, the interactive user will be the first user that logged in. This will also be the only user with which the service will interact. If other users are logged in when the interactive user logs out, the service will not automatically switch to another logged in user. Rather, the next user to log in will become the new user which the service will interact with.
This method will always return NULL on versions of NT prior to Windows 2000. This can not be helped as some required functions were not added to the windows API until NT version 5.0, also known as Windows 2000.
The current interactive user, or null.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("getInteractiveUser") permission.
Returns a Properties object containing expanded the contents of the configuration file used to launch the Wrapper. All properties are included so it is possible to define properties not used by the Wrapper in the configuration file and have then be available in this Properties object.
The contents of the Wrapper configuration file.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("getProperties") permission.
Returns the PID of the Wrapper process. A PID of 0 will be returned if the JVM was launched standalone. This value can also be obtained using the 'wrapper.pid' system property.
The PID of the Wrpper process.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("getWrapperPID") permission.
Returns the PID of the Java process. A PID of 0 will be returned if the native library has not been initialized. This value can also be obtained using the 'wrapper.java.pid' system property.
The PID of the Java process.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("getJavaPID") permission.
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.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("requestThreadDump") permission.
(Testing Method) Causes the WrapperManager to go into a state which makes the JVM appear to be hung when viewed from the native Wrapper code. Does not have any effect when the JVM is not being controlled from the native Wrapper. Useful for testing the Wrapper functions.
java.lang.IllegalStateException - If testing methods have been disabled by setting the wrapper.disable_tests=true system property.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.appearHung") permission.
(Testing Method) Causes the WrapperManager to go into a state which makes the JVM appear to be sluggish when viewed from the native Wrapper code. Each packet received from the Wrapper is delayed by the specified number of seconds. If several packets are received in succession then this delay will be cumulative. The delay reported by the Wrapper may appear to be quite a bit different if multiple packets are being delayed in series. Some packets, like pings, which are sent multiple times may also be reported as being processed faster than this delay because the previous response is what is actually being received. Does not have any effect when the JVM is not being controlled from the native Wrapper. Useful for testing the Wrapper functions.
slowSeconds - The number of seconds to delay reponding to any incoming commands from the wrapper.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.appearSlow") permission.
(Testing Method) Cause an access violation within the Java code. Useful for testing the Wrapper functions. This currently only crashes Sun JVMs and takes advantage of Bug #4369043 which does not exist in newer JVMs. Use of the accessViolationNative() method is preferred.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.accessViolation") permission.
(Testing Method) Cause an access violation within native JNI code. Useful for testing the Wrapper functions. This currently causes the access violation by attempting to write to a null pointer.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.accessViolationNative") permission.
(Testing Method) raise an exception in native code. Useful for testing the Wrapper functions. Ignored when not running on Windows.
code - Exception code to Raise.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.raiseExceptionNative") permission.
(Testing Method) raise a fail fast exception in native code. Useful for testing the Wrapper functions. Ignored when not running on Windows.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("test.raiseFailFastExceptionNative") permission.
Returns true if the JVM was launched by the Wrapper application. False if the JVM was launched manually without the Wrapper controlling it.
True if the current JVM was launched by the Wrapper.
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.
True if the Wrapper is running as an NT service or daemon process.
Returns true if the JVM should ignore user logoff events. Mainly used within WrapperListener.controlEvent() method implemenations.
True if user logoff events should be ignroed.
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.
True if the Wrapper is logging any Debug level output.
Start the Java side of the Wrapper code running. This will make it possible for the native side of the Wrapper to detect that the Java Wrapper is up and running.
This method must be called on startup and then can only be called once so there is no reason for any security permission checks on this call.
listener - The WrapperListener instance which represents the application being started.
args - The argument list passed to the JVM when it was launched.
Returns true if the JVM is in the process of shutting down. This can be useful to avoid starting long running processes when it is known that the JVM will be shutting down shortly.
true if the JVM is shutting down.
Increase the number of locks which will prevent the Wrapper from letting the JVM process exit on shutdown. This is primarily useful around calls to native JNI functions in daemon threads where it has been shown that premature JVM exits can cause the JVM process to crash on shutdown.
Normal non-daemon threads should not require these locks as the very fact that the non-daemon thread is still running will prevent the JVM from shutting down.
It is possible to make multiple calls within a single thread. Each call should always be paired with a call to releaseShutdownLock().
WrapperShuttingDownException - If called after the Wrapper has already begun the shutdown of the JVM.
java.lang.IllegalStateException - If called without first calling requestShutdownLock() from the same thread.
This method will not return.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("restart") permission.
This method requests that the JVM be restarted but then returns. This allows components to initiate a JVM exit and then continue, allowing a normal shutdown initiated by the JVM via shutdown hooks. In applications which are designed to be shutdown when the user presses CTRL-C, this may result in a cleaner shutdown.
exitCode - The exit code that the Wrapper will return when it exits.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("stop") permission.
This method requests that the JVM be shutdown but then returns. This allows components to initiate a JVM exit and then continue, allowing a normal shutdown initiated by the JVM via shutdown hooks. In applications which are designed to be shutdown when the user presses CTRL-C, this may result in a cleaner shutdown.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("stop" ) permission.
Tells the native wrapper that the JVM wants to shut down and then promptly halts. Be careful when using this method as an application will not be given a chance to shutdown cleanly.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("stopImmediate") permission.
Signal the native wrapper that the startup is progressing but that more time is needed. The current startup timeout will be extended if necessary so it will be at least 'waitHint' milliseconds in the future.
This call will have no effect if the current startup timeout is already more than 'waitHint' milliseconds in the future.
waitHint - Time in milliseconds to allow for the startup to complete.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("signalStarting") permission.
Signal the native wrapper that the shutdown is progressing but that more time is needed. The current shutdown timeout will be extended if necessary so it will be at least 'waitHint' milliseconds in the future.
This call will have no effect if the current shutdown timeout is already more than 'waitHint' milliseconds in the future.
waitHint - Time in milliseconds to allow for the shutdown to complete.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("signalStopping") permission.
This method should not normally be called by user code as it is called from within the stop and restart methods. However certain applications which stop the JVM may need to call this method to let the wrapper code know that the shutdown was intentional.
exitCode - The exit code.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("signalStopped") permission.
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.
True if the ShutdownHook for the JVM has already been triggered.
Requests that the Wrapper log a message at the specified log level. If the JVM is not being managed by the Wrapper then calls to this method will be ignored. This method has been optimized to ignore messages at a log level which will not be logged given the current log levels of the Wrapper.
Log messages will currently by trimmed by the Wrapper at 4k (4096 bytes).
Because of differences in the way console output is collected and messages logged via this method, it is expected that interspersed console and log messages will not be in the correct order in the resulting log file.
This method was added to allow simple logging to the wrapper.log file. This is not meant to be a full featured log file and should not be used as such. Please look into a logging package for most application logging.
logLevel - The level to log the message at can be one of WRAPPER_LOG_LEVEL_DEBUG, WRAPPER_LOG_LEVEL_INFO, WRAPPER_LOG_LEVEL_STATUS, WRAPPER_LOG_LEVEL_WARN, WRAPPER_LOG_LEVEL_ERROR, or WRAPPER_LOG_LEVEL_FATAL.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("log") permission.
Returns an array of all registered services. This method is only supported on Windows platforms which support services. Calling this method on other platforms will result in null being returned.
java.lang.SecurityException - If a SecurityManager has not been set in the JVM or if the calling code has not been granted the WrapperPermission "listServices" permission. A SecurityManager is required for this operation because this method makes it possible to learn a great deal about the state of the system.
Sends a service control code to the specified service. The state of the service should be tested on return. If the service was not currently running then the control code will not be sent.
The control code sent can be one of the system control codes: WrapperManager.SERVICE_CONTROL_CODE_START, WrapperManager.SERVICE_CONTROL_CODE_STOP, WrapperManager.SERVICE_CONTROL_CODE_PAUSE, WrapperManager.SERVICE_CONTROL_CODE_CONTINUE, or WrapperManager.SERVICE_CONTROL_CODE_INTERROGATE. In addition, user defined codes in the range 128-255 can also be sent.
serviceName - Name of the Windows service which will receive the control code.
controlCode - The actual control code to be sent. User defined control codes should be in the range 128-255.
A WrapperWin32Service containing the last known status of the service after sending the control code. This will be null if the currently platform is not a version of Windows which supports services.
WrapperServiceException - If there are any problems accessing the specified service.
java.lang.SecurityException - If a SecurityManager has not been set in the JVM or if the calling code has not been granted the WrapperServicePermission permission for the specified service and control code. A SecurityManager is required for this operation because this method makes it possible to control any service on the system, which is of course rather dangerous.
Adds a WrapperEventListener which will receive WrapperEvents. The specific events can be controlled using the mask parameter. This API was chosen to allow for additional events in the future. To avoid future compatibility problems, WrapperEventListeners should always test the class of an event before making use of it. This will avoid problems caused by new event classes added in future versions of the Wrapper. This method should only be called once for a given WrapperEventListener. Build up a single mask to receive events of multiple types.
listener - WrapperEventListener to be start receiving events.
mask - A mask specifying the event types that the listener is interrested in receiving. See the WrapperEventListener class for a full list of flags. A mask is created by combining multiple flags using the binary '|' OR operator.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the appropriate WrapperEventPermission(...) permission.
listener - WrapperEventListener to be stop receiving events.
java.lang.SecurityException - If a SecurityManager is present and the calling thread does not have the WrapperPermission("removeWrapperEventListener") permission.
Returns the Log file currently being used by the Wrapper. If log file rolling is enabled in the Wrapper then this file may change over time.
java.lang.IllegalStateException - If this method is called before the Wrapper instructs this class to start the user application.
The main comm runner thread. This will only be called when the Wrapper is controlling the JVM.