01: package org.tanukisoftware.wrapper.event;
02:
03: /*
04: * Copyright (c) 1999, 2006 Tanuki Software Inc.
05: *
06: * Permission is hereby granted, free of charge, to any person
07: * obtaining a copy of the Java Service Wrapper and associated
08: * documentation files (the "Software"), to deal in the Software
09: * without restriction, including without limitation the rights
10: * to use, copy, modify, merge, publish, distribute, sub-license,
11: * and/or sell copies of the Software, and to permit persons to
12: * whom the Software is furnished to do so, subject to the
13: * following conditions:
14: *
15: * The above copyright notice and this permission notice shall be
16: * included in all copies or substantial portions of the Software.
17: *
18: * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
20: * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21: * NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22: * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
23: * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24: * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25: * OTHER DEALINGS IN THE SOFTWARE.
26: */
27:
28: /**
29: * WrapperServiceControlEvents are used to notify the listener whenever a
30: * Service Control Event is received by the service. These events will
31: * only be fired on Windows platforms when the Wrapper is running as a
32: * service.
33: *
34: * <dl>
35: * <dt>WrapperManager.SERVICE_CONTROL_CODE_STOP (1)</dt>
36: * <dd>The service was requested to stop.</dd>
37: * <dt>WrapperManager.SERVICE_CONTROL_CODE_PAUSE (2)</dt>
38: * <dd>The system requested that the service be paused.</dd>
39: * <dt>WrapperManager.SERVICE_CONTROL_CODE_CONTINUE (3)</dt>
40: * <dd>The system requested that the paused service be resumed.</dd>
41: * <dt>WrapperManager.SERVICE_CONTROL_CODE_INTERROGATE (4)</dt>
42: * <dd>The service manager queried the service to make sure it is still alive.</dd>
43: * <dt>WrapperManager.SERVICE_CONTROL_CODE_SHUTDOWN (5)</dt>
44: * <dd>The system is shutting down.</dd>
45: * <dt>User code (128-255)</dt>
46: * <dd>User defined code.</dd>
47: * </dl>
48: *
49: * @author Leif Mortenson <leif@tanukisoftware.com>
50: */
51: public class WrapperServiceControlEvent extends WrapperServiceEvent {
52: /** The event code of the Service Control Code. */
53: private int m_serviceControlCode;
54:
55: /*---------------------------------------------------------------
56: * Constructors
57: *-------------------------------------------------------------*/
58: /**
59: * Creates a new WrapperServiceControlEvent.
60: *
61: * @param serviceControlCode Service Control Code.
62: */
63: public WrapperServiceControlEvent(int serviceControlCode) {
64: m_serviceControlCode = serviceControlCode;
65: }
66:
67: /*---------------------------------------------------------------
68: * Methods
69: *-------------------------------------------------------------*/
70: /**
71: * Returns the event code of the Service Control Code.
72: *
73: * @return The event code of the Service Control Code.
74: */
75: public int getServiceControlCode() {
76: return m_serviceControlCode;
77: }
78:
79: /**
80: * Returns a string representation of the event.
81: *
82: * @return A string representation of the event.
83: */
84: public String toString() {
85: return "WrapperServiceControlEvent[serviceControlCode="
86: + getServiceControlCode() + "]";
87: }
88: }
|