2 * ============LICENSE_START========================================================================
3 * ONAP : tr-069-adapter
4 * =================================================================================================
5 * Copyright (C) 2020 CommScope Inc Intellectual Property.
6 * =================================================================================================
7 * This tr-069-adapter software file is distributed by CommScope Inc under the Apache License,
8 * Version 2.0 (the "License"); you may not use this file except in compliance with the License. You
9 * may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
14 * either express or implied. See the License for the specific language governing permissions and
15 * limitations under the License.
16 * ===============LICENSE_END=======================================================================
19 package org.commscope.tr069adapter.netconf.server.helper;
21 import java.io.IOException;
22 import java.net.Socket;
23 import java.util.HashMap;
25 import java.util.PriorityQueue;
26 import java.util.concurrent.Semaphore;
28 import javax.annotation.PostConstruct;
30 import org.commscope.tr069adapter.netconf.config.NetConfServerProperties;
31 import org.commscope.tr069adapter.netconf.error.ServerPortAllocationException;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
34 import org.springframework.beans.factory.annotation.Autowired;
35 import org.springframework.stereotype.Component;
38 public class ServerPortAllocationHelper {
40 private static final Logger LOG = LoggerFactory.getLogger(ServerPortAllocationHelper.class);
42 private static Map<String, Semaphore> semaphoreMap = new HashMap<>();
44 private PriorityQueue<String> availablePorts = new PriorityQueue<>();
47 NetConfServerProperties config;
51 // read the port range and it the available ports.
53 Integer startPort = config.getDefaultNetconfStartPort();
54 Integer maxServers = config.getDefaultMaxServers();
57 startPort = Integer.parseInt(config.getNetconfServersStartPort());
58 } catch (Exception e) {
60 "Failed to initialize the starting port from the environment {}. Hence using the default port range.",
61 config.getNetconfServersStartPort());
65 maxServers = Integer.parseInt(config.getMaxNumOfNetconfServers());
66 } catch (Exception e) {
68 "Failed to initialize the max netconf server from the environment {} Hence using the default max servers.",
69 config.getMaxNumOfNetconfServers());
72 for (int i = startPort + maxServers - 1; i >= startPort; i--) {
73 semaphoreMap.put(String.valueOf(i), new Semaphore(1));
74 availablePorts.add(String.valueOf(i));
76 LOG.debug("Successfully populated available ports list.");
79 public synchronized String reserveServerPort() throws ServerPortAllocationException {
81 if (availablePorts.isEmpty()) {
83 "All ports are exhausted. Hence cannot allocate a port to start new netconf server.");
87 String port = availablePorts.peek();
89 LOG.debug("Trying to reserve port : {}", port);
90 if (isServerPortInUse(port)) {
91 LOG.debug("Port {} is already in use.", port);
92 availablePorts.poll();
93 return reserveServerPort(); // retry if current port is not available
96 Semaphore semaphore = semaphoreMap.get(port);
97 boolean isAcquired = semaphore.tryAcquire();
99 LOG.debug("Failed to acquire a lock for port :{}. Hence retrying...", port);
100 return reserveServerPort();
103 availablePorts.poll();
105 LOG.debug("Rserved port is {}", port);
109 public boolean unReserveServerPort(String port) {
112 Semaphore semaphore = semaphoreMap.get(port);
114 availablePorts.add(port);
116 LOG.error("Successfully un-reserved the port {} to start netconf server.", port);
117 } catch (InterruptedException e) {
118 LOG.warn("Failed to un-reserve the port {} {}", port, e.getMessage());
119 Thread.currentThread().interrupt();
126 public boolean checkAndReserveServerPort(String port) {
127 port = port.replaceAll("[\n|\r|\t]", "_");
129 Semaphore semaphore = semaphoreMap.get(port);
131 if (isServerPortInUse(port)) {
132 LOG.error("Port {} already in use.", port);
136 availablePorts.remove(port);
138 LOG.error("Successfully reserved the port {} to start netconf server", port);
139 } catch (InterruptedException e) {
140 Thread.currentThread().interrupt();
141 LOG.error("Failed to lock the port {} : Exception :{}", port, e.toString());
142 return checkAndReserveServerPort(port); // retry acquiring the lock.
148 public boolean isServerPortInUse(String port) {
149 return checkIfPortAvailable(port);
152 private static boolean checkIfPortAvailable(String portStr) {
153 Integer port = Integer.parseInt(portStr);
154 try (Socket ignored = new Socket("localhost", port)) {
156 } catch (IOException e) {
157 LOG.error("while checkIfPortAvailable {}", e.toString());