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.aaf.Defaults;
36 import org.onap.aaf.cadi.Locator;
37 import org.onap.aaf.cadi.LocatorException;
38 import org.onap.aaf.cadi.config.Config;
39 import org.onap.aaf.cadi.locator.PropertyLocator;
40 import org.onap.aaf.cadi.routing.GreatCircle;
41 import org.onap.aaf.misc.env.Trans;
42 import org.onap.aaf.misc.env.util.Split;
44 import locate.v1_0.Endpoint;
46 public abstract class AbsAAFLocator<TRANS extends Trans> implements Locator<URI> {
47 protected static final SecureRandom sr = new SecureRandom();
48 private static LocatorCreator locatorCreator;
49 protected final Access access;
51 protected final double latitude;
52 protected final double longitude;
53 protected List<EP> epList;
54 protected final String name, version;
55 private String pathInfo = null;
56 private String query = null;
57 private String fragment = null;
58 private boolean additional = false;
59 protected String myhostname;
61 protected final String aaf_locator_host;
62 protected final URI aaf_locator_uri;
63 private long earliest;
64 private final long refreshWait;
67 public AbsAAFLocator(Access access, String name, final long refreshMin) throws LocatorException {
68 aaf_locator_host = access.getProperty(Config.AAF_LOCATE_URL, null);
69 if(aaf_locator_host==null) {
70 aaf_locator_uri = null;
73 aaf_locator_uri = new URI(aaf_locator_host);
74 } catch (URISyntaxException e) {
75 throw new LocatorException(e);
79 epList = new LinkedList<>();
80 refreshWait = refreshMin;
83 String lat = access.getProperty(Config.CADI_LATITUDE,null);
84 String lng = access.getProperty(Config.CADI_LONGITUDE,null);
85 if(lat==null || lng==null) {
86 throw new LocatorException(Config.CADI_LATITUDE + " and " + Config.CADI_LONGITUDE + " properties are required.");
88 latitude = Double.parseDouble(lat);
89 longitude = Double.parseDouble(lng);
91 if(name.startsWith(Defaults.AAF_NS)) {
92 String root_ns = access.getProperty(Config.AAF_ROOT_NS, null);
94 name=name.replace(Defaults.AAF_NS, root_ns);
97 if(name.startsWith("http")) { // simple URL
99 this.version = Config.AAF_DEFAULT_VERSION;
101 String[] split = Split.split(':', name);
102 this.name = split[0];
103 this.version = (split.length > 1) ? split[1] : Config.AAF_DEFAULT_VERSION;
109 * This is the way to setup specialized AAFLocators ahead of time.
112 public static void setCreator(LocatorCreator lc) {
116 public static Locator<URI> create(String key) throws LocatorException {
118 String version = Config.AAF_DEFAULT_VERSION;
119 String pathInfo = null;
120 int prev = key.indexOf("/locate");
122 prev = key.indexOf('/',prev+6);
124 int next = key.indexOf('/',++prev);
126 name = key.substring(prev, next);
127 pathInfo=key.substring(next);
129 name = key.substring(prev);
131 String[] split = Split.split(':', name);
132 switch(split.length) {
144 if(key.startsWith("http")) {
146 if(locatorCreator != null) {
147 AbsAAFLocator<?> aal = locatorCreator.create(name, version);
149 aal.setPathInfo(pathInfo);
154 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>2 && "locate".equals(path[1])) {
174 return locatorURI.toString();
179 * Setting "self" excludes this service from the list. Critical for contacting peers.
181 public void setSelf(final String hostname, final int port) {
187 public static void setCreatorSelf(final String hostname, final int port) {
188 if(locatorCreator!=null) {
189 locatorCreator.setSelf(hostname,port);
193 protected final synchronized void replace(List<EP> list) {
198 * Call _refresh as needed during calls, but actual refresh will not occur if there
199 * are existing entities or if it has been called in the last 10 (settable) seconds.
200 * Timed Refreshes happen by Scheduled Thread
202 private final boolean _refresh() {
204 long now=System.currentTimeMillis();
207 synchronized(epList) {
209 earliest = now + refreshWait; // call only up to 10 seconds.
212 access.log(Level.ERROR, "Must wait at least " + refreshWait/1000 + " seconds for Locator Refresh");
218 private boolean noEntries() {
219 return epList.isEmpty();
223 public URI get(Item item) throws LocatorException {
226 } else if(item instanceof AAFLItem) {
227 return getURI(((AAFLItem)item).uri);
229 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
234 public boolean hasItems() {
235 boolean isEmpty = epList.isEmpty();
237 for(Iterator<EP> iter = epList.iterator(); iter.hasNext(); ) {
245 if(_refresh()) { // is refreshed... check again
246 isEmpty = epList.isEmpty();
252 public void invalidate(Item item) throws LocatorException {
254 if(item instanceof AAFLItem) {
255 AAFLItem ali =(AAFLItem)item;
257 synchronized(epList) {
261 ali.iter = getIterator(); // for next guy... fresh iterator
263 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
269 public Item best() throws LocatorException {
271 throw new LocatorException("No Entries found for '" + aaf_locator_uri.toString() + "/locate/" + name + ':' + version + '\'');
273 List<EP> lep = new ArrayList<>();
275 // Note: Deque is sorted on the way by closest distance
276 Iterator<EP> iter = getIterator();
278 while(iter.hasNext()) {
285 if(Math.abs(ep.distance-first.distance)<.1) { // allow for nearby/precision issues.
297 return new AAFLItem(iter,first);
299 int rand = sr.nextInt(); // Sonar chokes without.
300 int i = Math.abs(rand)%lep.size();
304 return new AAFLItem(iter,lep.get(i));
310 private Iterator<EP> getIterator() {
311 Object[] epa = epList.toArray();
314 epa = epList.toArray();
316 return new EPIterator(epa, epList);
319 public class EPIterator implements Iterator<EP> {
320 private final Object[] epa;
321 private final List<EP> epList;
324 public EPIterator(Object[] epa, List<EP> epList) {
326 this.epList = epList;
327 idx = epa.length>0?0:-1;
331 public boolean hasNext() {
336 while(idx<epa.length) {
337 if((obj=epa[idx])==null || !((EP)obj).valid) {
343 return idx<epa.length;
350 throw new NoSuchElementException();
352 return (EP)epa[idx++];
356 public void remove() {
357 if(idx>=0 && idx<epa.length) {
358 synchronized(epList) {
359 epList.remove(epa[idx]);
366 public Item first() {
367 Iterator<EP> iter = getIterator();
368 EP ep = AAFLItem.next(iter);
372 return new AAFLItem(iter,ep);
376 public Item next(Item prev) throws LocatorException {
378 StringBuilder sb = new StringBuilder("Locator Item passed in next(item) is null.");
380 for(StackTraceElement st : Thread.currentThread().getStackTrace()) {
382 sb.append(st.toString());
384 sb.append("\n\t...");
388 access.log(Level.ERROR, sb);
390 if(prev instanceof AAFLItem) {
391 AAFLItem ali = (AAFLItem)prev;
392 EP ep = AAFLItem.next(ali.iter);
394 return new AAFLItem(ali.iter,ep);
397 throw new LocatorException(prev.getClass().getName() + " does not belong to AAFLocator");
403 protected static class AAFLItem implements Item {
404 private Iterator<EP> iter;
408 public AAFLItem(Iterator<EP> iter, EP ep) {
414 private static EP next(Iterator<EP> iter) {
416 while(iter.hasNext() && (ep==null || !ep.valid)) {
422 public String toString() {
423 return ep==null?"Locator Item Invalid":ep.toString();
427 protected static class EP implements Comparable<EP> {
429 private final double distance;
430 private boolean valid;
432 public EP(final Endpoint ep, double latitude, double longitude) throws URISyntaxException {
433 uri = new URI(ep.getProtocol(),null,ep.getHostname(),ep.getPort(),null,null,null);
434 distance = GreatCircle.calc(latitude, longitude, ep.getLatitude(), ep.getLongitude());
438 public void invalid() {
443 public int compareTo(EP o) {
444 if(distance<o.distance) {
446 } else if(distance>o.distance) {
454 public String toString() {
455 return distance + ": " + uri + (valid?" valid":" invalidate");
460 * @see org.onap.aaf.cadi.Locator#destroy()
463 public void destroy() {
468 public String toString() {
469 return "AAFLocator for " + name + " on " + getURI();
472 public AbsAAFLocator<TRANS> setPathInfo(String pathInfo) {
473 this.pathInfo = pathInfo;
478 public AbsAAFLocator<TRANS> setQuery(String query) {
484 public AbsAAFLocator<TRANS> setFragment(String fragment) {
485 this.fragment = fragment;
490 // Core URI, for reporting purposes
491 protected abstract URI getURI();
493 protected URI getURI(URI rv) throws LocatorException {
496 return new URI(rv.getScheme(),rv.getUserInfo(),rv.getHost(),rv.getPort(),pathInfo,query,fragment);
497 } catch (URISyntaxException e) {
498 throw new LocatorException("Error copying URL", e);