| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Lifecycle |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * | |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. | |
| 4 | * | |
| 5 | * Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved. | |
| 6 | * | |
| 7 | * The contents of this file are subject to the terms of either the GNU | |
| 8 | * General Public License Version 2 only ("GPL") or the Common Development | |
| 9 | * and Distribution License("CDDL") (collectively, the "License"). You | |
| 10 | * may not use this file except in compliance with the License. You can obtain | |
| 11 | * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html | |
| 12 | * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific | |
| 13 | * language governing permissions and limitations under the License. | |
| 14 | * | |
| 15 | * When distributing the software, include this License Header Notice in each | |
| 16 | * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. | |
| 17 | * Sun designates this particular file as subject to the "Classpath" exception | |
| 18 | * as provided by Sun in the GPL Version 2 section of the License file that | |
| 19 | * accompanied this code. If applicable, add the following below the License | |
| 20 | * Header, with the fields enclosed by brackets [] replaced by your own | |
| 21 | * identifying information: "Portions Copyrighted [year] | |
| 22 | * [name of copyright owner]" | |
| 23 | * | |
| 24 | * Contributor(s): | |
| 25 | * | |
| 26 | * If you wish your version of this file to be governed by only the CDDL or | |
| 27 | * only the GPL Version 2, indicate your decision by adding "[Contributor] | |
| 28 | * elects to include this software in this distribution under the [CDDL or GPL | |
| 29 | * Version 2] license." If you don't indicate a single choice of license, a | |
| 30 | * recipient has the option to distribute your version of this file under | |
| 31 | * either the CDDL, the GPL Version 2 or to extend the choice of license to | |
| 32 | * its licensees as provided above. However, if you add GPL Version 2 code | |
| 33 | * and therefore, elected the GPL Version 2 license, then the option applies | |
| 34 | * only if the new code is made subject to such option by the copyright | |
| 35 | * holder. | |
| 36 | * | |
| 37 | */ | |
| 38 | package com.sun.grizzly; | |
| 39 | ||
| 40 | import java.io.IOException; | |
| 41 | ||
| 42 | /** | |
| 43 | * Simple Life cycle interface used to manage Grizzly component. | |
| 44 | * | |
| 45 | * @author Jeanfrancois Arcand | |
| 46 | */ | |
| 47 | public interface Lifecycle { | |
| 48 | ||
| 49 | /** | |
| 50 | * Start the Lifecycle. This is the interface where an object that | |
| 51 | * implements Lifecycle will start the object and begin its processing. | |
| 52 | * @throws java.io.IOException | |
| 53 | */ | |
| 54 | public void start() throws IOException; | |
| 55 | ||
| 56 | /** | |
| 57 | * Stops the Lifecycle. This is the interface where an object that | |
| 58 | * implements Lifecycle will stop the object's processing and perform | |
| 59 | * any additional cleanup before it shutdown. | |
| 60 | * @throws java.io.IOException | |
| 61 | */ | |
| 62 | public void stop() throws IOException; | |
| 63 | ||
| 64 | /** | |
| 65 | * Pause this Lifecycle. This is the interface where an object that | |
| 66 | * implements Lifecycle will pause the object's processing. Processing | |
| 67 | * may be resumed via the resume() interface or stopped via the stop() | |
| 68 | * interface after this interface has been called. Common uses for pause() | |
| 69 | * and resume() will be to support use cases such as reconfiguration. | |
| 70 | * @throws java.io.IOException | |
| 71 | */ | |
| 72 | public void pause() throws IOException; | |
| 73 | ||
| 74 | /** | |
| 75 | * Resume this Lifecycle. This is the interface where an object that | |
| 76 | * implements Lifecycle will resume a paused object's processing. When | |
| 77 | * called processing will resume. Common uses for pause() and resume() | |
| 78 | * will be to support use cases such as reconfiguration. | |
| 79 | * @throws java.io.IOException | |
| 80 | */ | |
| 81 | public void resume() throws IOException; | |
| 82 | ||
| 83 | } |