aboutsummaryrefslogtreecommitdiffstats
path: root/aai-resources/src/main/java/org/onap/aai/migration/VertexMerge.java
blob: 304be1eadb0fd90eed23be1c47c5462302923d0a (plain)
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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017-2018 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.aai.migration;

import java.io.UnsupportedEncodingException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Optional;
import java.util.Set;

import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource;
import org.apache.tinkerpop.gremlin.structure.Vertex;

import org.onap.aai.db.props.AAIProperties;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.introspection.Introspector;
import org.onap.aai.introspection.Loader;
import org.onap.aai.introspection.exceptions.AAIUnknownObjectException;
import org.onap.aai.serialization.db.DBSerializer;
import org.onap.aai.serialization.db.EdgeRules;
import org.onap.aai.serialization.db.EdgeType;
import org.onap.aai.serialization.engines.TransactionalGraphEngine;
import com.att.eelf.configuration.EELFLogger;
import com.att.eelf.configuration.EELFManager;

/**
 * This class recursively merges two vertices passed in.
 * <br>
 * You can start with any two vertices, but after the vertices are merged based off the equality of their keys
 *
 */
public class VertexMerge {

	private final EELFLogger logger = EELFManager.getInstance().getLogger(this.getClass().getSimpleName());

	private final GraphTraversalSource g;
	private final TransactionalGraphEngine engine;
	private final DBSerializer serializer;
	private final EdgeRules rules;
	private final Loader loader;
	private final NotificationHelper notificationHelper;
	private final boolean hasNotifications;
	private VertexMerge(Builder builder) {
		this.engine = builder.getEngine();
		this.serializer = builder.getSerializer();
		this.g = engine.asAdmin().getTraversalSource();
		this.rules = EdgeRules.getInstance();
		this.loader = builder.getLoader();
		this.notificationHelper = builder.getHelper();
		this.hasNotifications = builder.isHasNotifications();
	}
	
	/**
	 * Merges vertices. forceCopy is a map of the form [{aai-node-type}:{set of properties}]
	 * @param primary
	 * @param secondary
	 * @param forceCopy
	 * @throws AAIException
	 * @throws UnsupportedEncodingException
	 */
	public void performMerge(Vertex primary, Vertex secondary, Map<String, Set<String>> forceCopy) throws AAIException, UnsupportedEncodingException {
		final Optional<Introspector> secondarySnapshot;
		if (this.hasNotifications) {
			secondarySnapshot = Optional.of(serializer.getLatestVersionView(secondary));
		} else {
			secondarySnapshot = Optional.empty();
		}
		mergeProperties(primary, secondary, forceCopy);
		
		Collection<Vertex> secondaryChildren = this.engine.getQueryEngine().findChildren(secondary);
		Collection<Vertex> primaryChildren = this.engine.getQueryEngine().findChildren(primary);
		
		mergeChildren(primary, secondary, primaryChildren, secondaryChildren, forceCopy);
		
		Collection<Vertex> secondaryCousins = this.engine.getQueryEngine().findCousinVertices(secondary);
		Collection<Vertex> primaryCousins = this.engine.getQueryEngine().findCousinVertices(primary);
		
		secondaryCousins.removeAll(primaryCousins);
		logger.info("removing vertex after merge: " + secondary );
		if (this.hasNotifications && secondarySnapshot.isPresent()) {
			this.notificationHelper.addEvent(secondary, secondarySnapshot.get(), EventAction.DELETE, this.serializer.getURIForVertex(secondary, false));
		}
		secondary.remove();
		for (Vertex v : secondaryCousins) {
			this.rules.addEdgeIfPossible(g, v, primary);
		}
		if (this.hasNotifications) {
			final Introspector primarySnapshot = serializer.getLatestVersionView(primary);
			this.notificationHelper.addEvent(primary, primarySnapshot, EventAction.UPDATE, this.serializer.getURIForVertex(primary, false));
		}
	}
	
	/**
	 * This method may go away if we choose to event on each modification performed
	 * @param primary
	 * @param secondary
	 * @param forceCopy
	 * @throws AAIException
	 * @throws UnsupportedEncodingException
	 */
	protected void performMergeHelper(Vertex primary, Vertex secondary, Map<String, Set<String>> forceCopy) throws AAIException, UnsupportedEncodingException {
		mergeProperties(primary, secondary, forceCopy);
		
		Collection<Vertex> secondaryChildren = this.engine.getQueryEngine().findChildren(secondary);
		Collection<Vertex> primaryChildren = this.engine.getQueryEngine().findChildren(primary);
		
		mergeChildren(primary, secondary, primaryChildren, secondaryChildren, forceCopy);
		
		Collection<Vertex> secondaryCousins = this.engine.getQueryEngine().findCousinVertices(secondary);
		Collection<Vertex> primaryCousins = this.engine.getQueryEngine().findCousinVertices(primary);
		
		secondaryCousins.removeAll(primaryCousins);
		secondary.remove();
		for (Vertex v : secondaryCousins) {
			this.rules.addEdgeIfPossible(g, v, primary);
		}
	}
	
