SshdSocketAddress (Apache Mina SSHD

java.lang.Object
- java.net.SocketAddress
- - org.apache.sshd.common.util.net.SshdSocketAddress

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LocalForwardingEntry
```
public class SshdSocketAddress
extends SocketAddress
```
A simple socket address holding the host name and port number. The reason it does not extend InetSocketAddress is twofold:
1. The InetSocketAddress performs a DNS resolution on the provided host name - which we don't want do use until we want to create a connection using this address (thus the toInetSocketAddress() call which executes this query
2. If empty host name is provided we replace it with the any address of 0.0.0.0
Author:

Apache MINA SSHD Project

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BROADCAST_ADDRESS`
`static Comparator<InetAddress>`	`BY_HOST_ADDRESS` Compares `InetAddress`-es according to their `InetAddress.getHostAddress()` value case insensitive
`static Comparator<SocketAddress>`	`BY_HOST_AND_PORT` Compares `SocketAddress`-es according to their host case insensitive and if equals, then according to their port value (if any)
`static String`	`CARRIER_GRADE_NAT_PREFIX`
`static String`	`IP_ANYADDR`
`static SshdSocketAddress`	`LOCALHOST_ADDRESS` A dummy placeholder that can be used instead of `null`s
`static String`	`LOCALHOST_IP`
`static String`	`LOCALHOST_NAME`
`static String`	`PRIVATE_CLASS_A_PREFIX`
`static String`	`PRIVATE_CLASS_B_PREFIX`
`static String`	`PRIVATE_CLASS_C_PREFIX`

Constructor Summary

Constructors
Constructor and Description

SshdSocketAddress(int port)

SshdSocketAddress(String hostName, int port)

Constructors
Constructor and Description
`SshdSocketAddress(int port)`
`SshdSocketAddress(String hostName, int port)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`static List<InetAddress>`	`getExternalNetwork4Addresses()`
`static InetAddress`	`getFirstExternalNetwork4Address()` Returns the first external network address assigned to this machine or null if one is not found.
`String`	`getHostName()`
`int`	`getPort()`
`int`	`hashCode()`
`static boolean`	`isCarrierGradeNatIPv4Address(String addr)`
`protected boolean`	`isEquivalent(SshdSocketAddress that)`
`static boolean`	`isIPv4Address(String addr)`
`static boolean`	`isLoopback(InetAddress addr)`
`static boolean`	`isLoopback(String ip)`
`static boolean`	`isPrivateIPv4Address(String addr)` Checks if the address is one of the allocated private blocks
`static boolean`	`isValidHostAddress(InetAddress addr)`
`static boolean`	`isValidIPv4AddressComponent(CharSequence c)` Checks if the provided argument is a valid IPv4 address component: Not `null`/empty Has at most 3 digits Its value is ≤ 255
`static int`	`toAddressPort(SocketAddress addr)` Attempts to resolve the port value
`static String`	`toAddressString(InetAddress addr)`
`static String`	`toAddressString(SocketAddress addr)`
`InetSocketAddress`	`toInetSocketAddress()`
`static InetSocketAddress`	`toInetSocketAddress(SocketAddress remoteAddress)` Converts a `SocketAddress` into an `InetSocketAddress` if possible: If already an `InetSocketAddress` then cast it as such If an `SshdSocketAddress` then invoke `toInetSocketAddress()` Otherwise, throw an exception
`static SshdSocketAddress`	`toSshdSocketAddress(SocketAddress addr)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOCALHOST_NAME
```
public static final String LOCALHOST_NAME
```
    See Also:
    
    Constant Field Values
  - LOCALHOST_IP
```
public static final String LOCALHOST_IP
```
    See Also:
    
    Constant Field Values
  - IP_ANYADDR
```
public static final String IP_ANYADDR
```
    See Also:
    
    Constant Field Values
  - PRIVATE_CLASS_A_PREFIX
```
public static final String PRIVATE_CLASS_A_PREFIX
```
    See Also:
    
    Constant Field Values
  - PRIVATE_CLASS_B_PREFIX
```
public static final String PRIVATE_CLASS_B_PREFIX
```
    See Also:
    
    Constant Field Values
  - PRIVATE_CLASS_C_PREFIX
```
public static final String PRIVATE_CLASS_C_PREFIX
```
    See Also:
    
    Constant Field Values
  - CARRIER_GRADE_NAT_PREFIX
```
public static final String CARRIER_GRADE_NAT_PREFIX
```
    See Also:
    
    Constant Field Values
  - BROADCAST_ADDRESS
```
public static final String BROADCAST_ADDRESS
```
    See Also:
    
    Constant Field Values
  - LOCALHOST_ADDRESS
```
public static final SshdSocketAddress LOCALHOST_ADDRESS
```
    A dummy placeholder that can be used instead of nulls
  - BY_HOST_ADDRESS
```
public static final Comparator<InetAddress> BY_HOST_ADDRESS
```
    Compares InetAddress-es according to their InetAddress.getHostAddress() value case insensitive
    
    See Also:
    
    toAddressString(InetAddress)
  - BY_HOST_AND_PORT
```
public static final Comparator<SocketAddress> BY_HOST_AND_PORT
```
    Compares SocketAddress-es according to their host case insensitive and if equals, then according to their port value (if any)
    
    See Also:
    
    toAddressString(SocketAddress), toAddressPort(SocketAddress)
- Constructor Detail
  - SshdSocketAddress
```
public SshdSocketAddress(int port)
```
  - SshdSocketAddress
```
public SshdSocketAddress(String hostName,
                         int port)
```
- Method Detail
  - getHostName
```
public String getHostName()
```
  - getPort
```
public int getPort()
```
  - toInetSocketAddress
```
public InetSocketAddress toInetSocketAddress()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isEquivalent
```
protected boolean isEquivalent(SshdSocketAddress that)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getFirstExternalNetwork4Address
```
public static InetAddress getFirstExternalNetwork4Address()
```
    Returns the first external network address assigned to this machine or null if one is not found.
    
    Returns:
    
    Inet4Address associated with an external interface DevNote: We actually return InetAddress here, as Inet4Addresses are final and cannot be mocked.
  - getExternalNetwork4Addresses
```
public static List<InetAddress> getExternalNetwork4Addresses()
```
    Returns:
    
    a List of local network addresses which are not multicast or localhost sorted according to BY_HOST_ADDRESS
  - isValidHostAddress
```
public static boolean isValidHostAddress(InetAddress addr)
```
    Parameters:
    
    addr - The InetAddress to be verified
    
    Returns:
    true if the address is:
    
    Not null
    
    An Inet4Address
    
    Not link local
    
    Not a multicast
    
    Not a loopback
    See Also:
    
    InetAddress.isLinkLocalAddress(), InetAddress.isMulticastAddress(), InetAddress.isMulticastAddress()
  - isLoopback
```
public static boolean isLoopback(InetAddress addr)
```
    Parameters:
    
    addr - The InetAddress to be considered
    
    Returns:
    
    true if the address is a loopback one. Note: if InetAddress.isLoopbackAddress() returns false the address string is checked
    
    See Also:
    
    toAddressString(InetAddress), isLoopback(String)
  - isLoopback
```
public static boolean isLoopback(String ip)
```
    Parameters:
    
    ip - IP value to be tested
    
    Returns:
    
    true if the IP is "localhost" or "127.x.x.x".
  - toSshdSocketAddress
```
public static SshdSocketAddress toSshdSocketAddress(SocketAddress addr)
```
  - toAddressString
```
public static String toAddressString(SocketAddress addr)
```
  - toAddressPort
```
public static int toAddressPort(SocketAddress addr)
```
    Attempts to resolve the port value
    
    Parameters:
    
    addr - The SocketAddress to examine
    
    Returns:
    
    The associated port value - negative if failed to resolve
  - toInetSocketAddress
```
public static InetSocketAddress toInetSocketAddress(SocketAddress remoteAddress)
```
    Converts a SocketAddress into an InetSocketAddress if possible:
    - If already an InetSocketAddress then cast it as such
    - If an SshdSocketAddress then invoke toInetSocketAddress()
    - Otherwise, throw an exception
    Parameters:
    
    remoteAddress - The SocketAddress - ignored if null
    
    Returns:
    
    The InetSocketAddress instance
    
    Throws:
    
    ClassCastException - if argument is not already an InetSocketAddress or a SshdSocketAddress
  - toAddressString
```
public static String toAddressString(InetAddress addr)
```
  - isIPv4Address
```
public static boolean isIPv4Address(String addr)
```
  - isPrivateIPv4Address
```
public static boolean isPrivateIPv4Address(String addr)
```
    Checks if the address is one of the allocated private blocks
    
    Parameters:
    
    addr - The address string
    
    Returns:
    
    true if this is one of the allocated private blocks. Note: it assumes that the address string is indeed an IPv4 address
    
    See Also:
    
    isIPv4Address(String), PRIVATE_CLASS_A_PREFIX, PRIVATE_CLASS_B_PREFIX, PRIVATE_CLASS_C_PREFIX, Wiki page
  - isCarrierGradeNatIPv4Address
```
public static boolean isCarrierGradeNatIPv4Address(String addr)
```
    Parameters:
    
    addr - The address to be checked
    
    Returns:
    
    true if the address is in the 100.64.0.0/10 range
    
    See Also:
    
    RFC6598
  - isValidIPv4AddressComponent
```
public static boolean isValidIPv4AddressComponent(CharSequence c)
```
    Checks if the provided argument is a valid IPv4 address component:
    - Not null/empty
    - Has at most 3 digits
    - Its value is ≤ 255
    Parameters:
    
    c - The CharSequence to be validate
    
    Returns:
    
    true if valid IPv4 address component

Class SshdSocketAddress

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCALHOST_NAME

LOCALHOST_IP

IP_ANYADDR

PRIVATE_CLASS_A_PREFIX

PRIVATE_CLASS_B_PREFIX

PRIVATE_CLASS_C_PREFIX

CARRIER_GRADE_NAT_PREFIX

BROADCAST_ADDRESS

LOCALHOST_ADDRESS

BY_HOST_ADDRESS

BY_HOST_AND_PORT

Constructor Detail

SshdSocketAddress

SshdSocketAddress

Method Detail

getHostName

getPort

toInetSocketAddress

toString

isEquivalent

equals

hashCode

getFirstExternalNetwork4Address

getExternalNetwork4Addresses

isValidHostAddress

isLoopback

isLoopback

toSshdSocketAddress

toAddressString

toAddressPort

toInetSocketAddress

toAddressString

isIPv4Address

isPrivateIPv4Address

isCarrierGradeNatIPv4Address

isValidIPv4AddressComponent