1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.lib.ddl;
import java.sql.Connection;
import java.util.Properties;
/**
* Connection information.
* This interface defines information needed for connection to database
* (database and driver url, login name, password and schema name). It can create JDBC
* connection and feels to be a bean (has propertychange support and customizer).
* Instances of this class uses explorer option to store information about
* open connection.
*
* @author Slavek Psenicka, Radko Najman
*/
public interface DBConnection extends java.io.Serializable
{
/** Returns the name that is displayed for this connection. */
public String getDisplayName();
/** Set the name that is displayed for this connection. */
public void setDisplayName(String name);
/** Returns driver URL */
public String getDriver();
/** Sets driver URL
* Fires propertychange event.
* @param driver DNew driver URL
*/
public void setDriver(String driver);
/** Returns database URL */
public String getDatabase();
/** Sets database URL
* Fires propertychange event.
* @param database New database URL
*/
public void setDatabase(String database);
/** Returns user login name */
public String getUser();
/** Sets user login name
* Fires propertychange event.
* @param user New login name
*/
public void setUser(String user);
/** Returns schema name */
public String getSchema();
/** Sets schema name
* Fires propertychange event.
* @param schema Schema name
*/
public void setSchema(String schema);
/** Returns connection name */
public String getName();
/** Sets connection name
* Fires propertychange event.
* @param name Connection name
*/
public void setName(String name);
/** Returns driver name */
public String getDriverName();
/** Sets driver name
* Fires propertychange event.
* @param name Driver name
*/
public void setDriverName(String name);
/** Returns if password should be remembered */
public boolean rememberPassword();
/** Sets password should be remembered
* @param flag New flag
*/
public void setRememberPassword(boolean flag);
/** Returns password */
public String getPassword();
/** Sets password
* Fires propertychange event.
* @param password New password
*/
public void setPassword(String password);
/** Creates JDBC connection
* Uses DriverManager to create connection to specified database. Throws
* DDLException if none of driver/database/user/password is set or if
* driver or database does not exist or is inaccessible.
*/
public Connection createJDBCConnection() throws DDLException;
/**
* Set additional (besides "user" and "password") properties of the
* connection. Use {@link #setUser(String)} and {@link #setPassword(String)}
* for setting user and password.
*
* @param connectionProperties Additional connection properties.
*/
public void setConnectionProperties(Properties connectionProperties);
/**
* Get additional (besides "user" and "password") connection properties. Use
* {@link #getUser()} and {@link #getPassword()} to get user and password.
*
* @return Object containing additional connection properties, or null if it
* is not available.
*/
public Properties getConnectionProperties();
}
|
