001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.spi.db.explorer;
043:
044: /**
045: * Represents an instance of a database server, typically a local installation which can be
046: * started when a connection to this server is being made, or stopped upon IDE shutdown.
047: *
048: * <p>Implementations of this class should be put in the Databases/Runtimes folder
049: * in the default filesystem.</p>
050: *
051: * @author Nam Nguyen, Andrei Badea
052: */
053: public interface DatabaseRuntime {
054:
055: /**
056: * Returns the JDBC driver class which is used to make connections to the
057: * represented database server instance.
058: *
059: * <p>When a connection is being made, only the database runtimes which have
060: * the same JDBC driver as the driver used by this connection are considered
061: * for further usage (e.g., starting the database server instance).</p>
062: *
063: * @return the fully-qualified class name of the driver used to make
064: * connections to the represented database server instance.
065: */
066: public String getJDBCDriverClass();
067:
068: /**
069: * Returns whether this runtime accepts this database URL (the database URL
070: * would cause a connection to be made to the database server instance
071: * represented by this runtime).
072: *
073: * @param url the database URL
074: *
075: * @return true if the runtime accepts this database URL; false otherwise.
076: */
077: boolean acceptsDatabaseURL(String url);
078:
079: /**
080: * Returns the state (running/not running) of the represented database server
081: * instance.
082: *
083: * @return true if the database server instance is running; false otherwise.
084: */
085: boolean isRunning();
086:
087: /**
088: * Returns whether the database server instance can be started by a call to the
089: * {@link #start} method.
090: *
091: * @return true if the database server instance can be started; false
092: * otherwise.
093: */
094: public boolean canStart();
095:
096: /**
097: * Starts the database server instance represented by this runtime.
098: */
099: void start();
100:
101: /**
102: * Stops the database server instance represented by this runtime.
103: */
104: void stop();
105: }
|