View Javadoc
1 package org.apache.turbine.services; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 /*** 58 * This class provides a generic implementation of 59 * <code>Initable</code>. This implementation, that other 60 * <code>Initables</code> are welcome to extend, contains facilities 61 * to maintain internal state. 62 * 63 * @author <a href="mailto:burton@apache.org">Kevin Burton</a> 64 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a> 65 * @version $Id: BaseInitable.java,v 1.1.1.1 2001/08/16 05:08:45 jvanzyl Exp $ 66 */ 67 public class BaseInitable 68 implements Initable 69 { 70 /*** InitableBroker that instantiatd this class. */ 71 protected InitableBroker initableBroker; 72 73 /*** Initialization status of this class. */ 74 protected boolean isInitialized = false; 75 76 /*** 77 * Default constructor of BaseInitable. 78 * 79 * This constructor does nothing. Your own constructurs should be 80 * modest in allocating memory and other resources, leaving this 81 * to the <code>init()</code> method. 82 */ 83 public BaseInitable() 84 { 85 } 86 87 /*** 88 * Saves InitableBroker reference for later use. 89 * 90 * @param broker The InitableBroker that instantiated this object. 91 */ 92 public void setInitableBroker( InitableBroker broker ) 93 { 94 this.initableBroker = broker; 95 } 96 97 /*** 98 * Returns an InitableBroker reference. 99 * 100 * @return The InitableBroker that instantiated this object. 101 */ 102 public InitableBroker getInitableBroker() 103 { 104 return initableBroker; 105 } 106 107 /*** 108 * Performs early initialization. Used in a manner similar to a ctor. 109 * 110 * BaseInitable doesn't need early initialization, therefore it 111 * ignores all objects passed to it and performs no initialization 112 * activities. 113 * 114 * @param data An Object to use for initialization activities. 115 * @exception InitializationException Initialization of this 116 * class was not successful. 117 */ 118 public void init( Object data ) throws InitializationException 119 { 120 } 121 122 /*** 123 * Performs late initializtion. Called when the Service is requested 124 * for the first time (if not already completely initialized by the 125 * early initializer). 126 * 127 * Late intialization of a BaseInitable is alwas successful. 128 * 129 * @exception InitializationException Initialization of this 130 * class was not successful. 131 */ 132 public void init() throws InitializationException 133 { 134 } 135 136 /*** 137 * Returns an Initable to uninitialized state. 138 * 139 * Calls setInit(flase) to mark that we are no longer in initialized 140 * state. 141 */ 142 public void shutdown() 143 { 144 setInit(false); 145 } 146 147 148 /*** 149 * Returns initialization status. 150 * 151 * @return True if the initable is initialized. 152 */ 153 public boolean getInit() 154 { 155 return isInitialized; 156 } 157 158 /*** 159 * Sets initailization status. 160 * 161 * @param value The new initialization status. 162 */ 163 protected void setInit( boolean value ) 164 { 165 this.isInitialized = value; 166 } 167 }

This page was automatically generated by Maven