2 * ============LICENSE_START====================================================
4 * ===========================================================================
5 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6 * ===========================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END====================================================
22 package org.onap.aaf.cadi.aaf.v2_0;
25 import java.net.URISyntaxException;
26 import java.security.SecureRandom;
27 import java.util.ArrayList;
28 import java.util.Iterator;
29 import java.util.LinkedList;
30 import java.util.List;
31 import java.util.NoSuchElementException;
33 import org.onap.aaf.cadi.Access;
34 import org.onap.aaf.cadi.Access.Level;
35 import org.onap.aaf.cadi.Locator;
36 import org.onap.aaf.cadi.LocatorException;
37 import org.onap.aaf.cadi.aaf.Defaults;
38 import org.onap.aaf.cadi.config.Config;
39 import org.onap.aaf.cadi.routing.GreatCircle;
40 import org.onap.aaf.misc.env.Trans;
41 import org.onap.aaf.misc.env.util.Split;
43 import locate.v1_0.Endpoint;
45 public abstract class AbsAAFLocator<TRANS extends Trans> implements Locator<URI> {
46 protected static final SecureRandom sr = new SecureRandom();
47 private static LocatorCreator locatorCreator;
48 protected final Access access;
50 protected final double latitude;
51 protected final double longitude;
52 protected List<EP> epList;
53 protected final String name, version;
54 private String pathInfo = null;
55 private String query = null;
56 private String fragment = null;
57 private boolean additional = false;
58 protected String myhostname;
60 protected final String aaf_locator_host;
61 protected final URI aaf_locator_uri;
62 private long earliest;
63 private final long refreshWait;
66 public AbsAAFLocator(Access access, String name, final long refreshMin) throws LocatorException {
67 aaf_locator_host = access.getProperty(Config.AAF_LOCATE_URL, null);
68 if (aaf_locator_host==null) {
69 aaf_locator_uri = null;
72 aaf_locator_uri = new URI(aaf_locator_host);
73 } catch (URISyntaxException e) {
74 throw new LocatorException(e);
78 epList = new LinkedList<>();
79 refreshWait = refreshMin;
82 String lat = access.getProperty(Config.CADI_LATITUDE,null);
83 String lng = access.getProperty(Config.CADI_LONGITUDE,null);
84 if (lat==null || lng==null) {
85 throw new LocatorException(Config.CADI_LATITUDE + " and " + Config.CADI_LONGITUDE + " properties are required.");
87 latitude = Double.parseDouble(lat);
88 longitude = Double.parseDouble(lng);
90 if (name.startsWith(Defaults.AAF_NS)) {
91 String root_ns = access.getProperty(Config.AAF_ROOT_NS, null);
93 name=name.replace(Defaults.AAF_NS, root_ns);
96 if (name.startsWith("http")) { // simple URL
98 this.version = access.getProperty(Config.AAF_API_VERSION,Config.AAF_DEFAULT_API_VERSION);
100 String[] split = Split.split(':', name);
101 this.name = split[0];
102 this.version = (split.length > 1) ? split[1] : access.getProperty(Config.AAF_API_VERSION,Config.AAF_DEFAULT_API_VERSION);
108 * This is the way to setup specialized AAFLocators ahead of time.
111 public static void setCreator(LocatorCreator lc) {
115 /*public static Locator<URI> create(String key) throws LocatorException {
117 String version = Config.AAF_DEFAULT_API_VERSION;
118 String pathInfo = null;
119 int prev = key.indexOf("/locate");
121 prev = key.indexOf('/',prev+6);
123 int next = key.indexOf('/',++prev);
125 name = key.substring(prev, next);
126 pathInfo=key.substring(next);
128 name = key.substring(prev);
130 String[] split = Split.split(':', name);
131 switch(split.length) {
143 if (key.startsWith("http")) {
145 if (locatorCreator != null) {
146 AbsAAFLocator<?> aal = locatorCreator.create(name, version);
147 if (pathInfo!=null) {
148 aal.setPathInfo(pathInfo);
153 return new PropertyLocator(key);
160 public static Locator<URI> create(final String name, final String version) throws LocatorException {
161 return locatorCreator.create(name, version);
164 public interface LocatorCreator {
165 public AbsAAFLocator<?> create(String key, String version) throws LocatorException;
166 public void setSelf(String hostname, int port);
169 protected static String nameFromLocatorURI(URI locatorURI) {
170 String[] path = Split.split('/', locatorURI.getPath());
171 if (path.length>1 && "locate".equals(path[1])) {
173 } else if(path.length>1) {
176 return locatorURI.toString();
181 * Setting "self" excludes this service from the list. Critical for contacting peers.
183 public void setSelf(final String hostname, final int port) {
189 public static void setCreatorSelf(final String hostname, final int port) {
190 if (locatorCreator!=null) {
191 locatorCreator.setSelf(hostname,port);
195 protected final synchronized void replace(List<EP> list) {
200 * Call _refresh as needed during calls, but actual refresh will not occur if there
201 * are existing entities or if it has been called in the last 10 (settable) seconds.
202 * Timed Refreshes happen by Scheduled Thread
204 private final boolean _refresh() {
206 long now=System.currentTimeMillis();
209 synchronized(epList) {
211 earliest = now + refreshWait; // call only up to 10 seconds.
214 access.log(Level.ERROR, "Must wait at least " + refreshWait/1000 + " seconds for Locator Refresh");
220 private boolean noEntries() {
221 return epList.isEmpty();
225 public URI get(Item item) throws LocatorException {
228 } else if (item instanceof AAFLItem) {
229 return getURI(((AAFLItem)item).uri);
231 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
236 public boolean hasItems() {
237 boolean isEmpty = epList.isEmpty();
239 for (Iterator<EP> iter = epList.iterator(); iter.hasNext(); ) {
247 if (_refresh()) { // is refreshed... check again
248 isEmpty = epList.isEmpty();
254 public void invalidate(Item item) throws LocatorException {
256 if (item instanceof AAFLItem) {
257 AAFLItem ali =(AAFLItem)item;
259 synchronized(epList) {
263 ali.iter = getIterator(); // for next guy... fresh iterator
265 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
271 public Item best() throws LocatorException {
273 throw new LocatorException("No Entries found for '" + aaf_locator_uri.toString() + "/locate/" + name + ':' + version + '\'');
275 List<EP> lep = new ArrayList<>();
277 // Note: Deque is sorted on the way by closest distance
278 Iterator<EP> iter = getIterator();
280 while (iter.hasNext()) {
287 if (Math.abs(ep.distance-first.distance)<.1) { // allow for nearby/precision issues.
299 return new AAFLItem(iter,first);
301 int rand = sr.nextInt(); // Sonar chokes without.
302 int i = Math.abs(rand)%lep.size();
306 return new AAFLItem(iter,lep.get(i));
312 private Iterator<EP> getIterator() {
313 Object[] epa = epList.toArray();
316 epa = epList.toArray();
318 return new EPIterator(epa, epList);
321 public class EPIterator implements Iterator<EP> {
322 private final Object[] epa;
323 private final List<EP> epList;
326 public EPIterator(Object[] epa, List<EP> epList) {
328 this.epList = epList;
329 idx = epa.length>0?0:-1;
333 public boolean hasNext() {
338 while (idx<epa.length) {
339 if ((obj=epa[idx])==null || !((EP)obj).valid) {
345 return idx<epa.length;
352 throw new NoSuchElementException();
354 return (EP)epa[idx++];
358 public void remove() {
359 if (idx>=0 && idx<epa.length) {
360 synchronized(epList) {
361 epList.remove(epa[idx]);
368 public Item first() {
369 Iterator<EP> iter = getIterator();
370 EP ep = AAFLItem.next(iter);
374 return new AAFLItem(iter,ep);
378 public Item next(Item prev) throws LocatorException {
380 StringBuilder sb = new StringBuilder("Locator Item passed in next(item) is null.");
382 for (StackTraceElement st : Thread.currentThread().getStackTrace()) {
384 sb.append(st.toString());
386 sb.append("\n\t...");
390 access.log(Level.ERROR, sb);
392 if (prev instanceof AAFLItem) {
393 AAFLItem ali = (AAFLItem)prev;
394 EP ep = AAFLItem.next(ali.iter);
396 return new AAFLItem(ali.iter,ep);
399 throw new LocatorException(prev.getClass().getName() + " does not belong to AAFLocator");
405 protected static class AAFLItem implements Item {
406 private Iterator<EP> iter;
410 public AAFLItem(Iterator<EP> iter, EP ep) {
416 private static EP next(Iterator<EP> iter) {
418 while (iter.hasNext() && (ep==null || !ep.valid)) {
424 public String toString() {
425 return ep==null?"Locator Item Invalid":ep.toString();
429 protected static class EP implements Comparable<EP> {
431 private final double distance;
432 private boolean valid;
434 public EP(final Endpoint ep, double latitude, double longitude) throws URISyntaxException {
435 uri = new URI(ep.getProtocol(),null,ep.getHostname(),ep.getPort(),null,null,null);
436 distance = GreatCircle.calc(latitude, longitude, ep.getLatitude(), ep.getLongitude());
440 public void invalid() {
445 public int compareTo(EP o) {
446 if (distance<o.distance) {
448 } else if (distance>o.distance) {
456 public String toString() {
457 return distance + ": " + uri + (valid?" valid":" invalidate");
462 * @see org.onap.aaf.cadi.Locator#destroy()
465 public void destroy() {
470 public String toString() {
471 return "AAFLocator for " + name + " on " + getURI();
474 public AbsAAFLocator<TRANS> setPathInfo(String pathInfo) {
475 this.pathInfo = pathInfo;
480 public AbsAAFLocator<TRANS> setQuery(String query) {
486 public AbsAAFLocator<TRANS> setFragment(String fragment) {
487 this.fragment = fragment;
492 // Core URI, for reporting purposes
493 protected abstract URI getURI();
495 protected URI getURI(URI rv) throws LocatorException {
498 return new URI(rv.getScheme(),rv.getUserInfo(),rv.getHost(),rv.getPort(),pathInfo,query,fragment);
499 } catch (URISyntaxException e) {
500 throw new LocatorException("Error copying URL", e);