org.opensearch.common.network.NetworkAddress Maven / Gradle / Ivy
/*
* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*/
package org.opensearch.common.network;
import org.opensearch.common.transport.PortsRange;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.Objects;
/**
* Utility functions for presentation of network addresses.
*
* Java's address formatting is particularly bad, every address
* has an optional host if its resolved, so IPv4 addresses often
* look like this (note the confusing leading slash):
*
* {@code /127.0.0.1}
*
* IPv6 addresses are even worse, with no IPv6 address compression,
* and often containing things like numeric scopeids, which are even
* more confusing (e.g. not going to work in any user's browser, refer
* to an interface on another machine, etc):
*
* {@code /0:0:0:0:0:0:0:1%1}
*
* Note: the {@code %1} is the "scopeid".
*
* This class provides sane address formatting instead, e.g.
* {@code 127.0.0.1} and {@code ::1} respectively. No methods do reverse
* lookups.
*
* @opensearch.internal
*/
public final class NetworkAddress {
/** No instantiation */
private NetworkAddress() {}
/**
* Formats a network address for display purposes.
*
* This formats only the address, any hostname information,
* if present, is ignored. IPv6 addresses are compressed
* and without scope identifiers.
*
* Example output with just an address:
*
* - IPv4: {@code 127.0.0.1}
* - IPv6: {@code ::1}
*
* @param address IPv4 or IPv6 address
* @return formatted string
*/
public static String format(InetAddress address) {
return format(address, new PortsRange(""));
}
/**
* Formats a network address and port for display purposes.
*
* This formats the address with {@link #format(InetAddress)}
* and appends the port number. IPv6 addresses will be bracketed.
* Any host information, if present is ignored.
*
* Example output:
*
* - IPv4: {@code 127.0.0.1:9300}
* - IPv6: {@code [::1]:9300}
*
* @param address IPv4 or IPv6 address with port
* @return formatted string
*/
public static String format(InetSocketAddress address) {
return format(address.getAddress(), address.getPort());
}
/**
* Formats a network address and port for display purposes.
*
* This formats the address with {@link #format(InetAddress)}
* and appends the port number. IPv6 addresses will be bracketed.
* Any host information, if present is ignored.
*
* Example output:
*
* - IPv4: {@code 127.0.0.1:9300}
* - IPv6: {@code [::1]:9300}
*
* @param address IPv4 or IPv6 address
* @param port port
* @return formatted string
*/
public static String format(InetAddress address, int port) {
return format(address, new PortsRange(String.valueOf(port)));
}
/**
* Formats a network address and port range for display purposes.
*
* This formats the address with {@link #format(InetAddress)}
* and appends the port range in brackets. In case there is only one
* port, the result is the same with {@link #format(InetAddress, int)}.
*
* Example output:
*
* - IPv4 no port: {@code 127.0.0.1}
* - IPv4 single port: {@code 127.0.0.1:9300}
* - IPv4 multiple ports: {@code 127.0.0.1:[9300-9400]}
* - IPv6 multiple ports: {@code [::1]:[9300-9400]}
*
* @param address IPv4 or IPv6 address
* @param portsRange range of ports
* @return formatted string
*/
public static String format(InetAddress address, PortsRange portsRange) {
Objects.requireNonNull(address);
StringBuilder builder = new StringBuilder();
int numberOfPorts = portsRange.ports().length;
if (numberOfPorts != 0 && address instanceof Inet6Address) {
builder.append(InetAddresses.toUriString(address));
} else {
builder.append(InetAddresses.toAddrString(address));
}
if (numberOfPorts != 0) {
builder.append(':');
if (numberOfPorts == 1) {
builder.append(portsRange.getPortRangeString());
} else {
builder.append("[").append(portsRange.getPortRangeString()).append("]");
}
}
return builder.toString();
}
}