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 Initializable interface is used by components that need to allocate resources prior to them becoming active.
    22   *
    23   * @author <a href="mailto:fede@apache.org">Federico Barbieri</a>
    24   * @author <a href="mailto:pier@apache.org">Pierpaolo Fumagalli</a>
    25   * @author <a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>
    26   * @author <a href="mailto:donaldp@apache.org">Peter Donald</a>
    27   * @version $Id: Initializable.java 264191 2005-08-29 18:07:52Z henning $
    28   */
    29  public interface Initializable
    30  {
    31      /***
    32       * Initialialize the component. Initialization includes allocating any resources required throughout the components lifecycle.
    33       *
    34       * @exception Exception if an error occurs
    35       */
    36      void initialize()
    37              throws Exception;
    38  }