	private String getURI(Vertex v) throws UnsupportedEncodingException, AAIException {
		Introspector obj = loader.introspectorFromName(v.<String>property(AAIProperties.NODE_TYPE).orElse(""));
		this.serializer.dbToObject(Collections.singletonList(v), obj, 0, true, "false");
		return obj.getURI();

	}
	private void mergeChildren(Vertex primary, Vertex secondary, Collection<Vertex> primaryChildren, Collection<Vertex> secondaryChildren, Map<String, Set<String>> forceCopy) throws UnsupportedEncodingException, AAIException {
		Map<String, Vertex> primaryMap = uriMap(primaryChildren);
		Map<String, Vertex> secondaryMap = uriMap(secondaryChildren);
		Set<String> primaryKeys = new HashSet<>(primaryMap.keySet());
		Set<String> secondaryKeys = new HashSet<>(secondaryMap.keySet());
		primaryKeys.retainAll(secondaryKeys);
		final Set<String> mergeItems = new HashSet<>(primaryKeys);
		primaryKeys = new HashSet<>(primaryMap.keySet());
		secondaryKeys = new HashSet<>(secondaryMap.keySet());
		secondaryKeys.removeAll(primaryKeys);
		final Set<String> copyItems = new HashSet<>(secondaryKeys);
		
		for (String key : mergeItems) {
			this.performMergeHelper(primaryMap.get(key), secondaryMap.get(key), forceCopy);
		}
		
		for (String key : copyItems) {
			this.rules.addTreeEdgeIfPossible(g, secondaryMap.get(key), primary);
			this.serializer.getEdgeBetween(EdgeType.TREE, secondary, secondaryMap.get(key)).remove();
		}

	}
	
	private Map<String, Vertex> uriMap(Collection<Vertex> vertices) throws UnsupportedEncodingException, AAIException {
		final Map<String, Vertex> result = new HashMap<>();
		for (Vertex v : vertices) {
			result.put(getURI(v), v);
		}
		return result;
	}
	
	private void mergeProperties(Vertex primary, Vertex secondary, Map<String, Set<String>> forceCopy) throws AAIUnknownObjectException {
		final String primaryType = primary.<String>property(AAIProperties.NODE_TYPE).orElse("");
		final String secondaryType = secondary.<String>property(AAIProperties.NODE_TYPE).orElse("");

		final Introspector secondaryObj = loader.introspectorFromName(secondaryType);
		secondary.properties().forEachRemaining(prop -> {
			if (!primary.property(prop.key()).isPresent() || forceCopy.getOrDefault(primaryType, new HashSet<String>()).contains(prop.key())) {
				primary.property(prop.key(), prop.value());
			}
			if (primary.property(prop.key()).isPresent() && secondary.property(prop.key()).isPresent() && secondaryObj.isListType(prop.key())) {
				mergeCollection(primary, prop.key(), secondary.values(prop.key()));
			}
		});
	}
	private void mergeCollection(Vertex primary, String propName, Iterator<Object> secondaryValues) {
		secondaryValues.forEachRemaining(item -> {
			primary.property(propName, item);
		});
	}
	
	
	public static class Builder {
		private final TransactionalGraphEngine engine;

		private final DBSerializer serializer;
		private final Loader loader;
		private NotificationHelper helper = null;
		private boolean hasNotifications = false;
		public Builder(Loader loader, TransactionalGraphEngine engine, DBSerializer serializer) {
			this.loader = loader;
			this.engine = engine;
			this.serializer = serializer;
		}
		
		public Builder addNotifications(NotificationHelper helper) {
			this.helper = helper;
			this.hasNotifications = true;
			return this;
		}
		
		
		public VertexMerge build() {
			return new VertexMerge(this);
		}
		
		protected TransactionalGraphEngine getEngine() {
			return engine;
		}

		protected DBSerializer getSerializer() {
			return serializer;
		}

		protected Loader getLoader() {
			return loader;
		}

		protected NotificationHelper getHelper() {
			return helper;
		}

		protected boolean isHasNotifications() {
			return hasNotifications;
		}
		
	}
	
}