001/* A interface for modules to start and stop HSQL servers.
002 * 
003 * Copyright (c) 2011 The Regents of the University of California.
004 * All rights reserved.
005 *
006 * '$Author: crawl $'
007 * '$Date: 2011-08-05 17:43:01 +0000 (Fri, 05 Aug 2011) $' 
008 * '$Revision: 28216 $'
009 * 
010 * Permission is hereby granted, without written agreement and without
011 * license or royalty fees, to use, copy, modify, and distribute this
012 * software and its documentation for any purpose, provided that the above
013 * copyright notice and the following two paragraphs appear in all copies
014 * of this software.
015 *
016 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
017 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
018 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
019 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
020 * SUCH DAMAGE.
021 *
022 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
023 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
024 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
025 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
026 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
027 * ENHANCEMENTS, OR MODIFICATIONS.
028 *
029 */
030package org.kepler.module;
031
032/** An interface for modules to start and stop HSQL servers. 
033 * 
034 *  If -hsql [start|stop] is specified on the command line,
035 *  org.kepler.Kepler uses this interface to control HSQL
036 *  servers managed by each module in modules.txt.
037 *  <b>NOTE: The name of the class implementing this interface
038 *  must be called org.kepler.module.NNN.HSQLManager, where NNN
039 *  is the name of the module.</b>
040 *
041 *  @author Daniel Crawl
042 *  @version $Id: ModuleHSQLManager.java 28216 2011-08-05 17:43:01Z crawl $
043 */
044
045public interface ModuleHSQLManager
046{
047    /** Start HSQL servers in a separate process. */
048    public void start();
049    
050    /** Stop HSQL servers in a separate process. */
051    public void stop();
052}