KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > service > BasicService


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999-2004 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: BasicService.java,v 1.1 2004/11/26 01:51:01 tanderson Exp $
44  */
45
46 package org.exolab.jms.service;
47
48 import org.apache.commons.logging.LogFactory;
49 import org.apache.commons.logging.Log;
50
51
52 /**
53  * BasicService is a service implementation that will run the service in a
54  * separate thread. Derived class must define an implementation for the 'run'
55  * method.
56  *
57  * @version $Revision: 1.1 $ $Date: 2004/11/26 01:51:01 $
58  * @author <a HREF="mailto:jima@comware.com.au">Jim Alateras</a>
59  * @see Service
60  */
61 public abstract class BasicService extends Service implements Runnable JavaDoc {
62
63     /**
64      * The service thread
65      */
66     private transient Thread JavaDoc _thread = null;
67
68     /**
69      * The default constructor for the BasicService does nothing.
70      */
71     protected BasicService() {
72     }
73
74     /**
75      * Instantiates a service with the specified name
76      *
77      * @param name the unique name of the service
78      */
79     protected BasicService(String JavaDoc name) {
80         super(name);
81     }
82
83     /**
84      * Start the service.
85      *
86      * @throws ServiceException if the service fails to start, or is already
87      * running
88      */
89     public synchronized void start() throws ServiceException {
90         super.start();
91         _thread = new Thread JavaDoc(this, getName());
92         _thread.start();
93     }
94
95     /**
96      * Stop the service.
97      *
98      * @throws ServiceException if the service fails to stop, or is already
99      * stopped
100      */
101     public synchronized void stop() throws ServiceException {
102         if (_thread != null) {
103             setState(ServiceState.STOPPED);
104             _thread.interrupt();
105             _thread = null;
106         } else {
107             throw new ServiceException("Failed to stop service " + this);
108         }
109     }
110
111     /**
112      * Return the state of the object as a string
113      *
114      * @return a string form of the object state
115      */
116     public String JavaDoc toString() {
117         StringBuffer JavaDoc buf = new StringBuffer JavaDoc("BasicService:[");
118         buf.append("name=");
119         buf.append(getName());
120         buf.append("thread=");
121         buf.append(_thread);
122         buf.append("state=");
123         buf.append(getState());
124         buf.append("]");
125         return buf.toString();
126     }
127     
128 }
129
Popular Tags