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);
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);
98 if (name.startsWith("http")) { // simple URL
100 this.version = access.getProperty(Config.AAF_API_VERSION,Config.AAF_DEFAULT_API_VERSION);
102 String[] split = Split.split(':', name);
103 this.name = split[0];
104 this.version = (split.length > 1) ? split[1] : access.getProperty(Config.AAF_API_VERSION,Config.AAF_DEFAULT_API_VERSION);
110 * This is the way to setup specialized AAFLocators ahead of time.
113 public static void setCreator(LocatorCreator lc) {
117 public static Locator<URI> create(final String name, final String version) throws LocatorException {
118 return locatorCreator.create(name, version);
121 public interface LocatorCreator {
122 public AbsAAFLocator<?> create(String key, String version) throws LocatorException;
123 public void setSelf(String hostname, int port);
126 protected static String nameFromLocatorURI(URI locatorURI) {
127 String[] path = Split.split('/', locatorURI.getPath());
128 if (path.length>1 && "locate".equals(path[1])) {
130 } else if(path.length>1) {
133 return locatorURI.toString();
138 * Setting "self" excludes this service from the list. Critical for contacting peers.
140 public void setSelf(final String hostname, final int port) {
146 public static void setCreatorSelf(final String hostname, final int port) {
147 if (locatorCreator!=null) {
148 locatorCreator.setSelf(hostname,port);
152 protected final synchronized void replace(List<EP> list) {
157 * Call _refresh as needed during calls, but actual refresh will not occur if there
158 * are existing entities or if it has been called in the last 10 (settable) seconds.
159 * Timed Refreshes happen by Scheduled Thread
161 private final boolean _refresh() {
163 long now=System.currentTimeMillis();
166 synchronized(epList) {
168 earliest = now + refreshWait; // call only up to 10 seconds.
171 access.log(Level.ERROR, "Must wait at least " + refreshWait/1000 + " seconds for Locator Refresh");
177 private boolean noEntries() {
178 return epList.isEmpty();
182 public URI get(Item item) throws LocatorException {
185 } else if (item instanceof AAFLItem) {
186 return getURI(((AAFLItem)item).uri);
188 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
193 public boolean hasItems() {
194 boolean isEmpty = epList.isEmpty();
196 for (Iterator<EP> iter = epList.iterator(); iter.hasNext(); ) {
204 if (_refresh()) { // is refreshed... check again
205 isEmpty = epList.isEmpty();
211 public void invalidate(Item item) throws LocatorException {
213 if (item instanceof AAFLItem) {
214 AAFLItem ali =(AAFLItem)item;
216 synchronized(epList) {
220 ali.iter = getIterator(); // for next guy... fresh iterator
222 throw new LocatorException(item.getClass().getName() + " does not belong to AAFLocator");
228 public Item best() throws LocatorException {
230 throw new LocatorException("No Entries found for '" + aaf_locator_uri.toString() + "/locate/" + name + ':' + version + '\'');
232 List<EP> lep = new ArrayList<>();
234 // Note: Deque is sorted on the way by closest distance
235 Iterator<EP> iter = getIterator();
237 while (iter.hasNext()) {
244 if (Math.abs(ep.distance-first.distance)<.1) { // allow for nearby/precision issues.
256 return new AAFLItem(iter,first);
258 int rand = sr.nextInt(); // Sonar chokes without.
259 int i = Math.abs(rand)%lep.size();
263 return new AAFLItem(iter,lep.get(i));
269 private Iterator<EP> getIterator() {
270 Object[] epa = epList.toArray();
273 epa = epList.toArray();
275 return new EPIterator(epa, epList);
278 public class EPIterator implements Iterator<EP> {
279 private final Object[] epa;
280 private final List<EP> epList;
283 public EPIterator(Object[] epa, List<EP> epList) {
285 this.epList = epList;
286 idx = epa.length>0?0:-1;
290 public boolean hasNext() {
295 while (idx<epa.length) {
296 if ((obj=epa[idx])==null || !((EP)obj).valid) {
302 return idx<epa.length;
309 throw new NoSuchElementException();
311 return (EP)epa[idx++];
315 public void remove() {
316 if (idx>=0 && idx<epa.length) {
317 synchronized(epList) {
318 epList.remove(epa[idx]);
325 public Item first() {
326 Iterator<EP> iter = getIterator();
327 EP ep = AAFLItem.next(iter);
331 return new AAFLItem(iter,ep);
335 public Item next(Item prev) throws LocatorException {
337 StringBuilder sb = new StringBuilder("Locator Item passed in next(item) is null.");
339 for (StackTraceElement st : Thread.currentThread().getStackTrace()) {
341 sb.append(st.toString());
343 sb.append("\n\t...");
347 access.log(Level.ERROR, sb);
349 if (prev instanceof AAFLItem) {
350 AAFLItem ali = (AAFLItem)prev;
351 EP ep = AAFLItem.next(ali.iter);
353 return new AAFLItem(ali.iter,ep);
356 throw new LocatorException(prev.getClass().getName() + " does not belong to AAFLocator");
362 protected static class AAFLItem implements Item {
363 private Iterator<EP> iter;
367 public AAFLItem(Iterator<EP> iter, EP ep) {
373 private static EP next(Iterator<EP> iter) {
375 while (iter.hasNext() && (ep==null || !ep.valid)) {
381 public String toString() {
382 return ep==null?"Locator Item Invalid":ep.toString();
386 protected static class EP implements Comparable<EP> {
388 private final double distance;
389 private boolean valid;
391 public EP(final Endpoint ep, double latitude, double longitude) throws URISyntaxException {
392 uri = new URI(ep.getProtocol(),null,ep.getHostname(),ep.getPort(),null,null,null);
393 distance = GreatCircle.calc(latitude, longitude, ep.getLatitude(), ep.getLongitude());
397 public void invalid() {
402 public int compareTo(EP o) {
403 if (distance<o.distance) {
405 } else if (distance>o.distance) {
413 public String toString() {
414 return distance + ": " + uri + (valid?" valid":" invalidate");
419 * @see org.onap.aaf.cadi.Locator#destroy()
422 public void destroy() {
427 public String toString() {
428 return "AAFLocator for " + name + " on " + getURI();
431 public AbsAAFLocator<TRANS> setPathInfo(String pathInfo) {
432 this.pathInfo = pathInfo;
437 public AbsAAFLocator<TRANS> setQuery(String query) {
443 public AbsAAFLocator<TRANS> setFragment(String fragment) {
444 this.fragment = fragment;
449 // Core URI, for reporting purposes
450 protected abstract URI getURI();
452 protected URI getURI(URI rv) throws LocatorException {
455 return new URI(rv.getScheme(),rv.getUserInfo(),rv.getHost(),rv.getPort(),pathInfo,query,fragment);
456 } catch (URISyntaxException e) {
457 throw new LocatorException("Error copying URL", e);