KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > tanukisoftware > wrapper > event > WrapperServiceControlEvent


1 package org.tanukisoftware.wrapper.event;
2
3 /*
4  * Copyright (c) 1999, 2006 Tanuki Software Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of the Java Service Wrapper and associated
8  * documentation files (the "Software"), to deal in the Software
9  * 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
52     extends WrapperServiceEvent
53 {
54     /** The event code of the Service Control Code. */
55     private int m_serviceControlCode;
56     
57     /*---------------------------------------------------------------
58      * Constructors
59      *-------------------------------------------------------------*/
60     /**
61      * Creates a new WrapperServiceControlEvent.
62      *
63      * @param serviceControlCode Service Control Code.
64      */
65     public WrapperServiceControlEvent( int serviceControlCode )
66     {
67         m_serviceControlCode = serviceControlCode;
68     }
69     
70     /*---------------------------------------------------------------
71      * Methods
72      *-------------------------------------------------------------*/
73     /**
74      * Returns the event code of the Service Control Code.
75      *
76      * @return The event code of the Service Control Code.
77      */
78     public int getServiceControlCode()
79     {
80         return m_serviceControlCode;
81     }
82     
83     /**
84      * Returns a string representation of the event.
85      *
86      * @return A string representation of the event.
87      */
88     public String JavaDoc toString()
89     {
90         return "WrapperServiceControlEvent[serviceControlCode=" + getServiceControlCode() + "]";
91     }
92 }
93
Popular Tags