01: /*
02: * The contents of this file are subject to the terms of the Common Development
03: * and Distribution License (the License). You may not use this file except in
04: * compliance with the License.
05: *
06: * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
07: * or http://www.netbeans.org/cddl.txt.
08: *
09: * When distributing Covered Code, include this CDDL Header Notice in each file
10: * and include the License file at http://www.netbeans.org/cddl.txt.
11: * If applicable, add the following below the CDDL Header, with the fields
12: * enclosed by brackets [] replaced by your own identifying information:
13: * "Portions Copyrighted [year] [name of copyright owner]"
14: *
15: * The Original Software is NetBeans. The Initial Developer of the Original
16: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
17: * Microsystems, Inc. All Rights Reserved.
18: */
19:
20: /*
21: *
22: * Copyright 2005 Sun Microsystems, Inc.
23: *
24: * Licensed under the Apache License, Version 2.0 (the "License");
25: * you may not use this file except in compliance with the License.
26: * You may obtain a copy of the License at
27: *
28: * http://www.apache.org/licenses/LICENSE-2.0
29: *
30: * Unless required by applicable law or agreed to in writing, software
31: * distributed under the License is distributed on an "AS IS" BASIS,
32: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33: * See the License for the specific language governing permissions and
34: * limitations under the License.
35: *
36: */
37: package org.netbeans.modules.jdbcwizard.builder.dbmodel;
38:
39: /**
40: * Interface for defining specifications for a connection to a data source compatible with the
41: * DBQueryModel API.
42: *
43: * @author
44: */
45: public interface DBConnectionDefinition extends Cloneable {
46:
47: /**
48: * Get name defined for this DBConnectionDefinition.
49: *
50: * @return DBConnectionDefnition name
51: */
52: public String getName();
53:
54: /**
55: * Gets user-defined description, if any, for this DBConnectionDefinition.
56: *
57: * @return user-defined description, or null if none was defined
58: */
59: public String getDescription();
60:
61: /**
62: * Gets descriptive name, if any, of type of DB data source from which this metadata content was
63: * derived, e.g., "Oracle9" for an Oracle 9i database, etc. Returns null if content was derived
64: * from a non-DB source, such such as a flatfile.
65: *
66: * @return vendor name of source database; null if derived from non-DB source
67: */
68: public String getDBType();
69:
70: /**
71: * Gets URL used to reference and establish a connection to the data source referenced in this
72: * object.
73: *
74: * @return URL pointing to the data source
75: */
76: public String getConnectionURL();
77:
78: /**
79: * @return
80: */
81: public String getDriverClass();
82:
83: /**
84: * Gets username, if any, used in authenticating a connection to the data source referenced in
85: * this object.
86: *
87: * @return username, if any, used for authentication purposes
88: */
89: public String getUserName();
90:
91: /**
92: * Gets password, if any, used in authenticating a connection to the data source referenced in
93: * this object.
94: *
95: * @return password, if any, used for authentication purposes
96: */
97: public String getPassword();
98: }
|