KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > mule > umo > lifecycle > Initialisable


1 /*
2  * $Id: Initialisable.java 3798 2006-11-04 04:07:14Z aperepel $
3  * --------------------------------------------------------------------------------------
4  * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
5  *
6  * The software in this package is published under the terms of the MuleSource MPL
7  * license, a copy of which has been included with this distribution in the
8  * LICENSE.txt file.
9  */
10
11 package org.mule.umo.lifecycle;
12
13 /**
14  * <code>Initialisable</code> is a lifecycle interface that gets called at the
15  * initialise lifecycle stage of the implementing component.
16  *
17  * @author <a HREF="mailto:ross.mason@symphonysoft.com">Ross Mason</a>
18  * @version $Revision: 3798 $
19  */
20 public interface Initialisable
21 {
22     /**
23      * Method used to perform any initialisation work. If a fatal error occurs during
24      * initialisation an <code>InitialisationException</code> should be thrown,
25      * causing the Mule instance to shutdown. If the error is recoverable, say by
26      * retrying to connect, a <code>RecoverableException</code> should be thrown.
27      * There is no guarantee that by throwing a Recoverable exception that the Mule
28      * instance will not shut down.
29      *
30      * @throws InitialisationException if a fatal error occurs causing the Mule
31      * instance to shutdown
32      * @throws RecoverableException if an error occurs that can be recovered from
33      */
34     void initialise() throws InitialisationException, RecoverableException;
35 }
36
Popular Tags