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
203
204
205
206
207
208
209
|
/*-
* ============LICENSE_START=======================================================
* dcae-inventory
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed 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.
* ============LICENSE_END=========================================================
*/
package org.onap.dcae.inventory.daos;
import org.onap.dcae.inventory.InventoryConfiguration;
import org.onap.dcae.inventory.dbthings.StringListArgument;
import io.dropwizard.jdbi.DBIFactory;
import io.dropwizard.setup.Environment;
import org.skife.jdbi.v2.DBI;
import org.skife.jdbi.v2.Handle;
import org.skife.jdbi.v2.util.BooleanMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Arrays;
import java.util.List;
/**
* Reluctantly made this into a singleton in order to have access to the DAOs in the request handling code. Didn't
* want to change the interface on the handlers because they are generated by Swagger and I wanted to flexibility
* to swap in changes easily. This meant sacrificing dependency injection which is preferred.
*
* Created by mhwang on 4/19/16.
*/
public final class InventoryDAOManager {
private static InventoryDAOManager instance;
public static InventoryDAOManager getInstance() {
if (instance == null) {
instance = new InventoryDAOManager();
}
return instance;
}
public static class InventoryDAOManagerSetupException extends RuntimeException {
public InventoryDAOManagerSetupException(String message) {
super(message);
}
}
private static final Logger debugLogger = LoggerFactory.getLogger("debugLogger");
// WATCH! Table creation order matters where mapping tables refer to other tables for foreign keys.
private static final List<Class> DAO_CLASSES = Arrays.asList(DCAEServiceTypesDAO.class, DCAEServicesDAO.class,
DCAEServiceComponentsDAO.class, DCAEServicesComponentsMapsDAO.class);
private DBI jdbi;
private Environment environment;
private InventoryConfiguration configuration;
private InventoryDAOManager() {
}
/**
* Setup the manager
*
* Saving the Dropwizard environment and configuration which are used to construct the DBI object in a later
* initialize call. This method can only be called once to be safe and to avoid runtime problems that could be
* caused if the global instance of this class gets into a weird state (Couldn't use Java's `final` qualifier).
*
* @param environment
* @param inventoryConfiguration
*/
public void setup(Environment environment, InventoryConfiguration inventoryConfiguration) {
if (this.environment == null && this.configuration == null) {
this.environment = environment;
this.configuration = inventoryConfiguration;
} else {
throw new InventoryDAOManagerSetupException("InventoryDAOManager setup can only be called once.");
}
}
/**
* Initialize the manager
*
* Create the underlying validated DBI object that is used to manage database connections
*/
public void initialize() {
final DBIFactory factory = new DBIFactory();
final DBI jdbi_local = factory.build(this.environment, this.configuration.getDataSourceFactory(), "dcae-database");
jdbi_local.registerArgumentFactory(new StringListArgument());
boolean recreateDcaeServiceTypesView = false;
for (Class<? extends InventoryDAO> daoClass : DAO_CLASSES) {
final InventoryDAO dao = jdbi_local.onDemand(daoClass);
if (dao.checkIfTableExists()) {
debugLogger.info(String.format("Sql table exists: %s", daoClass.getSimpleName()));
} else {
dao.createTable();
debugLogger.info(String.format("Sql table created: %s", daoClass.getSimpleName()));
}
// dcae_service_types DB table has been enhanced to include 2 new columns which need to be added if they don't already exist
if ( daoClass.getSimpleName().equals("DCAEServiceTypesDAO") ) {
if (dao.checkIfApplicationColumnExists()) {
debugLogger.info(String.format("ApplicationColumn exists: %s", daoClass.getSimpleName()));
} else {
dao.updateTableToAddApplicationCol();
debugLogger.info(String.format("ApplicationColumn created: %s", daoClass.getSimpleName()+".updateTableToAddApplicationCol()" ));
recreateDcaeServiceTypesView = true;
}
if (dao.checkIfComponentColumnExists()) {
debugLogger.info(String.format("ComponentColumn exists: %s", daoClass.getSimpleName()));
} else {
dao.updateTableToAddComponentCol();;
debugLogger.info(String.format("ComponentColumn created: %s", daoClass.getSimpleName()+".updateTableToAddComponentCol()"));
recreateDcaeServiceTypesView = true;
}
}
}
// CREATE VIEWS
// TODO: This doesn't belong here and is not consistent with the above approach. Make it better.
try (Handle jdbiHandle = jdbi_local.open()) {
String viewName = "dcae_service_types_latest";
String checkQuery = String.format("select exists (select * from information_schema.tables where table_name = '%s')",
viewName);
boolean viewExists = jdbiHandle.createQuery(checkQuery).map(BooleanMapper.FIRST).first();
// if the view exists and the 2 new dcae_service_types DB table columns: application and component need to be added
// we need to re-create the view by deleting it first
if (viewExists && recreateDcaeServiceTypesView) {
debugLogger.info(String.format("Need to delete existing Sql view: %s", viewName));
jdbiHandle.execute(String.format("drop view %s ", viewName));
}
if (viewExists) {
debugLogger.info(String.format("Sql view exists: %s", viewName));
} else {
StringBuilder sb = new StringBuilder(String.format("create view %s as ", viewName));
sb.append("select s.* from dcae_service_types s ");
sb.append("join (select type_name, max(type_version) as max_version from dcae_service_types group by type_name) as f ");
sb.append("on s.type_name = f.type_name and s.type_version = f.max_version");
jdbiHandle.execute(sb.toString());
debugLogger.info(String.format("Sql view created: %s", viewName));
}
} catch (Exception e) {
throw new InventoryDAOManagerSetupException("view does not exist, " + e);
}
// Do this assignment at the end after performing table checks to ensure that connection is good
this.jdbi = jdbi_local;
}
private InventoryDAO getDAO(Class<? extends InventoryDAO> klass) {
if (jdbi == null) {
throw new InventoryDAOManagerSetupException("InventoryDAOManager has not been initialized!");
}
// Using this approach to constructing the DAO, the client is not responsible for closing the handle.
// http://jdbi.org/sql_object_overview/
// > In this case we do not need to (and in fact shouldn’t) ever take action to close the handle the sql object uses.
return jdbi.onDemand(klass);
}
public DCAEServicesDAO getDCAEServicesDAO() {
return (DCAEServicesDAO) this.getDAO(DCAEServicesDAO.class);
}
public DCAEServiceComponentsDAO getDCAEServiceComponentsDAO() {
return (DCAEServiceComponentsDAO) this.getDAO(DCAEServiceComponentsDAO.class);
}
public DCAEServicesComponentsMapsDAO getDCAEServicesComponentsDAO() {
return (DCAEServicesComponentsMapsDAO) this.getDAO(DCAEServicesComponentsMapsDAO.class);
}
public DCAEServiceTransactionDAO getDCAEServiceTransactionDAO() {
return jdbi.onDemand(DCAEServiceTransactionDAO.class);
}
public DCAEServiceTypesDAO getDCAEServiceTypesDAO() {
return (DCAEServiceTypesDAO) this.getDAO(DCAEServiceTypesDAO.class);
}
/**
* Must close the handle that is returned here. It is AutoCloseable so just use it as a try-with-resource.
*
* @return
*/
public Handle getHandle() {
return this.jdbi.open();
}
}
|
