aboutsummaryrefslogtreecommitdiffstats
path: root/aai-core/src/main/java/org/onap/aai/introspection/sideeffect/SideEffect.java
blob: 085206084f2b37e07a7666266143bfb9a52eb3c5 (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
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 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=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */
package org.onap.aai.introspection.sideeffect;

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.LoaderFactory;
import org.onap.aai.introspection.ModelType;
import org.onap.aai.introspection.sideeffect.exceptions.AAIMissingRequiredPropertyException;
import org.onap.aai.schema.enums.PropertyMetadata;
import org.onap.aai.serialization.db.DBSerializer;
import org.onap.aai.serialization.engines.TransactionalGraphEngine;

import java.io.UnsupportedEncodingException;
import java.net.URISyntaxException;
import java.util.*;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public abstract class SideEffect {

	protected static final Pattern template = Pattern.compile("\\{(.*?)\\}");
	protected final Introspector obj;
	protected final TransactionalGraphEngine dbEngine;
	protected final DBSerializer serializer;
	protected final Loader latestLoader = LoaderFactory.createLoaderForVersion(ModelType.MOXY, AAIProperties.LATEST);
	protected final Vertex self;
	public SideEffect (Introspector obj, Vertex self, TransactionalGraphEngine dbEngine, DBSerializer serializer) {
		this.obj = obj;
		this.dbEngine = dbEngine;
		this.serializer = serializer;
		this.self = self;
	}

	protected void execute() throws UnsupportedEncodingException, URISyntaxException, AAIException {
		final Map<String, String> properties = this.findPopertiesWithMetadata(obj, this.getPropertyMetadata());
		for (Entry<String, String> entry : properties.entrySet()) {
			Optional<String> populatedUri = this.replaceTemplates(obj, entry.getValue());
			Optional<String> completeUri = this.resolveRelativePath(populatedUri);
			this.processURI(completeUri, entry);
		}
	}

	protected Map<String, String> findPopertiesWithMetadata(Introspector obj, PropertyMetadata metadata) {
		final Map<String, String> result = new HashMap<>();
		for (String prop : obj.getProperties()) {
			final Map<PropertyMetadata, String> map = obj.getPropertyMetadata(prop);
			if (map.containsKey(metadata)) {
				result.put(prop, map.get(metadata));
			}
		}
		return result;
	}
	
	protected Map<String, String> findProperties(Introspector obj, String uriString) throws AAIMissingRequiredPropertyException {
		
		final Map<String, String> result = new HashMap<>();
		final Set<String> missing = new LinkedHashSet<>();
		Matcher m = template.matcher(uriString);
		int properties = 0;
		while (m.find()) {
			String propName = m.group(1);
			String value = obj.getValue(propName);
			properties++;
			if (value != null) {
				result.put(propName, value);
			} else {
				if (replaceWithWildcard()) {
					result.put(propName, "*");
				}
				missing.add(propName);
			}
		}
		
		if (!missing.isEmpty() && (properties != missing.size())) {
			throw new AAIMissingRequiredPropertyException("Cannot complete " + this.getPropertyMetadata().toString() + " uri. Missing properties " + missing);
		}
		return result;
	}
	
	private Optional<String> replaceTemplates(Introspector obj, String uriString) throws AAIMissingRequiredPropertyException {
		String result = uriString;
		final Map<String, String> propMap = this.findProperties(obj, uriString);
		if (propMap.isEmpty()) {
			return Optional.empty();
		}
		for (Entry<String, String> entry : propMap.entrySet()) {
			result = result.replaceAll("\\{" + entry.getKey() + "\\}", entry.getValue());
		}
		//drop out wildcards if they exist
		result = result.replaceFirst("/[^/]+?(?:/\\*)+", "");
		return Optional.of(result);
	}
	
	private Optional<String> resolveRelativePath(Optional<String> populatedUri) throws UnsupportedEncodingException {
		if (!populatedUri.isPresent()) {
			return Optional.empty();
		} else {
			return Optional.of(populatedUri.get().replaceFirst("\\./", this.serializer.getURIForVertex(self) + "/"));
		}
	}
	
	protected abstract boolean replaceWithWildcard();
	protected abstract PropertyMetadata getPropertyMetadata();
	protected abstract void processURI(Optional<String> completeUri, Entry<String, String> entry) throws URISyntaxException, UnsupportedEncodingException, AAIException;
}