Networking (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.net.Networking

```
public class Networking
extends java.lang.Object
```
Generic network utility methods (which are generally not specific to Brooklyn configuration, or brooklyn use-cases).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Networking.IsReachablePredicate

Nested Classes
Modifier and Type	Class and Description
`static class`	`Networking.IsReachablePredicate`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.net.InetAddress`	`ANY_NIC`
`static java.net.InetAddress`	`LOOPBACK`
`static int`	`MAX_PORT_NUMBER`
`static int`	`MIN_PORT_NUMBER`
`static java.util.List<Cidr>`	`PRIVATE_NETWORKS`
`static java.lang.Boolean`	`SET_REUSE_ADDRESS`
`static java.util.regex.Pattern`	`VALID_IP_ADDRESS_PATTERN`
`static java.lang.String`	`VALID_IP_ADDRESS_REGEX`

Constructor Summary

Constructors
Constructor and Description

Networking()

Constructors
Constructor and Description
`Networking()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static byte[]`	`asByteArray(long... bytes)` creates a byte array given a var-arg number of (or bytes or longs); checks that all values are valid as _unsigned_ bytes (i.e.
`static void`	`checkPortsValid(java.util.Map<?,?> ports)`
`static int`	`checkPortValid(java.lang.Integer port, java.lang.String errorMessage)`
`static Cidr`	`cidr(java.lang.String cidr)` returns a CIDR object for the given string, e.g.
`static void`	`closeQuietly(java.net.DatagramSocket s)`
`static void`	`closeQuietly(java.net.ServerSocket s)`
`static void`	`closeQuietly(java.net.Socket s)`
`static java.lang.String`	`getAddressOfUnresolvableHostname()` returns null in a sane DNS environment, but if DNS provides a bogus address for made-up hostnames, this returns that address
`static java.net.InetAddress`	`getInetAddressWithFixedName(byte[] ip)` Gets an InetAddress using the given IP, and using that IP as the hostname (i.e.
`static java.net.InetAddress`	`getInetAddressWithFixedName(int ip1, int ip2, int ip3, int ip4)`
`static java.net.InetAddress`	`getInetAddressWithFixedName(int ip1, int ip2, int ip3, int ip4, int ip5, int ip6)`
`static java.net.InetAddress`	`getInetAddressWithFixedName(java.lang.String hostnameOrIp)` Gets an InetAddress using the given hostname or IP.
`static java.util.Map<java.lang.String,java.net.InetAddress>`	`getLocalAddresses()` returns all local addresses
`static java.net.InetAddress`	`getLocalHost()` Deprecated. since 0.12.0, as this method has bad defaults (fails on some machines); use `#getLocalHost(boolean, boolean, boolean, int)` for full control or `getReachableLocalHost()` for a method with better defaults and errors
`static java.net.InetAddress`	`getLocalHost(boolean checkReachable, boolean prefer127, boolean preferIpV4, boolean failIfNone, int timeout)` returns a local IP address, using some heuristics to determine the best one in the case of multiple possibilities, as follows
`static Cidr`	`getPrivateNetwork(java.net.InetAddress address)`
`static Cidr`	`getPrivateNetwork(java.lang.String ip)` returns any well-known private network (e.g.
`static java.net.InetAddress`	`getReachableLocalHost()` returns a validated local IP address, preferring 127.0.0.1 if it works, and failing if none found
`static void`	`init()` does nothing, but forces the class to be loaded and do static initialization
`static void`	`installTlsForHttpsIfAppropriate()`
`static void`	`installTlsOnlyForHttpsForcing()` force use of TLSv1, fixing: http://stackoverflow.com/questions/9828414/receiving-sslhandshakeexception-handshake-failure-despite-my-client-ignoring-al
`static boolean`	`isLocalhost(java.lang.String remoteAddress)` returns true if the supplied string matches any known IP (v4 or v6) for this machine, or if it can be resolved to any such address
`static boolean`	`isLocalOnly(java.net.InetAddress address)` Check whether this address is definitely not going to be usable on any other machine; i.e.
`static boolean`	`isLocalOnly(java.lang.String hostnameOrIp)` As `isLocalOnly(InetAddress)` but taking a string; does not require the string to be resolvable, and generally treats non-resolvable hostnames as NOT local-only (although they are treated as private by `isPrivateSubnet(String)`), although certain well-known hostnames are recognised as local-only
`static boolean`	`isPortAvailable(java.net.InetAddress localAddress, int port)`
`static boolean`	`isPortAvailable(java.net.InetAddress localAddress, int port, java.lang.Boolean allowReuse)`
`static boolean`	`isPortAvailable(int port)`
`static boolean`	`isPortValid(java.lang.Integer port)`
`static boolean`	`isPrivateSubnet(java.net.InetAddress address)` Check if this is a private address, not exposed on the public Internet.
`static boolean`	`isPrivateSubnet(java.lang.String hostnameOrIp)` As `isPrivateSubnet(InetAddress)` but taking a string; sepcifically local-only address ARE treated as private.
`static boolean`	`isPublicIp(java.lang.String ipAddress)` returns whether the IP is _not_ in any private subnet
`static boolean`	`isReachable(HostAndPort endpoint)`
`static boolean`	`isReachable(HostAndPort endpoint, boolean noReuseOrLinger, int timeout)`
`static <any>`	`isReachablePredicate()`
`static boolean`	`isValidIp4(java.lang.String input)` checks whether given string matches a valid numeric IP (v4) address, e.g.
`static int`	`nextAvailablePort(int port)` returns the first port available on the local machine >= the port supplied
`static <any>`	`portRulesToRanges(java.util.Collection<java.lang.String> portRules)`
`static java.net.InetAddress`	`resolve(java.lang.String hostname)` resolves the given hostname to an IP address, returning null if unresolvable or if the resolution is bogus (eg 169.* subnet or a "catch-all" IP resolution supplied by some miscreant DNS services)

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIN_PORT_NUMBER
```
public static final int MIN_PORT_NUMBER
```
    See Also:
    
    Constant Field Values
  - MAX_PORT_NUMBER
```
public static final int MAX_PORT_NUMBER
```
    See Also:
    
    Constant Field Values
  - SET_REUSE_ADDRESS
```
public static final java.lang.Boolean SET_REUSE_ADDRESS
```
  - VALID_IP_ADDRESS_REGEX
```
public static final java.lang.String VALID_IP_ADDRESS_REGEX
```
    See Also:
    
    Constant Field Values
  - VALID_IP_ADDRESS_PATTERN
```
public static final java.util.regex.Pattern VALID_IP_ADDRESS_PATTERN
```
  - PRIVATE_NETWORKS
```
public static final java.util.List<Cidr> PRIVATE_NETWORKS
```
  - ANY_NIC
```
public static java.net.InetAddress ANY_NIC
```
  - LOOPBACK
```
public static java.net.InetAddress LOOPBACK
```
- Constructor Detail
  - Networking
```
public Networking()
```
- Method Detail
  - isPortAvailable
```
public static boolean isPortAvailable(int port)
```
  - isPortAvailable
```
public static boolean isPortAvailable(java.net.InetAddress localAddress,
                                      int port)
```
  - isPortAvailable
```
public static boolean isPortAvailable(java.net.InetAddress localAddress,
                                      int port,
                                      java.lang.Boolean allowReuse)
```
  - nextAvailablePort
```
public static int nextAvailablePort(int port)
```
    returns the first port available on the local machine >= the port supplied
  - isPortValid
```
public static boolean isPortValid(java.lang.Integer port)
```
  - checkPortValid
```
public static int checkPortValid(java.lang.Integer port,
                                 java.lang.String errorMessage)
```
  - checkPortsValid
```
public static void checkPortsValid(java.util.Map<?,?> ports)
```
  - portRulesToRanges
```
public static <any> portRulesToRanges(java.util.Collection<java.lang.String> portRules)
```
  - isPrivateSubnet
```
public static boolean isPrivateSubnet(java.net.InetAddress address)
```
    Check if this is a private address, not exposed on the public Internet. For IPV4 addresses this is an RFC1918 subnet (site local) address (10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16), a link-local address (169.254.0.0/16) or a loopback address (127.0.0.1/0).
    For IPV6 addresses this is the RFC3514 link local block (fe80::/10) and site local block (feco::/10) or the loopback block (::1/128).
    
    Returns:
    
    true if the address is private
  - isLocalOnly
```
public static boolean isLocalOnly(java.net.InetAddress address)
```
    Check whether this address is definitely not going to be usable on any other machine; i.e. if it is a loopback address or a link-local (169.254)
  - isLocalOnly
```
public static boolean isLocalOnly(java.lang.String hostnameOrIp)
```
    As isLocalOnly(InetAddress) but taking a string; does not require the string to be resolvable, and generally treats non-resolvable hostnames as NOT local-only (although they are treated as private by isPrivateSubnet(String)), although certain well-known hostnames are recognised as local-only
    note however InetAddress.getByName(String) can ignore settings in /etc/hosts, on OS X at least, and give different values than the system
  - isPrivateSubnet
```
public static boolean isPrivateSubnet(java.lang.String hostnameOrIp)
```
    As isPrivateSubnet(InetAddress) but taking a string; sepcifically local-only address ARE treated as private. does not require the string to be resolvable, and things which aren't resolvable are treated as private unless they are known to be local-only
  - getAddressOfUnresolvableHostname
```
public static java.lang.String getAddressOfUnresolvableHostname()
```
    returns null in a sane DNS environment, but if DNS provides a bogus address for made-up hostnames, this returns that address
  - resolve
```
public static java.net.InetAddress resolve(java.lang.String hostname)
```
    resolves the given hostname to an IP address, returning null if unresolvable or if the resolution is bogus (eg 169.* subnet or a "catch-all" IP resolution supplied by some miscreant DNS services)
  - getInetAddressWithFixedName
```
public static java.net.InetAddress getInetAddressWithFixedName(byte[] ip)
```
    Gets an InetAddress using the given IP, and using that IP as the hostname (i.e. avoids any hostname resolution).
    This is very useful if using the InetAddress for updating config files on remote machines, because then it will not be pickup a hostname from the local /etc/hosts file, which might not be known on the remote machine.
  - getInetAddressWithFixedName
```
public static java.net.InetAddress getInetAddressWithFixedName(int ip1,
                                                               int ip2,
                                                               int ip3,
                                                               int ip4)
```
  - getInetAddressWithFixedName
```
public static java.net.InetAddress getInetAddressWithFixedName(int ip1,
                                                               int ip2,
                                                               int ip3,
                                                               int ip4,
                                                               int ip5,
                                                               int ip6)
```
  - asByteArray
```
public static byte[] asByteArray(long... bytes)
```
    creates a byte array given a var-arg number of (or bytes or longs); checks that all values are valid as _unsigned_ bytes (i.e. in [0,255] )
  - isValidIp4
```
public static boolean isValidIp4(java.lang.String input)
```
    checks whether given string matches a valid numeric IP (v4) address, e.g. 127.0.0.1, but not localhost or 1.2.3.256
  - getInetAddressWithFixedName
```
public static java.net.InetAddress getInetAddressWithFixedName(java.lang.String hostnameOrIp)
```
    Gets an InetAddress using the given hostname or IP. If it is an IPv4 address, then this is equivalent to getInetAddressWithFixedName(byte[]). If it is a hostname, then this hostname will be used in the returned InetAddress.
  - getLocalHost
```
public static java.net.InetAddress getLocalHost()
```
    Deprecated. since 0.12.0, as this method has bad defaults (fails on some machines); use #getLocalHost(boolean, boolean, boolean, int) for full control or getReachableLocalHost() for a method with better defaults and errors
    
    returns local IP address, or 127.0.0.1 if it cannot be parsed
  - getReachableLocalHost
```
public static java.net.InetAddress getReachableLocalHost()
```
    returns a validated local IP address, preferring 127.0.0.1 if it works, and failing if none found
  - getLocalHost
```
public static java.net.InetAddress getLocalHost(boolean checkReachable,
                                                boolean prefer127,
                                                boolean preferIpV4,
                                                boolean failIfNone,
                                                int timeout)
```
    returns a local IP address, using some heuristics to determine the best one in the case of multiple possibilities, as follows
    
    Parameters:
    
    checkReachable - whether to ensure that the address is bindable and reachable
    
    prefer127 - whether to prefer standard loopback address 127.0.0.1 if listed
    
    failIfNone - whether to fail if none or simply return 127.0.0.1
    
    timeout - how long to wait for each address (if doing checkReachable)
    
    Returns:
    
    an InetAddress corresponding to localhost
  - getLocalAddresses
```
public static java.util.Map<java.lang.String,java.net.InetAddress> getLocalAddresses()
```
    returns all local addresses
  - cidr
```
public static Cidr cidr(java.lang.String cidr)
```
    returns a CIDR object for the given string, e.g. "10.0.0.0/8"
  - getPrivateNetwork
```
public static Cidr getPrivateNetwork(java.lang.String ip)
```
    returns any well-known private network (e.g. 10.0.0.0/8 or 192.168.0.0/16) which the given IP is in, or the /32 of local address if none
  - getPrivateNetwork
```
public static Cidr getPrivateNetwork(java.net.InetAddress address)
```
  - isPublicIp
```
public static boolean isPublicIp(java.lang.String ipAddress)
```
    returns whether the IP is _not_ in any private subnet
  - isLocalhost
```
public static boolean isLocalhost(java.lang.String remoteAddress)
```
    returns true if the supplied string matches any known IP (v4 or v6) for this machine, or if it can be resolved to any such address
  - isReachable
```
public static boolean isReachable(HostAndPort endpoint)
```
  - isReachable
```
public static boolean isReachable(HostAndPort endpoint,
                                  boolean noReuseOrLinger,
                                  int timeout)
```
  - isReachablePredicate
```
public static <any> isReachablePredicate()
```
  - closeQuietly
```
public static void closeQuietly(java.net.Socket s)
```
  - closeQuietly
```
public static void closeQuietly(java.net.ServerSocket s)
```
  - closeQuietly
```
public static void closeQuietly(java.net.DatagramSocket s)
```
  - installTlsOnlyForHttpsForcing
```
public static void installTlsOnlyForHttpsForcing()
```
    force use of TLSv1, fixing: http://stackoverflow.com/questions/9828414/receiving-sslhandshakeexception-handshake-failure-despite-my-client-ignoring-al
  - installTlsForHttpsIfAppropriate
```
public static void installTlsForHttpsIfAppropriate()
```
  - init
```
public static void init()
```
    does nothing, but forces the class to be loaded and do static initialization

Class Networking

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_PORT_NUMBER

MAX_PORT_NUMBER

SET_REUSE_ADDRESS

VALID_IP_ADDRESS_REGEX

VALID_IP_ADDRESS_PATTERN

PRIVATE_NETWORKS

ANY_NIC

LOOPBACK

Constructor Detail

Networking

Method Detail

isPortAvailable

isPortAvailable

isPortAvailable

nextAvailablePort

isPortValid

checkPortValid

checkPortsValid

portRulesToRanges

isPrivateSubnet

isLocalOnly

isLocalOnly

isPrivateSubnet

getAddressOfUnresolvableHostname

resolve

getInetAddressWithFixedName

getInetAddressWithFixedName

getInetAddressWithFixedName

asByteArray

isValidIp4

getInetAddressWithFixedName

getLocalHost

getReachableLocalHost

getLocalHost

getLocalAddresses

cidr

getPrivateNetwork

getPrivateNetwork

isPublicIp

isLocalhost

isReachable

isReachable

isReachablePredicate

closeQuietly

closeQuietly

closeQuietly

installTlsOnlyForHttpsForcing

installTlsForHttpsIfAppropriate

init