2 * ============LICENSE_START=======================================================
3 * ONAP : ccsdk features
4 * ================================================================================
5 * Copyright (C) 2019 highstreet technologies GmbH Intellectual Property.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.onap.ccsdk.features.sdnr.wt.dataprovider.data.entity;
24 import java.util.ArrayList;
25 import java.util.Arrays;
26 import java.util.Date;
27 import java.util.List;
28 import javax.annotation.Nonnull;
29 import org.eclipse.jdt.annotation.NonNull;
30 import org.eclipse.jdt.annotation.Nullable;
31 import org.onap.ccsdk.features.sdnr.wt.common.database.HtDatabaseClient;
32 import org.onap.ccsdk.features.sdnr.wt.common.database.queries.BoolQueryBuilder;
33 import org.onap.ccsdk.features.sdnr.wt.common.database.queries.QueryBuilder;
34 import org.onap.ccsdk.features.sdnr.wt.common.database.queries.QueryBuilders;
35 import org.onap.ccsdk.features.sdnr.wt.common.database.queries.RangeQueryBuilder;
36 import org.onap.ccsdk.features.sdnr.wt.dataprovider.data.ElasticSearchDataProvider;
37 import org.onap.ccsdk.features.sdnr.wt.dataprovider.database.EsDataObjectReaderWriter2;
38 import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.ArchiveCleanProvider;
39 import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.DataProvider;
40 import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.NetconfTimeStamp;
41 import org.onap.ccsdk.features.sdnr.wt.dataprovider.model.types.NetconfTimeStampImpl;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ConnectionLogStatus;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ConnectionlogBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.ConnectionlogEntity;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Entity;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.EventlogBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.EventlogEntity;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultcurrentBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultcurrentEntity;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultlogBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.FaultlogEntity;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.GranularityPeriodType;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Guicutthrough;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.GuicutthroughBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.GuicutthroughEntity;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.Inventory;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.InventoryBuilder;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.InventoryEntity;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.NetworkElementConnectionBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.NetworkElementConnectionEntity;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.PmdataEntity;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.PmdataEntityBuilder;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.data.provider.rev201110.UpdateNetworkElementConnectionInputBuilder;
65 import org.slf4j.Logger;
66 import org.slf4j.LoggerFactory;
69 * Event service, writing all events into the database into the appropriate index.
73 public class HtDatabaseEventsService implements ArchiveCleanProvider, DataProvider {
74 private static final Logger LOG = LoggerFactory.getLogger(HtDatabaseEventsService.class);
76 private static final NetconfTimeStamp NETCONFTIME_CONVERTER = NetconfTimeStampImpl.getConverter();
78 private HtDatabaseClient client;
79 private EsDataObjectReaderWriter2<EventlogEntity> eventRWEventLogDevicemanager;
80 private EsDataObjectReaderWriter2<InventoryEntity> eventRWEquipment;
81 private EsDataObjectReaderWriter2<FaultcurrentEntity> eventRWFaultCurrentDB;
82 private EsDataObjectReaderWriter2<FaultlogEntity> eventRWFaultLogDB;
83 private EsDataObjectReaderWriter2<ConnectionlogEntity> eventRWConnectionLogDB;
84 private final EsDataObjectReaderWriter2<NetworkElementConnectionEntity> networkelementConnectionDB;
85 private final EsDataObjectReaderWriter2<GuicutthroughEntity> guiCutThroughDB;
86 private final EsDataObjectReaderWriter2<PmdataEntity> pmData15mDB;
87 private final EsDataObjectReaderWriter2<PmdataEntity> pmData24hDB;
89 @SuppressWarnings("unused")
90 private final ElasticSearchDataProvider dataProvider;
91 // --- Construct and initialize
94 public HtDatabaseEventsService(HtDatabaseClient client, ElasticSearchDataProvider elasticSearchDataProvider)
97 LOG.info("Create {} start", HtDatabaseEventsService.class);
98 this.dataProvider = elasticSearchDataProvider;
101 // Create control structure
102 this.client = client;
104 eventRWEventLogDevicemanager = new EsDataObjectReaderWriter2<>(client, Entity.Eventlog,
105 EventlogEntity.class, EventlogBuilder.class);
107 eventRWEquipment = new EsDataObjectReaderWriter2<>(client, Entity.Inventoryequipment, InventoryEntity.class,
108 InventoryBuilder.class);
110 eventRWFaultCurrentDB = new EsDataObjectReaderWriter2<>(client, Entity.Faultcurrent,
111 FaultcurrentEntity.class, FaultcurrentBuilder.class);
113 eventRWFaultLogDB = new EsDataObjectReaderWriter2<>(client, Entity.Faultlog, FaultlogEntity.class,
114 FaultlogBuilder.class);
116 eventRWConnectionLogDB = new EsDataObjectReaderWriter2<>(client, Entity.Connectionlog,
117 ConnectionlogEntity.class, ConnectionlogBuilder.class);
119 networkelementConnectionDB = new EsDataObjectReaderWriter2<>(client, Entity.NetworkelementConnection,
120 NetworkElementConnectionEntity.class, NetworkElementConnectionBuilder.class, true)
121 .setEsIdAttributeName("_id");
123 guiCutThroughDB = new EsDataObjectReaderWriter2<>(client, Entity.Guicutthrough,
124 GuicutthroughEntity.class, GuicutthroughBuilder.class);
126 pmData15mDB = new EsDataObjectReaderWriter2<>(client, Entity.Historicalperformance15min, PmdataEntity.class,
127 PmdataEntityBuilder.class);
129 pmData24hDB = new EsDataObjectReaderWriter2<>(client, Entity.Historicalperformance24h, PmdataEntity.class,
130 PmdataEntityBuilder.class);
132 } catch (Exception e) {
133 LOG.error("Can not start database client. Exception: {}", e);
134 throw new Exception("Can not start database client. Exception: {}", e);
136 LOG.info("Create {} finished. DB Service {} started.", HtDatabaseEventsService.class,
137 client != null ? "sucessfully" : "not");
144 public void writeConnectionLog(ConnectionlogEntity event) {
145 if (assertIfClientNull(event)) {
148 LOG.debug("Write event: {}", event);
149 eventRWConnectionLogDB.write(event, null);
155 public void writeEventLog(EventlogEntity event) {
156 if (assertIfClientNull("No client to write {}", event)) {
160 LOG.debug("Write event: {}", event.toString());
161 eventRWEventLogDevicemanager.write(event, null);
168 public void writeFaultLog(FaultlogEntity fault) {
169 if (assertIfClientNull(fault)) {
173 LOG.debug("Write fault to faultlog: {}", fault.toString());
174 eventRWFaultLogDB.write(fault, null);
180 public void updateFaultCurrent(FaultcurrentEntity fault) {
181 if (assertIfClientNull(fault)) {
185 if (FaultEntityManager.isManagedAsCurrentProblem(fault)) {
186 if (FaultEntityManager.isNoAlarmIndication(fault)) {
187 LOG.debug("Remove from currentFaults: {}", fault.toString());
188 eventRWFaultCurrentDB.remove(FaultEntityManager.genSpecificEsId(fault));
190 LOG.debug("Write to currentFaults: {}", fault.toString());
191 eventRWFaultCurrentDB.write(fault, FaultEntityManager.genSpecificEsId(fault));
194 LOG.debug("Ingnore for currentFaults: {}", fault.toString());
199 * Remove all entries for one node
201 * @param nodeName contains the mountpointname
202 * @return number of deleted entries
205 public int clearFaultsCurrentOfNode(String nodeName) {
206 if (assertIfClientNullForNodeName(nodeName)) {
210 LOG.debug("Remove from currentFaults all faults for node: {}", nodeName);
211 return eventRWFaultCurrentDB.remove(EsFaultCurrent.getQueryForOneNode(nodeName));
215 * Remove all entries for one node
217 * @param nodeName contains the mountpointname
218 * @param objectId of element to be deleted
219 * @return number of deleted entries
222 public int clearFaultsCurrentOfNodeWithObjectId(String nodeName, String objectId) {
223 if (assertIfClientNullForNodeName(nodeName)) {
227 LOG.debug("Remove from currentFaults all faults for node/objectId: {}/{}", nodeName, objectId);
228 return eventRWFaultCurrentDB.remove(EsFaultCurrent.getQueryForOneNodeAndObjectId(nodeName, objectId));
232 * Deliver list with all mountpoint/node-names in the database.
234 * @return List of all mountpoint/node-names the had active alarms.
237 public @Nonnull List<String> getAllNodesWithCurrentAlarms() {
238 if (assertIfClientNull("No DB, can not delete for all nodes", null)) {
239 return new ArrayList<>();
242 LOG.debug("Remove from currentFaults faults for all node");
243 List<String> nodeNames = new ArrayList<>();
245 for (FaultcurrentEntity fault : eventRWFaultCurrentDB.doReadAll().getHits()) {
246 String nodeName = fault.getNodeId();
247 if (!nodeNames.contains(nodeName)) {
248 // this.clearFaultsCurrentOfNode(nodeName); -> Function shifted
249 nodeNames.add(nodeName);
255 // -- Inventory and equipment current
258 * write internal equipment to database
260 * @param internalEquipment with mandatory fields.
263 public void writeInventory(Inventory internalEquipment) {
265 if (assertIfClientNullForNodeName(internalEquipment.getNodeId())) {
268 if (internalEquipment.getManufacturerIdentifier() == null) {
269 internalEquipment = new InventoryBuilder(internalEquipment).setManufacturerIdentifier("").build();
271 if (internalEquipment.getDate() == null) {
272 internalEquipment = new InventoryBuilder(internalEquipment).setDate("").build();
275 eventRWEquipment.write(internalEquipment, internalEquipment.getNodeId() + "/" + internalEquipment.getUuid());
283 * join base with parameters of toJoin (only non null values)
285 * @param base base object
286 * @param toJoin object with new property values
287 * @return new joined object
289 @SuppressWarnings("unused")
290 private NetworkElementConnectionEntity joinNe(NetworkElementConnectionEntity base,
291 NetworkElementConnectionEntity toJoin) {
295 NetworkElementConnectionBuilder builder = new NetworkElementConnectionBuilder(base);
296 if (toJoin != null) {
297 if (toJoin.isIsRequired() != null) {
298 builder.setIsRequired(toJoin.isIsRequired());
300 if (toJoin.getCoreModelCapability() != null) {
301 builder.setCoreModelCapability(toJoin.getCoreModelCapability());
303 if (toJoin.getDeviceType() != null) {
304 builder.setDeviceType(toJoin.getDeviceType());
306 if (toJoin.getHost() != null) {
307 builder.setHost(toJoin.getHost());
309 if (toJoin.getNodeDetails() != null) {
310 builder.setNodeDetails(toJoin.getNodeDetails());
312 if (toJoin.getPassword() != null) {
313 builder.setPassword(toJoin.getPassword());
315 if (toJoin.getPort() != null) {
316 builder.setPort(toJoin.getPort());
318 if (toJoin.getStatus() != null) {
319 builder.setStatus(toJoin.getStatus());
321 if (toJoin.getUsername() != null) {
322 builder.setUsername(toJoin.getUsername());
325 return builder.build();
330 * @param networkElementConnectionEntitiy to wirte to DB
331 * @param nodeId Id for this DB element
334 public boolean updateNetworkConnectionDeviceType(NetworkElementConnectionEntity networkElementConnectionEntitiy,
336 return this.networkelementConnectionDB.update(networkElementConnectionEntitiy, nodeId) != null;
337 // NetworkElementConnectionEntity e = this.networkelementConnectionDB.read(nodeId);
338 // this.networkelementConnectionDB.write(this.joinNe(e, networkElementConnectionEntitiy), nodeId);
342 * Update after new mountpoint registration
344 * @param networkElementConnectionEntitiy data
345 * @param nodeId of device (mountpoint name)
348 public boolean updateNetworkConnection22(NetworkElementConnectionEntity networkElementConnectionEntitiy,
350 LOG.info("update networkelement-connection for {} with data {}", nodeId, networkElementConnectionEntitiy);
351 return this.networkelementConnectionDB.updateOrCreate(networkElementConnectionEntitiy, nodeId,
352 Arrays.asList("is-required", "username", "password")) != null;
353 // NetworkElementConnectionEntity e = this.networkelementConnectionDB.read(nodeId);
354 // this.networkelementConnectionDB.write(this.joinNe(e, networkElementConnectionEntitiy), nodeId);
358 /* please do not remove */
359 // public void cleanNetworkElementConnections() {
360 // this.networkelementConnectionDB.remove(QueryBuilders.matchQuery("is-required", false));
361 // CreateNetworkElementConnectionInput x = new CreateNetworkElementConnectionInputBuilder().setStatus(ConnectionLogStatus.Disconnected).build();
362 // this.networkelementConnectionDB.update(x,QueryBuilders.matchAllQuery());
366 public void removeNetworkConnection(String nodeId) {
368 NetworkElementConnectionEntity e = this.networkelementConnectionDB.read(nodeId);
369 if (e != null && (isRequired = e.isIsRequired()) != null) {
371 LOG.debug("updating connection status for {} of required ne to disconnected", nodeId);
372 this.networkelementConnectionDB.update(new UpdateNetworkElementConnectionInputBuilder()
373 .setStatus(ConnectionLogStatus.Disconnected).build(), nodeId);
375 LOG.debug("remove networkelement-connection for {} entry because of non-required", nodeId);
376 this.networkelementConnectionDB.remove(nodeId);
379 LOG.warn("Unable to update connection-status. dbentry for {} not found in networkelement-connection",
387 public int doIndexClean(Date olderAreOutdated) {
389 String netconfTimeStamp = NETCONFTIME_CONVERTER.getTimeStampAsNetconfString(olderAreOutdated);
392 QueryBuilder queryEventBase = EsEventBase.getQueryForTimeStamp(netconfTimeStamp);
393 removed += eventRWEventLogDevicemanager.remove(queryEventBase);
395 QueryBuilder queryFaultLog = EsFaultLogDevicemanager.getQueryForTimeStamp(netconfTimeStamp);
396 removed += eventRWFaultLogDB.remove(queryFaultLog);
401 public int getNumberOfOldObjects(Date olderAreOutdated) {
403 String netconfTimeStamp = NETCONFTIME_CONVERTER.getTimeStampAsNetconfString(olderAreOutdated);
404 int numberOfElements = 0;
406 QueryBuilder queryEventBase = EsEventBase.getQueryForTimeStamp(netconfTimeStamp);
407 numberOfElements += eventRWEventLogDevicemanager.doReadAll(queryEventBase).getTotal();
409 QueryBuilder queryFaultLog = EsFaultLogDevicemanager.getQueryForTimeStamp(netconfTimeStamp);
410 numberOfElements += eventRWFaultLogDB.doReadAll(queryFaultLog).getTotal();
412 return numberOfElements;
418 * Verify status of client
420 * @param event that is printed with message
421 * @return true if client is null
423 private boolean assertIfClientNull(Object event) {
424 return assertIfClientNull("No DB, can not write: {}", event);
427 private boolean assertIfClientNullForNodeName(Object object) {
428 return assertIfClientNull("No DB, can not handle node: {}", object);
432 * Verify status of client
434 * @param message to print including {} for object printout.
435 * @return true if client is null
437 private boolean assertIfClientNull(String message, Object object) {
438 if (client == null) {
439 LOG.debug(message, object);
448 private static class EsEventBase {
450 * Query to get older Elements
452 * @param netconfTimeStamp to identify older Elements
453 * @return QueryBuilder for older elements related to timestamp
455 private static QueryBuilder getQueryForTimeStamp(String netconfTimeStamp) {
456 return new RangeQueryBuilder("timestamp").lte(netconfTimeStamp);
459 private static class EsFaultLogDevicemanager {
463 * @param netconfTimeStamp to identify query elements older than this timestamp.
464 * @return QueryBuilder for related elements
466 public static QueryBuilder getQueryForTimeStamp(String netconfTimeStamp) {
467 return new RangeQueryBuilder("timestamp").lte(netconfTimeStamp);
470 public static class EsFaultCurrent {
472 * @param nodeName name of the node
473 * @return query builder
475 public static QueryBuilder getQueryForOneNode(String nodeName) {
476 return QueryBuilders.matchQuery("node-id", nodeName);
479 public static QueryBuilder getQueryForOneNodeAndObjectId(String nodeName, String objectId) {
480 BoolQueryBuilder bq = QueryBuilders.boolQuery();
481 bq.must(QueryBuilders.matchQuery("node-id", nodeName));
482 bq.must(QueryBuilders.matchQuery("object-id", objectId));
488 public List<NetworkElementConnectionEntity> getNetworkElementConnections() {
489 return this.networkelementConnectionDB.doReadAll().getHits();
493 public void doWritePerformanceData(List<PmdataEntity> list) {
495 list.forEach(elem -> {
496 GranularityPeriodType granularityPeriod = nnGetGranularityPeriodType(elem.getGranularityPeriod());
497 //_id": "Sim12600/LP-MWPS-TTP-01/2017-07-04T15:15:00.0+00:00"
498 StringBuffer id = new StringBuffer();
499 DateAndTime date = elem.getTimeStamp();
500 id.append(elem.getNodeName());
502 id.append(elem.getUuidInterface());
504 id.append(date != null ? date.getValue() : "null");
506 switch (granularityPeriod) {
508 pmData15mDB.write(elem, id.toString());
511 pmData24hDB.write(elem, id.toString());
515 LOG.debug("Unknown granularity {} id {}", granularityPeriod, id);
523 GranularityPeriodType nnGetGranularityPeriodType(@Nullable GranularityPeriodType granularityPeriod) {
524 return granularityPeriod != null ? granularityPeriod : GranularityPeriodType.Unknown;
528 public HtDatabaseClient getRawClient() {
533 public void writeGuiCutThroughData(Guicutthrough gcData, String nodeId) {
534 guiCutThroughDB.write(gcData, nodeId);