ComponentInterface


1   /**
2    * C-JDBC: Clustered JDBC.
3    * Copyright (C) 2002-2004 French National Institute For Research In Computer
4    * Science And Control (INRIA).
5    * Contact: c-jdbc@objectweb.org
6    * 
7    * This library is free software; you can redistribute it and/or modify it
8    * under the terms of the GNU Lesser General Public License as published by the
9    * Free Software Foundation; either version 2.1 of the License, or any later
10   * version.
11   * 
12   * This library is distributed in the hope that it will be useful, but WITHOUT
13   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14   * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
15   * for more details.
16   * 
17   * You should have received a copy of the GNU Lesser General Public License
18   * along with this library; if not, write to the Free Software Foundation,
19   * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
20   *
21   * Initial developer(s): Nicolas Modrzyk.
22   * Contributor(s): ______________________.
23   */
24  
25  package org.objectweb.cjdbc.scenario.tools.components;
26  
27  /**
28   * This class defines a ComponentInterface. A instance of this class is started and managed
29   * by the ComponentManager.
30   * 
31   * @author <a HREF="mailto:Nicolas.Modrzyk@inrialpes.fr">Nicolas Modrzyk</a>
32   * @version 1.0
33   */
34  public interface ComponentInterface
35  {
36    /**
37     * Start this component
38     * 
39     * @throws Exception if could not start
40     */
41    void start() throws Exception  ;
42  
43    /**
44     * Returns the database value.
45     * 
46     * @return Returns the database.
47     */
48    String   getDatabase();
49  
50    /**
51     * Loads the data of the given file in the database  
52     * 
53     * @param file to load
54     * @throws Exception if fails
55     */
56    void loadDatabase(String   file) throws Exception  ;
57  
58    /**
59     * Loads a default file in the database
60     * 
61     * @throws Exception if fails
62     */
63    void loadDatabase() throws Exception  ;
64  
65    /**
66     * Loads the xml file with the given target database
67  
68     * @param xml file 
69     * @param targetDB target database
70     * @throws Exception if fails
71     */
72    void loadDatabase(String   xml, String   targetDB) throws Exception  ;
73  
74    /**
75     * Returns the port value.
76     * 
77     * @return Returns the port.
78     */
79    String   getPort();
80  
81    /**
82     * Returns the process value. 
83     * 
84     * @return Returns the process.
85     */
86    Object   getProcess();
87  
88    /**
89     * Remove files generated by this process
90     */
91    void release();
92  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags