View Javadoc

1   package org.apache.stratum.lifecycle;
2   
3   /*
4    * Copyright 2001-2005 The Apache Software Foundation or its licensors,
5    * as applicable.
6    *
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  /***
21   * The Startable interface is used when components need to be "running" to be active. It provides a method through which components
22   * can be "started" and "stopped" without requiring a thread. Note that these methods should start the component but return
23   * imediately.
24   *
25   * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
26   * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
27   */
28  public interface Startable
29  {
30      /***
31       * Starts the component.
32       *
33       * @exception Exception if Component can not be started
34       */
35      void start()
36              throws Exception;
37  
38      /***
39       * Stops the component.
40       *
41       * @exception Exception if the Component can not be Stopped.
42       */
43      void stop()
44              throws Exception;
45  }