KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > kernel > Installable


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.kernel;
65
66 import com.jcorporate.expresso.kernel.exception.InstallationException;
67
68 /**
69  * This interface represents a component that needs to perform install/uninstall
70  * work other than recieve straight configuration values. An example of this is a
71  * Schema. All Schemas are installable, for example, because tables need to be created,
72  * default security set up, etc. And these tables may need to be removed upon
73  * uninstallation
74  *
75  * @author Michael Rimov
76  * @since Expresso 5.1
77  */
78
79 public interface Installable {
80
81     /**
82      * Called when the Service Manager installs this component
83      *
84      * @param log A 'log4j-like' interface that allows you to output progress
85      * in the form of warnings, errors, info messages etc. The underlying implementation
86      * is often not log4j.
87      */
88     public void install(InstallationOptions installOptions, InstallLog log) throws InstallationException;
89
90     /**
91      * Called when the Service Manager uninstalls this component
92      *
93      * @param uninstallLog A 'log4j-like' interface that allows you to output progress
94      * in the form of warnings, errors, info messages etc. The underlying implementation
95      * is often not log4j.
96      */
97     public void uninstall(InstallationOptions installOptions, InstallLog uninstallLog) throws InstallationException;
98
99
100     /**
101      * This method is used to query the object for any Installation Options.
102      * The implementing component may return null if there are no special options
103      * for the job.
104      *
105      * @return Created and filled out installation objects or null;
106      */
107     public InstallationOptions getInstallationOptions();
108
109
110     /**
111      * This method is used to query the Installable object for any uninstallation
112      * options. The implementing component may return null if there are no
113      * special options for the job. Although the 'type' returned is the same, as
114      * getInstallOptions(), obviously, their contents are not the same. :)
115      *
116      * @return Created and filled out InstallationOptions object or null;
117      */
118     public InstallationOptions getUninstallOptions();
119 }
Popular Tags