public class WrapperControlEvent extends WrapperEvent
The Wrapper will send this event to any registered listeners first, then it will pass the control code to the WrapperListener.controlEvent method. If the consume method is called, it will still be passed to other WrapperEventListeners, but will not be passed to the WrapperListener.controlEvent method. Other WrapperEventListeners should check the isConsumed method to decide whether or not the even has already been handled.
If the wrapper.ignore_signals property is set to true then the event will still be fired, but its isConsumed() method will return true initially.
Possible values are:
Constructor and Description |
---|
WrapperControlEvent(int controlEvent,
java.lang.String controlEventName)
Creates a new WrapperControlEvent.
|
Modifier and Type | Method and Description |
---|---|
void |
consume()
Mark the event as consumed.
|
int |
getControlEvent()
Returns the system control event.
|
java.lang.String |
getControlEventName()
Returns the name of the control event.
|
long |
getFlags()
Returns a set of event flags for which the event should be fired.
|
boolean |
isConsumed()
Returns true if the event has been consumed.
|
java.lang.String |
toString()
Returns a string representation of the event.
|
public WrapperControlEvent(int controlEvent, java.lang.String controlEventName)
controlEvent
- Service control event.controlEventName
- The name of the event.public long getFlags()
If a subclassed, the return value of the super class should usually be ORed with any additional flags.
getFlags
in class WrapperEvent
public int getControlEvent()
Possible values are: WrapperManager.WRAPPER_CTRL_C_EVENT, WRAPPER_CTRL_CLOSE_EVENT, WRAPPER_CTRL_LOGOFF_EVENT, WRAPPER_CTRL_SHUTDOWN_EVENT, WRAPPER_CTRL_TERM_EVENT, or WRAPPER_CTRL_HUP_EVENT.
public java.lang.String getControlEventName()
public void consume()
On Windows, some events are sent both to the JVM and Wrapper processes. Event if the CTRL-C event is ignored within the JVM, the Wrapper process may still initiate a shutdown.
public boolean isConsumed()
public java.lang.String toString()
toString
in class java.util.EventObject