blob: d16a7e8d41ea08c27c0055d6b2f9df1c8afd5e09 (
plain) (
blame)
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*******************************************************************************
* Copyright (c) 2008, 2009 Oracle. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0, which accompanies this distribution
* and is available at http://www.eclipse.org/legal/epl-v10.html.
*
* Contributors:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.db;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.datatools.connectivity.drivers.jdbc.IJDBCDriverDefinitionConstants;
/**
* Database connection profile
* <p>
* Provisional API: This interface is part of an interim API that is still
* under development and expected to change significantly before reaching
* stability. It is available at this early stage to solicit feedback from
* pioneering adopters on the understanding that any code that uses this API
* will almost certainly be broken (repeatedly) as the API evolves.
*/
public interface ConnectionProfile extends DatabaseObject {
// ********** properties **********
/**
* Return the connection profile's database.
* Return null if the connection profile is inactive.
*/
Database getDatabase();
/**
* Return ID of the provider managing the DTP profile.
*/
String getProviderID();
/**
* Return the connection profile's static ID.
*/
String getInstanceID();
/**
* Return the default database name.
*/
String getDatabaseName();
/**
* Return the database product name.
*/
String getDatabaseProduct();
/**
* Return the database vendor.
*/
String getDatabaseVendor();
/**
* Return the database version.
*/
String getDatabaseVersion();
/**
* Return the driver class name.
*/
String getDriverClassName();
/**
* Return the default connection URL.
*/
String getURL();
/**
* Return the default user name.
*/
String getUserName();
/**
* Return the default user password.
*/
String getUserPassword();
/**
* Return the ID of the associated Driver definition.
*/
String getDriverDefinitionID();
/**
* Return the jar list for the associated Driver as a
* comma-delimited string.
*/
String getDriverJarList();
/**
* Return the name of the associated Driver definition.
*/
String getDriverName();
// ********** connection **********
/**
* Return whether the profile is either connected to a live database
* session or working off-line (i.e. it has access to meta-data).
* @see isConnected()
* @see isWorkingOffline()
*/
boolean isActive();
/**
* Return whether the profile is neither connected to a live database
* session nor working off-line (i.e. it has access to meta-data).
* @see isActive()
*/
boolean isInactive();
/**
* Return whether the profile is connected to a live database session
* (i.e. the meta-data comes from the database), as opposed to working
* off-line.
* @see #isActive()
*/
boolean isConnected();
/**
* Return whether the profile is not connected to a live database session
* (i.e. the meta-data comes from the database), as opposed to working
* off-line.
* @see #isConnected()
*/
boolean isDisconnected();
/**
* Connect to the database.
* @see #disconnect()
*/
void connect();
/**
* Disconnect from the database.
* @see #connect()
*/
void disconnect();
// ********** off-line support **********
/**
* Return whether the profile is working off-line (i.e. the meta-data
* comes from a local cache), as opposed to connected to a live
* database session.
* @see #isActive()
*/
boolean isWorkingOffline();
/**
* Return whether the connection factories associated with the
* connection profile's provider support working offline.
*/
boolean supportsWorkOfflineMode();
/**
* Save the state of the connection profile for working in an offline mode.
* If the connection profile does not support working in an offline mode, no
* exception is thrown and the method will return immediately.
*/
IStatus saveWorkOfflineData();
/**
* Return whether the connection profile supports working offline and data
* has been saved for working offline.
*/
boolean canWorkOffline();
/**
* Begin working off-line.
*/
IStatus workOffline();
// ********** listeners **********
/**
* Add the specified connection listener to the connection profile.
*/
void addConnectionListener(ConnectionListener listener);
/**
* Remove the specified connection listener from the connection profile.
*/
void removeConnectionListener(ConnectionListener listener);
// ********** constants **********
String CONNECTION_PROFILE_TYPE = "org.eclipse.datatools.connectivity.db.generic.connectionProfile"; //$NON-NLS-1$
String DRIVER_DEFINITION_PROP_ID = "org.eclipse.datatools.connectivity.driverDefinitionID"; //$NON-NLS-1$
String DRIVER_DEFINITION_TYPE_PROP_ID = "org.eclipse.datatools.connectivity.drivers.defnType"; //$NON-NLS-1$
String DRIVER_JAR_LIST_PROP_ID = "jarList"; //$NON-NLS-1$
String DATABASE_SAVE_PWD_PROP_ID = IJDBCDriverDefinitionConstants.PROP_PREFIX + "savePWD"; //$NON-NLS-1$
}
|
