franta-hg@16
|
1 |
/**
|
franta-hg@16
|
2 |
* SQL-DK
|
franta-hg@16
|
3 |
* Copyright © 2013 František Kučera (frantovo.cz)
|
franta-hg@16
|
4 |
*
|
franta-hg@16
|
5 |
* This program is free software: you can redistribute it and/or modify
|
franta-hg@16
|
6 |
* it under the terms of the GNU General Public License as published by
|
franta-hg@16
|
7 |
* the Free Software Foundation, either version 3 of the License, or
|
franta-hg@16
|
8 |
* (at your option) any later version.
|
franta-hg@16
|
9 |
*
|
franta-hg@16
|
10 |
* This program is distributed in the hope that it will be useful,
|
franta-hg@16
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
franta-hg@16
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
franta-hg@16
|
13 |
* GNU General Public License for more details.
|
franta-hg@16
|
14 |
*
|
franta-hg@16
|
15 |
* You should have received a copy of the GNU General Public License
|
franta-hg@16
|
16 |
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
franta-hg@16
|
17 |
*/
|
franta-hg@14
|
18 |
package info.globalcode.sql.dk;
|
franta-hg@14
|
19 |
|
franta-hg@203
|
20 |
import info.globalcode.sql.dk.configuration.CommandArgument;
|
franta-hg@67
|
21 |
import info.globalcode.sql.dk.configuration.Configuration;
|
franta-hg@65
|
22 |
import info.globalcode.sql.dk.configuration.ConfigurationException;
|
franta-hg@26
|
23 |
import info.globalcode.sql.dk.configuration.ConfigurationProvider;
|
franta-hg@65
|
24 |
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
|
franta-hg@67
|
25 |
import info.globalcode.sql.dk.configuration.FormatterDefinition;
|
franta-hg@160
|
26 |
import info.globalcode.sql.dk.configuration.Properties;
|
franta-hg@159
|
27 |
import info.globalcode.sql.dk.configuration.Property;
|
franta-hg@203
|
28 |
import info.globalcode.sql.dk.configuration.TunnelDefinition;
|
franta-hg@69
|
29 |
import info.globalcode.sql.dk.formatting.ColumnsHeader;
|
franta-hg@159
|
30 |
import info.globalcode.sql.dk.formatting.FakeSqlArray;
|
franta-hg@69
|
31 |
import info.globalcode.sql.dk.formatting.Formatter;
|
franta-hg@69
|
32 |
import info.globalcode.sql.dk.formatting.FormatterContext;
|
franta-hg@69
|
33 |
import info.globalcode.sql.dk.formatting.FormatterException;
|
franta-hg@17
|
34 |
import java.io.BufferedReader;
|
franta-hg@160
|
35 |
import java.io.ByteArrayOutputStream;
|
franta-hg@17
|
36 |
import java.io.InputStreamReader;
|
franta-hg@14
|
37 |
import java.io.PrintStream;
|
franta-hg@159
|
38 |
import java.sql.Array;
|
franta-hg@158
|
39 |
import java.sql.Driver;
|
franta-hg@196
|
40 |
import java.sql.DriverManager;
|
franta-hg@159
|
41 |
import java.sql.DriverPropertyInfo;
|
franta-hg@65
|
42 |
import java.sql.SQLException;
|
franta-hg@70
|
43 |
import java.util.ArrayList;
|
franta-hg@201
|
44 |
import java.util.Collections;
|
franta-hg@201
|
45 |
import java.util.Comparator;
|
franta-hg@70
|
46 |
import java.util.EnumSet;
|
franta-hg@159
|
47 |
import java.util.HashSet;
|
franta-hg@66
|
48 |
import java.util.List;
|
franta-hg@200
|
49 |
import java.util.Map.Entry;
|
franta-hg@158
|
50 |
import java.util.ServiceLoader;
|
franta-hg@159
|
51 |
import java.util.Set;
|
franta-hg@183
|
52 |
import java.util.concurrent.ExecutorService;
|
franta-hg@183
|
53 |
import java.util.concurrent.Executors;
|
franta-hg@183
|
54 |
import java.util.concurrent.TimeUnit;
|
franta-hg@17
|
55 |
import java.util.logging.Level;
|
franta-hg@196
|
56 |
import java.util.logging.LogRecord;
|
franta-hg@17
|
57 |
import java.util.logging.Logger;
|
franta-hg@69
|
58 |
import javax.sql.rowset.RowSetMetaDataImpl;
|
franta-hg@14
|
59 |
|
franta-hg@14
|
60 |
/**
|
franta-hg@14
|
61 |
* Displays info like help, version etc.
|
franta-hg@14
|
62 |
*
|
franta-hg@14
|
63 |
* @author Ing. František Kučera (frantovo.cz)
|
franta-hg@14
|
64 |
*/
|
franta-hg@14
|
65 |
public class InfoLister {
|
franta-hg@14
|
66 |
|
franta-hg@17
|
67 |
private static final Logger log = Logger.getLogger(InfoLister.class.getName());
|
franta-hg@159
|
68 |
/**
|
franta-hg@159
|
69 |
* Fake database name for output formatting
|
franta-hg@159
|
70 |
*/
|
franta-hg@159
|
71 |
public static final String CONFIG_DB_NAME = "sqldk_configuration";
|
franta-hg@183
|
72 |
private final PrintStream out;
|
franta-hg@183
|
73 |
private final ConfigurationProvider configurationProvider;
|
franta-hg@183
|
74 |
private final CLIOptions options;
|
franta-hg@70
|
75 |
private Formatter formatter;
|
franta-hg@17
|
76 |
|
franta-hg@69
|
77 |
public InfoLister(PrintStream out, ConfigurationProvider configurationProvider, CLIOptions options) {
|
franta-hg@17
|
78 |
this.out = out;
|
franta-hg@20
|
79 |
this.configurationProvider = configurationProvider;
|
franta-hg@69
|
80 |
this.options = options;
|
franta-hg@17
|
81 |
}
|
franta-hg@17
|
82 |
|
franta-hg@70
|
83 |
public void showInfo() throws ConfigurationException, FormatterException {
|
franta-hg@70
|
84 |
EnumSet<InfoType> commands = options.getShowInfo();
|
franta-hg@70
|
85 |
|
franta-hg@139
|
86 |
boolean formattinNeeded = false;
|
franta-hg@139
|
87 |
|
franta-hg@70
|
88 |
for (InfoType infoType : commands) {
|
franta-hg@70
|
89 |
switch (infoType) {
|
franta-hg@70
|
90 |
case CONNECTION:
|
franta-hg@158
|
91 |
case JDBC_DRIVERS:
|
franta-hg@159
|
92 |
case JDBC_PROPERTIES:
|
franta-hg@70
|
93 |
case DATABASES:
|
franta-hg@70
|
94 |
case FORMATTERS:
|
franta-hg@70
|
95 |
case TYPES:
|
franta-hg@200
|
96 |
case JAVA_PROPERTIES:
|
franta-hg@200
|
97 |
case ENVIRONMENT_VARIABLES:
|
franta-hg@139
|
98 |
formattinNeeded = true;
|
franta-hg@101
|
99 |
break;
|
franta-hg@70
|
100 |
}
|
franta-hg@70
|
101 |
}
|
franta-hg@139
|
102 |
|
franta-hg@139
|
103 |
if (formattinNeeded) {
|
franta-hg@139
|
104 |
try (Formatter f = getFormatter()) {
|
franta-hg@139
|
105 |
formatter = f;
|
franta-hg@139
|
106 |
formatter.writeStartBatch();
|
franta-hg@159
|
107 |
DatabaseDefinition dd = new DatabaseDefinition();
|
franta-hg@159
|
108 |
dd.setName(CONFIG_DB_NAME);
|
franta-hg@159
|
109 |
formatter.writeStartDatabase(dd);
|
franta-hg@139
|
110 |
showInfos(commands);
|
franta-hg@139
|
111 |
formatter.writeEndDatabase();
|
franta-hg@139
|
112 |
formatter.writeEndBatch();
|
franta-hg@139
|
113 |
formatter.close();
|
franta-hg@139
|
114 |
}
|
franta-hg@139
|
115 |
} else {
|
franta-hg@139
|
116 |
showInfos(commands);
|
franta-hg@139
|
117 |
}
|
franta-hg@101
|
118 |
}
|
franta-hg@70
|
119 |
|
franta-hg@101
|
120 |
private void showInfos(EnumSet<InfoType> commands) throws ConfigurationException, FormatterException {
|
franta-hg@70
|
121 |
for (InfoType infoType : commands) {
|
franta-hg@70
|
122 |
infoType.showInfo(this);
|
franta-hg@70
|
123 |
}
|
franta-hg@70
|
124 |
}
|
franta-hg@70
|
125 |
|
franta-hg@200
|
126 |
private void listJavaProperties() throws FormatterException, ConfigurationException {
|
franta-hg@200
|
127 |
ColumnsHeader header = constructHeader(new HeaderField("name", SQLType.VARCHAR), new HeaderField("value", SQLType.VARCHAR));
|
franta-hg@200
|
128 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@200
|
129 |
for (Entry<Object, Object> e : System.getProperties().entrySet()) {
|
franta-hg@200
|
130 |
data.add(new Object[]{e.getKey(), e.getValue()});
|
franta-hg@200
|
131 |
}
|
franta-hg@201
|
132 |
printTable(formatter, header, "-- Java system properties", null, data, 0);
|
franta-hg@200
|
133 |
}
|
franta-hg@200
|
134 |
|
franta-hg@200
|
135 |
private void listEnvironmentVariables() throws FormatterException, ConfigurationException {
|
franta-hg@200
|
136 |
ColumnsHeader header = constructHeader(new HeaderField("name", SQLType.VARCHAR), new HeaderField("value", SQLType.VARCHAR));
|
franta-hg@200
|
137 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@200
|
138 |
for (Entry<String, String> e : System.getenv().entrySet()) {
|
franta-hg@200
|
139 |
data.add(new Object[]{e.getKey(), e.getValue()});
|
franta-hg@200
|
140 |
}
|
franta-hg@201
|
141 |
printTable(formatter, header, "-- environment variables", null, data, 0);
|
franta-hg@200
|
142 |
}
|
franta-hg@200
|
143 |
|
franta-hg@72
|
144 |
private void listFormatters() throws ConfigurationException, FormatterException {
|
franta-hg@72
|
145 |
ColumnsHeader header = constructHeader(
|
franta-hg@72
|
146 |
new HeaderField("name", SQLType.VARCHAR),
|
franta-hg@72
|
147 |
new HeaderField("built_in", SQLType.BOOLEAN),
|
franta-hg@72
|
148 |
new HeaderField("default", SQLType.BOOLEAN),
|
franta-hg@160
|
149 |
new HeaderField("class_name", SQLType.VARCHAR),
|
franta-hg@160
|
150 |
new HeaderField("valid", SQLType.BOOLEAN));
|
franta-hg@72
|
151 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@72
|
152 |
|
franta-hg@72
|
153 |
String defaultFormatter = configurationProvider.getConfiguration().getDefaultFormatter();
|
franta-hg@72
|
154 |
defaultFormatter = defaultFormatter == null ? Configuration.DEFAULT_FORMATTER : defaultFormatter;
|
franta-hg@72
|
155 |
|
franta-hg@69
|
156 |
for (FormatterDefinition fd : configurationProvider.getConfiguration().getBuildInFormatters()) {
|
franta-hg@160
|
157 |
data.add(new Object[]{fd.getName(), true, defaultFormatter.equals(fd.getName()), fd.getClassName(), isInstantiable(fd)});
|
franta-hg@69
|
158 |
}
|
franta-hg@72
|
159 |
|
franta-hg@72
|
160 |
for (FormatterDefinition fd : configurationProvider.getConfiguration().getFormatters()) {
|
franta-hg@160
|
161 |
data.add(new Object[]{fd.getName(), false, defaultFormatter.equals(fd.getName()), fd.getClassName(), isInstantiable(fd)});
|
franta-hg@69
|
162 |
}
|
franta-hg@72
|
163 |
|
franta-hg@183
|
164 |
printTable(formatter, header, "-- configured and built-in output formatters", null, data);
|
franta-hg@160
|
165 |
}
|
franta-hg@72
|
166 |
|
franta-hg@160
|
167 |
private boolean isInstantiable(FormatterDefinition fd) {
|
franta-hg@160
|
168 |
try {
|
franta-hg@160
|
169 |
try (ByteArrayOutputStream testStream = new ByteArrayOutputStream()) {
|
franta-hg@160
|
170 |
fd.getInstance(new FormatterContext(testStream, new Properties(0)));
|
franta-hg@160
|
171 |
return true;
|
franta-hg@160
|
172 |
}
|
franta-hg@160
|
173 |
} catch (Exception e) {
|
franta-hg@160
|
174 |
log.log(Level.SEVERE, "Unable to create an instance of formatter: " + fd.getName(), e);
|
franta-hg@160
|
175 |
return false;
|
franta-hg@160
|
176 |
}
|
franta-hg@69
|
177 |
}
|
franta-hg@67
|
178 |
|
franta-hg@70
|
179 |
public void listTypes() throws FormatterException, ConfigurationException {
|
franta-hg@70
|
180 |
ColumnsHeader header = constructHeader(new HeaderField("name", SQLType.VARCHAR), new HeaderField("code", SQLType.INTEGER));
|
franta-hg@70
|
181 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@70
|
182 |
for (SQLType sqlType : SQLType.values()) {
|
franta-hg@70
|
183 |
data.add(new Object[]{sqlType.name(), sqlType.getCode()});
|
franta-hg@70
|
184 |
}
|
franta-hg@183
|
185 |
printTable(formatter, header, "-- data types", null, data);
|
franta-hg@93
|
186 |
log.log(Level.INFO, "Type names in --types option are case insensitive");
|
franta-hg@69
|
187 |
}
|
franta-hg@67
|
188 |
|
franta-hg@72
|
189 |
public void listDatabases() throws ConfigurationException, FormatterException {
|
franta-hg@72
|
190 |
ColumnsHeader header = constructHeader(
|
franta-hg@72
|
191 |
new HeaderField("database_name", SQLType.VARCHAR),
|
franta-hg@72
|
192 |
new HeaderField("user_name", SQLType.VARCHAR),
|
franta-hg@72
|
193 |
new HeaderField("database_url", SQLType.VARCHAR));
|
franta-hg@72
|
194 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@72
|
195 |
|
franta-hg@69
|
196 |
final List<DatabaseDefinition> configuredDatabases = configurationProvider.getConfiguration().getDatabases();
|
franta-hg@69
|
197 |
if (configuredDatabases.isEmpty()) {
|
franta-hg@69
|
198 |
log.log(Level.WARNING, "No databases are configured.");
|
franta-hg@69
|
199 |
} else {
|
franta-hg@69
|
200 |
for (DatabaseDefinition dd : configuredDatabases) {
|
franta-hg@72
|
201 |
data.add(new Object[]{dd.getName(), dd.getUserName(), dd.getUrl()});
|
franta-hg@203
|
202 |
|
franta-hg@203
|
203 |
final TunnelDefinition tunnel = dd.getTunnel();
|
franta-hg@203
|
204 |
if (tunnel != null) {
|
franta-hg@203
|
205 |
log.log(Level.INFO, "Tunnel command: {0}", tunnel.getCommand());
|
franta-hg@203
|
206 |
for (CommandArgument ca : Functions.notNull(tunnel.getArguments())) {
|
franta-hg@203
|
207 |
log.log(Level.INFO, "\targument: {0}/{1}", new Object[]{ca.getType(), ca.getValue()});
|
franta-hg@203
|
208 |
}
|
franta-hg@203
|
209 |
}
|
franta-hg@203
|
210 |
|
franta-hg@14
|
211 |
}
|
franta-hg@14
|
212 |
}
|
franta-hg@72
|
213 |
|
franta-hg@183
|
214 |
printTable(formatter, header, "-- configured databases", null, data);
|
franta-hg@14
|
215 |
}
|
franta-hg@17
|
216 |
|
franta-hg@158
|
217 |
public void listJdbcDrivers() throws FormatterException, ConfigurationException {
|
franta-hg@158
|
218 |
ColumnsHeader header = constructHeader(
|
franta-hg@158
|
219 |
new HeaderField("class", SQLType.VARCHAR),
|
franta-hg@158
|
220 |
new HeaderField("version", SQLType.VARCHAR),
|
franta-hg@158
|
221 |
new HeaderField("major", SQLType.INTEGER),
|
franta-hg@158
|
222 |
new HeaderField("minor", SQLType.INTEGER),
|
franta-hg@158
|
223 |
new HeaderField("jdbc_compliant", SQLType.BOOLEAN));
|
franta-hg@158
|
224 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@158
|
225 |
|
franta-hg@158
|
226 |
final ServiceLoader<Driver> drivers = ServiceLoader.load(Driver.class);
|
franta-hg@158
|
227 |
for (Driver d : drivers) {
|
franta-hg@158
|
228 |
data.add(new Object[]{
|
franta-hg@158
|
229 |
d.getClass().getName(),
|
franta-hg@158
|
230 |
d.getMajorVersion() + "." + d.getMinorVersion(),
|
franta-hg@158
|
231 |
d.getMajorVersion(),
|
franta-hg@158
|
232 |
d.getMinorVersion(),
|
franta-hg@159
|
233 |
d.jdbcCompliant()
|
franta-hg@159
|
234 |
});
|
franta-hg@158
|
235 |
}
|
franta-hg@158
|
236 |
|
franta-hg@183
|
237 |
printTable(formatter, header, "-- discovered JDBC drivers (available on the CLASSPATH)", null, data);
|
franta-hg@159
|
238 |
}
|
franta-hg@158
|
239 |
|
franta-hg@159
|
240 |
public void listJdbcProperties() throws FormatterException, ConfigurationException {
|
franta-hg@159
|
241 |
for (String dbName : options.getDatabaseNamesToListProperties()) {
|
franta-hg@159
|
242 |
ColumnsHeader header = constructHeader(
|
franta-hg@159
|
243 |
new HeaderField("property_name", SQLType.VARCHAR),
|
franta-hg@159
|
244 |
new HeaderField("required", SQLType.BOOLEAN),
|
franta-hg@159
|
245 |
new HeaderField("choices", SQLType.ARRAY),
|
franta-hg@159
|
246 |
new HeaderField("configured_value", SQLType.VARCHAR),
|
franta-hg@159
|
247 |
new HeaderField("description", SQLType.VARCHAR));
|
franta-hg@159
|
248 |
List<Object[]> data = new ArrayList<>();
|
franta-hg@159
|
249 |
|
franta-hg@159
|
250 |
DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
|
franta-hg@159
|
251 |
|
franta-hg@159
|
252 |
Driver driver = findDriver(dd);
|
franta-hg@159
|
253 |
|
franta-hg@159
|
254 |
if (driver == null) {
|
franta-hg@159
|
255 |
log.log(Level.WARNING, "No JDBC driver was found for DB: {0} with URL: {1}", new Object[]{dd.getName(), dd.getUrl()});
|
franta-hg@159
|
256 |
} else {
|
franta-hg@159
|
257 |
log.log(Level.INFO, "For DB: {0} was found JDBC driver: {1}", new Object[]{dd.getName(), driver.getClass().getName()});
|
franta-hg@159
|
258 |
|
franta-hg@159
|
259 |
try {
|
franta-hg@159
|
260 |
DriverPropertyInfo[] propertyInfos = driver.getPropertyInfo(dd.getUrl(), dd.getProperties().getJavaProperties());
|
franta-hg@159
|
261 |
|
franta-hg@159
|
262 |
Set<String> standardProperties = new HashSet<>();
|
franta-hg@159
|
263 |
|
franta-hg@159
|
264 |
for (DriverPropertyInfo pi : propertyInfos) {
|
franta-hg@159
|
265 |
Array choices = new FakeSqlArray(pi.choices, SQLType.VARCHAR);
|
franta-hg@159
|
266 |
data.add(new Object[]{
|
franta-hg@159
|
267 |
pi.name,
|
franta-hg@159
|
268 |
pi.required,
|
franta-hg@159
|
269 |
choices.getArray() == null ? "" : choices,
|
franta-hg@159
|
270 |
pi.value == null ? "" : pi.value,
|
franta-hg@159
|
271 |
pi.description
|
franta-hg@159
|
272 |
});
|
franta-hg@159
|
273 |
standardProperties.add(pi.name);
|
franta-hg@159
|
274 |
}
|
franta-hg@159
|
275 |
|
franta-hg@159
|
276 |
for (Property p : dd.getProperties()) {
|
franta-hg@159
|
277 |
if (!standardProperties.contains(p.getName())) {
|
franta-hg@159
|
278 |
data.add(new Object[]{
|
franta-hg@159
|
279 |
p.getName(),
|
franta-hg@159
|
280 |
"",
|
franta-hg@159
|
281 |
"",
|
franta-hg@159
|
282 |
p.getValue(),
|
franta-hg@159
|
283 |
""
|
franta-hg@159
|
284 |
});
|
franta-hg@159
|
285 |
log.log(Level.WARNING, "Your configuration contains property „{0}“ not declared by the JDBC driver.", p.getName());
|
franta-hg@159
|
286 |
}
|
franta-hg@159
|
287 |
}
|
franta-hg@159
|
288 |
|
franta-hg@159
|
289 |
} catch (SQLException e) {
|
franta-hg@159
|
290 |
log.log(Level.WARNING, "Error during getting property infos.", e);
|
franta-hg@159
|
291 |
}
|
franta-hg@159
|
292 |
|
franta-hg@159
|
293 |
List<Parameter> parameters = new ArrayList<>();
|
franta-hg@197
|
294 |
parameters.add(new NamedParameter("database", dbName, SQLType.VARCHAR));
|
franta-hg@159
|
295 |
parameters.add(new NamedParameter("driver_class", driver.getClass().getName(), SQLType.VARCHAR));
|
franta-hg@159
|
296 |
parameters.add(new NamedParameter("driver_major_version", driver.getMajorVersion(), SQLType.INTEGER));
|
franta-hg@159
|
297 |
parameters.add(new NamedParameter("driver_minor_version", driver.getMinorVersion(), SQLType.INTEGER));
|
franta-hg@159
|
298 |
|
franta-hg@183
|
299 |
printTable(formatter, header, "-- configured and configurable JDBC driver properties", parameters, data);
|
franta-hg@159
|
300 |
}
|
franta-hg@159
|
301 |
}
|
franta-hg@159
|
302 |
|
franta-hg@159
|
303 |
}
|
franta-hg@159
|
304 |
|
franta-hg@159
|
305 |
private Driver findDriver(DatabaseDefinition dd) {
|
franta-hg@159
|
306 |
final ServiceLoader<Driver> drivers = ServiceLoader.load(Driver.class);
|
franta-hg@159
|
307 |
for (Driver d : drivers) {
|
franta-hg@159
|
308 |
try {
|
franta-hg@159
|
309 |
if (d.acceptsURL(dd.getUrl())) {
|
franta-hg@159
|
310 |
return d;
|
franta-hg@159
|
311 |
}
|
franta-hg@159
|
312 |
} catch (SQLException e) {
|
franta-hg@159
|
313 |
log.log(Level.WARNING, "Error during finding JDBC driver for: " + dd.getName(), e);
|
franta-hg@159
|
314 |
}
|
franta-hg@159
|
315 |
}
|
franta-hg@159
|
316 |
return null;
|
franta-hg@158
|
317 |
}
|
franta-hg@158
|
318 |
|
franta-hg@183
|
319 |
/**
|
franta-hg@183
|
320 |
* Parallelism for connection testing – maximum concurrent database connections.
|
franta-hg@183
|
321 |
*/
|
franta-hg@183
|
322 |
private static final int TESTING_THREAD_COUNT = 64;
|
franta-hg@183
|
323 |
/**
|
franta-hg@183
|
324 |
* Time limit for all connection testing threads – particular timeouts per connection will be
|
franta-hg@183
|
325 |
* much smaller.
|
franta-hg@183
|
326 |
*/
|
franta-hg@183
|
327 |
private static final long TESTING_AWAIT_LIMIT = 1;
|
franta-hg@183
|
328 |
private static final TimeUnit TESTING_AWAIT_UNIT = TimeUnit.DAYS;
|
franta-hg@183
|
329 |
|
franta-hg@183
|
330 |
public void testConnections() throws FormatterException, ConfigurationException {
|
franta-hg@73
|
331 |
ColumnsHeader header = constructHeader(
|
franta-hg@73
|
332 |
new HeaderField("database_name", SQLType.VARCHAR),
|
franta-hg@74
|
333 |
new HeaderField("configured", SQLType.BOOLEAN),
|
franta-hg@74
|
334 |
new HeaderField("connected", SQLType.BOOLEAN));
|
franta-hg@73
|
335 |
|
franta-hg@183
|
336 |
log.log(Level.FINE, "Testing DB connections in {0} threads", TESTING_THREAD_COUNT);
|
franta-hg@183
|
337 |
|
franta-hg@183
|
338 |
ExecutorService es = Executors.newFixedThreadPool(TESTING_THREAD_COUNT);
|
franta-hg@183
|
339 |
|
franta-hg@183
|
340 |
final Formatter currentFormatter = formatter;
|
franta-hg@183
|
341 |
|
franta-hg@183
|
342 |
printHeader(currentFormatter, header, "-- database configuration and connectivity test", null);
|
franta-hg@183
|
343 |
|
franta-hg@183
|
344 |
for (final String dbName : options.getDatabaseNamesToTest()) {
|
franta-hg@196
|
345 |
preloadDriver(dbName);
|
franta-hg@196
|
346 |
}
|
franta-hg@196
|
347 |
|
franta-hg@196
|
348 |
for (final String dbName : options.getDatabaseNamesToTest()) {
|
franta-hg@183
|
349 |
es.submit(new Runnable() {
|
franta-hg@183
|
350 |
// TODO: Java 8 – lambda
|
franta-hg@183
|
351 |
@Override
|
franta-hg@183
|
352 |
public void run() {
|
franta-hg@183
|
353 |
final Object[] row = testConnection(dbName);
|
franta-hg@183
|
354 |
synchronized (currentFormatter) {
|
franta-hg@183
|
355 |
printRow(currentFormatter, row);
|
franta-hg@183
|
356 |
}
|
franta-hg@183
|
357 |
}
|
franta-hg@183
|
358 |
});
|
franta-hg@74
|
359 |
}
|
franta-hg@73
|
360 |
|
franta-hg@183
|
361 |
es.shutdown();
|
franta-hg@183
|
362 |
|
franta-hg@183
|
363 |
try {
|
franta-hg@183
|
364 |
log.log(Level.FINEST, "Waiting for test results: {0} {1}", new Object[]{TESTING_AWAIT_LIMIT, TESTING_AWAIT_UNIT.name()});
|
franta-hg@183
|
365 |
boolean finished = es.awaitTermination(TESTING_AWAIT_LIMIT, TESTING_AWAIT_UNIT);
|
franta-hg@183
|
366 |
if (finished) {
|
franta-hg@183
|
367 |
log.log(Level.FINEST, "All testing threads finished in time limit.");
|
franta-hg@183
|
368 |
} else {
|
franta-hg@183
|
369 |
throw new FormatterException("Exceeded total time limit for test threads – this should never happen");
|
franta-hg@183
|
370 |
}
|
franta-hg@183
|
371 |
} catch (InterruptedException e) {
|
franta-hg@183
|
372 |
throw new FormatterException("Interrupted while waiting for test results", e);
|
franta-hg@183
|
373 |
}
|
franta-hg@183
|
374 |
|
franta-hg@183
|
375 |
printFooter(currentFormatter);
|
franta-hg@73
|
376 |
}
|
franta-hg@73
|
377 |
|
franta-hg@196
|
378 |
/**
|
franta-hg@196
|
379 |
* JDBC driver classes should be preloaded in single thread to avoid deadlocks while doing
|
franta-hg@196
|
380 |
* {@linkplain DriverManager#registerDriver(java.sql.Driver)} during parallel connections.
|
franta-hg@196
|
381 |
*
|
franta-hg@196
|
382 |
* @param dbName
|
franta-hg@196
|
383 |
*/
|
franta-hg@196
|
384 |
private void preloadDriver(String dbName) {
|
franta-hg@196
|
385 |
try {
|
franta-hg@196
|
386 |
DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
|
franta-hg@196
|
387 |
Driver driver = findDriver(dd);
|
franta-hg@196
|
388 |
if (driver == null) {
|
franta-hg@196
|
389 |
log.log(Level.WARNING, "No Driver found for DB: {0}", dbName);
|
franta-hg@196
|
390 |
} else {
|
franta-hg@196
|
391 |
log.log(Level.FINEST, "Driver preloading for DB: {0} was successfull", dbName);
|
franta-hg@196
|
392 |
}
|
franta-hg@196
|
393 |
} catch (Exception e) {
|
franta-hg@196
|
394 |
LogRecord r = new LogRecord(Level.WARNING, "Failed to preload the Driver for DB: {0}");
|
franta-hg@196
|
395 |
r.setParameters(new Object[]{dbName});
|
franta-hg@196
|
396 |
r.setThrown(e);
|
franta-hg@196
|
397 |
log.log(r);
|
franta-hg@196
|
398 |
}
|
franta-hg@196
|
399 |
}
|
franta-hg@196
|
400 |
|
franta-hg@73
|
401 |
public Object[] testConnection(String dbName) {
|
franta-hg@69
|
402 |
log.log(Level.FINE, "Testing connection to database: {0}", dbName);
|
franta-hg@73
|
403 |
|
franta-hg@73
|
404 |
boolean succesfullyConnected = false;
|
franta-hg@73
|
405 |
boolean succesfullyConfigured = false;
|
franta-hg@73
|
406 |
|
franta-hg@69
|
407 |
try {
|
franta-hg@69
|
408 |
DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
|
franta-hg@75
|
409 |
log.log(Level.FINE, "Database definition was loaded from configuration");
|
franta-hg@75
|
410 |
succesfullyConfigured = true;
|
franta-hg@106
|
411 |
try (DatabaseConnection dc = dd.connect(options.getDatabaseProperties())) {
|
franta-hg@75
|
412 |
succesfullyConnected = dc.test();
|
franta-hg@69
|
413 |
}
|
franta-hg@75
|
414 |
log.log(Level.FINE, "Database connection test was successful");
|
franta-hg@196
|
415 |
} catch (ConfigurationException | SQLException | RuntimeException e) {
|
franta-hg@183
|
416 |
log.log(Level.SEVERE, "Error during testing connection " + dbName, e);
|
franta-hg@69
|
417 |
}
|
franta-hg@73
|
418 |
|
franta-hg@73
|
419 |
return new Object[]{dbName, succesfullyConfigured, succesfullyConnected};
|
franta-hg@69
|
420 |
}
|
franta-hg@69
|
421 |
|
franta-hg@69
|
422 |
public void printResource(String fileName) {
|
franta-hg@18
|
423 |
try (BufferedReader reader = new BufferedReader(new InputStreamReader(getClass().getClassLoader().getResourceAsStream(fileName)))) {
|
franta-hg@17
|
424 |
while (true) {
|
franta-hg@18
|
425 |
String line = reader.readLine();
|
franta-hg@17
|
426 |
if (line == null) {
|
franta-hg@17
|
427 |
break;
|
franta-hg@17
|
428 |
} else {
|
franta-hg@17
|
429 |
println(line);
|
franta-hg@17
|
430 |
}
|
franta-hg@17
|
431 |
}
|
franta-hg@17
|
432 |
} catch (Exception e) {
|
franta-hg@18
|
433 |
log.log(Level.SEVERE, "Unable to print this info. Please see our website for it: " + Constants.WEBSITE, e);
|
franta-hg@17
|
434 |
}
|
franta-hg@17
|
435 |
}
|
franta-hg@17
|
436 |
|
franta-hg@17
|
437 |
private void println(String line) {
|
franta-hg@17
|
438 |
out.println(line);
|
franta-hg@17
|
439 |
}
|
franta-hg@69
|
440 |
|
franta-hg@183
|
441 |
private void printTable(Formatter formatter, ColumnsHeader header, String sql, List<Parameter> parameters, List<Object[]> data) throws ConfigurationException, FormatterException {
|
franta-hg@201
|
442 |
printTable(formatter, header, sql, parameters, data, null);
|
franta-hg@201
|
443 |
}
|
franta-hg@201
|
444 |
|
franta-hg@201
|
445 |
private void printTable(Formatter formatter, ColumnsHeader header, String sql, List<Parameter> parameters, List<Object[]> data, final Integer sortByColumn) throws ConfigurationException, FormatterException {
|
franta-hg@183
|
446 |
printHeader(formatter, header, sql, parameters);
|
franta-hg@183
|
447 |
|
franta-hg@201
|
448 |
if (sortByColumn != null) {
|
franta-hg@201
|
449 |
Collections.sort(data, new Comparator<Object[]>() {
|
franta-hg@201
|
450 |
|
franta-hg@201
|
451 |
@Override
|
franta-hg@201
|
452 |
public int compare(Object[] o1, Object[] o2) {
|
franta-hg@201
|
453 |
String s1 = String.valueOf(o1[sortByColumn]);
|
franta-hg@201
|
454 |
String s2 = String.valueOf(o2[sortByColumn]);
|
franta-hg@201
|
455 |
return s1.compareTo(s2);
|
franta-hg@201
|
456 |
}
|
franta-hg@201
|
457 |
});
|
franta-hg@201
|
458 |
}
|
franta-hg@201
|
459 |
|
franta-hg@183
|
460 |
for (Object[] row : data) {
|
franta-hg@183
|
461 |
printRow(formatter, row);
|
franta-hg@183
|
462 |
}
|
franta-hg@183
|
463 |
|
franta-hg@183
|
464 |
printFooter(formatter);
|
franta-hg@183
|
465 |
}
|
franta-hg@183
|
466 |
|
franta-hg@183
|
467 |
private void printHeader(Formatter formatter, ColumnsHeader header, String sql, List<Parameter> parameters) {
|
franta-hg@159
|
468 |
formatter.writeStartStatement();
|
franta-hg@159
|
469 |
if (sql != null) {
|
franta-hg@159
|
470 |
formatter.writeQuery(sql);
|
franta-hg@159
|
471 |
if (parameters != null) {
|
franta-hg@159
|
472 |
formatter.writeParameters(parameters);
|
franta-hg@159
|
473 |
}
|
franta-hg@159
|
474 |
}
|
franta-hg@183
|
475 |
formatter.writeStartResultSet(header);
|
franta-hg@183
|
476 |
}
|
franta-hg@159
|
477 |
|
franta-hg@183
|
478 |
private void printRow(Formatter formatter, Object[] row) {
|
franta-hg@183
|
479 |
formatter.writeStartRow();
|
franta-hg@183
|
480 |
for (Object cell : row) {
|
franta-hg@183
|
481 |
formatter.writeColumnValue(cell);
|
franta-hg@183
|
482 |
}
|
franta-hg@183
|
483 |
formatter.writeEndRow();
|
franta-hg@183
|
484 |
}
|
franta-hg@69
|
485 |
|
franta-hg@183
|
486 |
private void printFooter(Formatter formatter) {
|
franta-hg@69
|
487 |
formatter.writeEndResultSet();
|
franta-hg@159
|
488 |
formatter.writeEndStatement();
|
franta-hg@69
|
489 |
}
|
franta-hg@69
|
490 |
|
franta-hg@69
|
491 |
private Formatter getFormatter() throws ConfigurationException, FormatterException {
|
franta-hg@89
|
492 |
String formatterName = options.getFormatterName();
|
franta-hg@89
|
493 |
formatterName = formatterName == null ? Configuration.DEFAULT_FORMATTER_PREFETCHING : formatterName;
|
franta-hg@89
|
494 |
FormatterDefinition fd = configurationProvider.getConfiguration().getFormatter(formatterName);
|
franta-hg@104
|
495 |
FormatterContext context = new FormatterContext(out, options.getFormatterProperties());
|
franta-hg@69
|
496 |
return fd.getInstance(context);
|
franta-hg@69
|
497 |
}
|
franta-hg@69
|
498 |
|
franta-hg@69
|
499 |
private ColumnsHeader constructHeader(HeaderField... fields) throws FormatterException {
|
franta-hg@69
|
500 |
try {
|
franta-hg@69
|
501 |
RowSetMetaDataImpl metaData = new RowSetMetaDataImpl();
|
franta-hg@69
|
502 |
metaData.setColumnCount(fields.length);
|
franta-hg@69
|
503 |
|
franta-hg@69
|
504 |
for (int i = 0; i < fields.length; i++) {
|
franta-hg@69
|
505 |
HeaderField hf = fields[i];
|
franta-hg@69
|
506 |
int sqlIndex = i + 1;
|
franta-hg@69
|
507 |
metaData.setColumnName(sqlIndex, hf.name);
|
franta-hg@69
|
508 |
metaData.setColumnLabel(sqlIndex, hf.name);
|
franta-hg@69
|
509 |
metaData.setColumnType(sqlIndex, hf.type.getCode());
|
franta-hg@69
|
510 |
metaData.setColumnTypeName(sqlIndex, hf.type.name());
|
franta-hg@69
|
511 |
}
|
franta-hg@69
|
512 |
|
franta-hg@69
|
513 |
return new ColumnsHeader(metaData);
|
franta-hg@69
|
514 |
} catch (SQLException e) {
|
franta-hg@69
|
515 |
throw new FormatterException("Error while constructing table headers", e);
|
franta-hg@69
|
516 |
}
|
franta-hg@69
|
517 |
}
|
franta-hg@69
|
518 |
|
franta-hg@69
|
519 |
private static class HeaderField {
|
franta-hg@69
|
520 |
|
franta-hg@69
|
521 |
String name;
|
franta-hg@69
|
522 |
SQLType type;
|
franta-hg@69
|
523 |
|
franta-hg@69
|
524 |
public HeaderField(String name, SQLType type) {
|
franta-hg@69
|
525 |
this.name = name;
|
franta-hg@69
|
526 |
this.type = type;
|
franta-hg@69
|
527 |
}
|
franta-hg@69
|
528 |
}
|
franta-hg@69
|
529 |
|
franta-hg@69
|
530 |
public enum InfoType {
|
franta-hg@69
|
531 |
|
franta-hg@69
|
532 |
HELP {
|
franta-hg@183
|
533 |
@Override
|
franta-hg@183
|
534 |
public void showInfo(InfoLister infoLister) {
|
franta-hg@183
|
535 |
infoLister.printResource(Constants.HELP_FILE);
|
franta-hg@183
|
536 |
}
|
franta-hg@183
|
537 |
},
|
franta-hg@69
|
538 |
VERSION {
|
franta-hg@183
|
539 |
@Override
|
franta-hg@183
|
540 |
public void showInfo(InfoLister infoLister) {
|
franta-hg@183
|
541 |
infoLister.printResource(Constants.VERSION_FILE);
|
franta-hg@183
|
542 |
}
|
franta-hg@183
|
543 |
},
|
franta-hg@69
|
544 |
LICENSE {
|
franta-hg@183
|
545 |
@Override
|
franta-hg@183
|
546 |
public void showInfo(InfoLister infoLister) {
|
franta-hg@183
|
547 |
infoLister.printResource(Constants.LICENSE_FILE);
|
franta-hg@183
|
548 |
}
|
franta-hg@183
|
549 |
},
|
franta-hg@200
|
550 |
JAVA_PROPERTIES {
|
franta-hg@200
|
551 |
@Override
|
franta-hg@200
|
552 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@200
|
553 |
infoLister.listJavaProperties();
|
franta-hg@200
|
554 |
}
|
franta-hg@200
|
555 |
},
|
franta-hg@200
|
556 |
ENVIRONMENT_VARIABLES {
|
franta-hg@200
|
557 |
@Override
|
franta-hg@200
|
558 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@200
|
559 |
infoLister.listEnvironmentVariables();
|
franta-hg@200
|
560 |
}
|
franta-hg@200
|
561 |
},
|
franta-hg@69
|
562 |
FORMATTERS {
|
franta-hg@183
|
563 |
@Override
|
franta-hg@183
|
564 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@183
|
565 |
infoLister.listFormatters();
|
franta-hg@183
|
566 |
}
|
franta-hg@183
|
567 |
},
|
franta-hg@69
|
568 |
TYPES {
|
franta-hg@183
|
569 |
@Override
|
franta-hg@183
|
570 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@183
|
571 |
infoLister.listTypes();
|
franta-hg@183
|
572 |
}
|
franta-hg@183
|
573 |
},
|
franta-hg@158
|
574 |
JDBC_DRIVERS {
|
franta-hg@183
|
575 |
@Override
|
franta-hg@183
|
576 |
public void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException {
|
franta-hg@183
|
577 |
infoLister.listJdbcDrivers();
|
franta-hg@183
|
578 |
}
|
franta-hg@183
|
579 |
},
|
franta-hg@159
|
580 |
JDBC_PROPERTIES {
|
franta-hg@183
|
581 |
@Override
|
franta-hg@183
|
582 |
public void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException {
|
franta-hg@183
|
583 |
infoLister.listJdbcProperties();
|
franta-hg@183
|
584 |
}
|
franta-hg@183
|
585 |
},
|
franta-hg@69
|
586 |
DATABASES {
|
franta-hg@183
|
587 |
@Override
|
franta-hg@183
|
588 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@183
|
589 |
infoLister.listDatabases();
|
franta-hg@183
|
590 |
}
|
franta-hg@183
|
591 |
},
|
franta-hg@69
|
592 |
CONNECTION {
|
franta-hg@183
|
593 |
@Override
|
franta-hg@183
|
594 |
public void showInfo(InfoLister infoLister) throws FormatterException, ConfigurationException {
|
franta-hg@183
|
595 |
infoLister.testConnections();
|
franta-hg@183
|
596 |
}
|
franta-hg@183
|
597 |
};
|
franta-hg@69
|
598 |
|
franta-hg@69
|
599 |
public abstract void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException;
|
franta-hg@69
|
600 |
}
|
franta-hg@14
|
601 |
}
|