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 * Classes that implement this interface need initialization before 59 * they can work. 60 * 61 * These classes rely also on an <code>InitableBroker</code> that 62 * ensures that there is only one instance of the class in the system, 63 * and handles dependencies between <code>Initables</code>. 64 * 65 * @author <a href="mailto:burton@apache.org">Kevin Burton</a> 66 * @author <a href="mailto:krzewski@e-point.pl">Rafal Krzewski</a> 67 * @version $Id: Initable.java,v 1.1.1.1 2001/08/16 05:08:46 jvanzyl Exp $ 68 */ 69 public interface Initable 70 { 71 /*** 72 * Provides an Initable with a reference to the InitableBroker 73 * that instantiated this object, so that it can access other 74 * Initables. 75 * 76 * @param broker The InitableBroker that instantiated this object. 77 */ 78 public void setInitableBroker( InitableBroker broker ); 79 80 /*** 81 * Performs early initailization of an Initable 82 * 83 * During the startup of the system, different objects may be 84 * passed to your class using this method. It should ignore any 85 * objects that it doesn't need or understand. 86 * 87 * After the class changes its internal state so that getInit() 88 * returns true, this method will be called no more, and late 89 * initialization will not be performed. 90 * 91 * If your class relies on early initialization, and the object it 92 * expects was not received, you can use late initialization to 93 * throw an exception and complain. 94 * 95 * @param data An Object to use for initialization activities. 96 * @exception InitializationException, if initilaization of this 97 * class was not successful. 98 */ 99 public void init( Object data ) 100 throws InitializationException; 101 102 /*** 103 * Performs late initialization of an Initable. 104 * 105 * When your class is being requested from an InitableBroker, it 106 * will call getInit(), and if it returns false, this method will 107 * be invoked. 108 * 109 * @exception InitializationException, if initialization of this 110 * class was not successful. 111 */ 112 public void init( ) throws InitializationException; 113 114 /*** 115 * Returns an <code>Initable</code> to an uninitialized state. 116 * 117 * <p>This method must release all resources allocated by the 118 * <code>Initable</code> implementation, and resetting its internal state. 119 * You may chose to implement this operation or not. If you support 120 * this operation, getInit() should return false after successful 121 * shutdown of the service. 122 */ 123 public void shutdown( ); 124 125 /*** 126 * Returns initialization status of an Initable. 127 * 128 * @return Initialization status of an Initable. 129 */ 130 public boolean getInit( ); 131 }

This page was automatically generated by Maven