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-2007 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: package org.netbeans.modules.sql.framework.model;
042:
043: import java.util.Properties;
044:
045: /**
046: * Interface for defining specifications for a connection to a data source compatible
047: * with the DatabaseModel API.
048: *
049: * @author Jonathan Giron, Sudhendra Seshachala
050: */
051: public interface DBConnectionDefinition extends Cloneable {
052:
053: /**
054: * Get name defined for this DBConnectionDefinition.
055: *
056: * @return DBConnectionDefnition name
057: */
058: public String getName();
059:
060: /**
061: * Gets user-defined description, if any, for this DBConnectionDefinition.
062: *
063: * @return user-defined description, or null if none was defined
064: */
065: public String getDescription();
066:
067: /**
068: * Gets fully-qualified class name of driver used to establish a connection
069: * to the data source referenced in this object
070: *
071: * @return fully-qualified driver class name
072: */
073: public String getDriverClass();
074:
075: /**
076: * Gets descriptive name, if any, of type of DB data source from which this
077: * metadata content was derived, e.g., "Oracle9" for an Oracle 9i database, etc.
078: * Returns null if content was derived from a non-DB source, such
079: * such as a flatfile.
080: *
081: * @return vendor name of source database; null if derived from non-DB source
082: */
083: public String getDBType();
084:
085: /**
086: * Gets URL used to reference and establish a connection to the data
087: * source referenced in this object.
088: *
089: * @return URL pointing to the data source
090: */
091: public String getConnectionURL();
092:
093: /**
094: * Gets username, if any, used in authenticating a connection to the
095: * data source referenced in this object.
096: *
097: * @return username, if any, used for authentication purposes
098: */
099: public String getUserName();
100:
101: /**
102: * Gets password, if any, used in authenticating a connection to the
103: * data source referenced in this object.
104: *
105: * @return password, if any, used for authentication purposes
106: */
107: public String getPassword();
108:
109: Properties getConnectionProperties();
110: }
|