gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 Nordix Foundation.
   5  *  Modifications Copyright (C) 2021 AT&T Intellectual Property. All rights reserved.
   6  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.policy.apex.core.infrastructure.messaging.util;
  25
  26 import java.io.ByteArrayOutputStream;
  27 import java.io.IOException;
  28 import java.io.ObjectOutputStream;
  29 import java.net.InetAddress;
  30 import java.net.NetworkInterface;
  31 import java.net.Socket;
  32 import java.net.UnknownHostException;
  33 import java.util.Enumeration;
  34 import lombok.AccessLevel;
  35 import lombok.NoArgsConstructor;
  36 import org.slf4j.ext.XLogger;
  37 import org.slf4j.ext.XLoggerFactory;
  38
  39 /**
  40  * The Class MessagingUtils is a class with static methods used in IPC messaging for finding free ports, translating
  41  * host names to addresses, serializing objects and flushing object streams.
  42  *
  43  * @author Sajeevan Achuthan (sajeevan.achuthan@ericsson.com)
  44  */
  45 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  46 public final class MessagingUtils {
  47     // The port number of the lowest user port, ports 0-1023 are system ports
  48     private static final int LOWEST_USER_PORT = 1024;
  49
  50     /**
  51      * Port number is an unsigned 16-bit integer, so maximum port is 65535.
  52      */
  53     private static final int MAX_PORT_RANGE = 65535;
  54
  55     // Logger for this class
  56     private static final XLogger LOGGER = XLoggerFactory.getXLogger(MessagingUtils.class);
  57
  58     /**
  59      * This method searches the availability of the port, if the requested port not available, this method will throw an
  60      * exception.
  61      *
  62      * @param port the port to check
  63      * @return the port verified as being free
  64      * @throws RuntimeException on port allocation errors
  65      */
  66     public static int checkPort(final int port) {
  67         LOGGER.entry("Checking availability of  port {}", port);
  68
  69         if (isPortAvailable(port)) {
  70             LOGGER.debug("Port {} is available ", port);
  71             return port;
  72         }
  73         LOGGER.debug("Port {} is not available", port);
  74         throw new IllegalArgumentException("could not allocate requested port: " + port);
  75     }
  76
  77     /**
  78      * This method searches the availability of the port, if the requested port not available,this method will increment
  79      * the port number and check the availability of that port, this process will continue until it reaches max port
  80      * range which is MAX_PORT_RANGE.
  81      *
  82      * @param port the first port to check
  83      * @return the port that was found
  84      * @throws RuntimeException on port allocation errors
  85      */
  86     public static int findPort(final int port) {
  87         LOGGER.entry("Checking availability of  port {}", port);
  88
  89         int availablePort = port;
  90
  91         while (availablePort <= MAX_PORT_RANGE) {
  92             if (isPortAvailable(availablePort)) {
  93                 LOGGER.debug("Port {} is available ", availablePort);
  94                 return availablePort;
  95             }
  96             LOGGER.debug("Port {} is not available", availablePort);
  97             availablePort++;
  98         }
  99         throw new IllegalArgumentException("could not find free available");
 100     }
 101
 102     /**
 103      * Check if port is available or not.
 104      *
 105      * @param port the port to test
 106      * @return true if port is available
 107      */
 108     public static boolean isPortAvailable(final int port) {
 109         try (final var socket = new Socket("localhost", port)) {
 110             return false;
 111         } catch (final IOException ignoredException) {
 112             LOGGER.trace("Port {} is available", port, ignoredException);
 113             return true;
 114         }
 115     }
 116
 117     /**
 118      * Returns the local host address.
 119      *
 120      * @return the local host address
 121      * @throws IllegalStateException if the local host's address cannot be found
 122      */
 123     public static InetAddress getHost() {
 124         try {
 125             return InetAddress.getLocalHost();
 126         } catch (final UnknownHostException e) {
 127             throw new IllegalStateException(e.getMessage(), e);
 128         }
 129     }
 130
 131     /**
 132      * This method searches the availability of the port, if the requested port not available,this method will increment
 133      * the port number and check the availability, this process will continue until it find port available.
 134      *
 135      * @param port the first port to check
 136      * @return the port that was found
 137      * @throws RuntimeException on port allocation errors
 138      */
 139     public static int allocateAddress(final int port) {
 140         if (port < LOWEST_USER_PORT) {
 141             throw new IllegalArgumentException("The port " + port + "  is already in use");
 142         }
 143         return MessagingUtils.findPort(port);
 144     }
 145
 146     /**
 147      * Get an Internet Address for the local host.
 148      *
 149      * @return an Internet address
 150      * @throws UnknownHostException if the address of the local host cannot be found
 151      */
 152     public static InetAddress getLocalHostLanAddress() throws UnknownHostException {
 153         try {
 154             InetAddress candidateAddress = null;
 155             // Iterate all NICs (network interface cards)...
 156             for (final Enumeration<NetworkInterface> ifaces = NetworkInterface.getNetworkInterfaces(); ifaces
 157                     .hasMoreElements();) {
 158                 final NetworkInterface iface = ifaces.nextElement();
 159                 // Iterate all IP addresses assigned to each card...
 160                 for (final Enumeration<InetAddress> inetAddrs = iface.getInetAddresses(); inetAddrs
 161                         .hasMoreElements();) {
 162                     final InetAddress inetAddr = inetAddrs.nextElement();
 163                     if (!inetAddr.isLoopbackAddress()) {
 164
 165                         if (inetAddr.isSiteLocalAddress()) {
 166                             // Found non-loopback site-local address. Return it
 167                             // immediately...
 168                             return inetAddr;
 169                         } else if (candidateAddress == null) {
 170                             // Found non-loopback address, but not
 171                             // necessarily site-local.
 172                             // Store it as a candidate to be returned if
 173                             // site-local address is not subsequently
 174                             // found...
 175                             candidateAddress = inetAddr;
 176                             // Note that we don't repeatedly assign
 177                             // non-loopback non-site-local addresses as
 178                             // candidates,
 179                             // only the first. For subsequent iterations,
 180                             // candidate will be non-null.
 181                         }
 182                     }
 183                 }
 184             }
 185             if (candidateAddress != null) {
 186                 // We did not find a site-local address, but we found some other
 187                 // non-loopback address.
 188                 // Server might have a non-site-local address assigned to its
 189                 // NIC (or it might be running
 190                 // IPv6 which deprecates the "site-local" concept).
 191                 // Return this non-loopback candidate address...
 192                 return candidateAddress;
 193             }
 194             // At this point, we did not find a non-loopback address.
 195             // Fall back to returning whatever InetAddress.getLocalHost()
 196             // returns...
 197             final var jdkSuppliedAddress = InetAddress.getLocalHost();
 198             if (jdkSuppliedAddress == null) {
 199                 throw new UnknownHostException("The JDK InetAddress.getLocalHost() method unexpectedly returned null.");
 200             }
 201             return jdkSuppliedAddress;
 202         } catch (final Exception e) {
 203             final var unknownHostException =
 204                     new UnknownHostException("Failed to determine LAN address: " + e);
 205             unknownHostException.initCause(e);
 206             throw unknownHostException;
 207         }
 208     }
 209
 210     /**
 211      * This method serializes the message holder objects.
 212      *
 213      * @param object the object
 214      * @return byte[]
 215      */
 216     public static byte[] serializeObject(final Object object) {
 217         LOGGER.entry(object.getClass().getName());
 218         final var bytesOut = new ByteArrayOutputStream();
 219         try (var oos = new ObjectOutputStream(bytesOut)) {
 220             oos.writeObject(object);
 221         } catch (final IOException e) {
 222             LOGGER.warn("error on object serialization", e);
 223         }
 224         return bytesOut.toByteArray();
 225     }
 226 }