org.springframework.data.hadoop.util.net

Class DefaultHostInfoDiscovery

java.lang.Object

org.springframework.data.hadoop.util.net.DefaultHostInfoDiscovery

All Implemented Interfaces:

HostInfoDiscovery

public class DefaultHostInfoDiscovery
extends Object
implements HostInfoDiscovery

Default implementation of HostInfoDiscovery.

Discovery logic for finding ip address is:

• all possible network interfaces are requested
• for interfaces, filter out point to point if not enabled
• for interfaces, filter out loopback if not enabled
• for interfaces, explicit regex patter match is done if pattern is set
• interfaces are sort by preferred name prefixes, on default "eth" and "en" are sort first
• interfaces are sorted by their indexes assuming eth0 should be picked over eth1
• interfaces are checked by their list of ip addresses
• only ipv4 ip's are taken
• cidr notation to match if from a network/mask is taken in defined
• what is left, first found ip is taken

Author:

Janne Valkealahti

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.hadoop.util.net.HostInfoDiscovery

HostInfoDiscovery.HostInfo

Constructor Summary

Constructors

Constructor and Description
DefaultHostInfoDiscovery()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<NetworkInterface>	getAllAvailableInterfaces()
HostInfoDiscovery.HostInfo	getHostInfo() Gets the host info.
void	setLoopback(boolean loopback) Sets if loopback should be discovered.
void	setMatchInterface(String matchInterface) Use interface as a candidate if its name is matching with a given pattern.
void	setMatchIpv4(String matchIpv4) Sets the match ipv4.
void	setPointToPoint(boolean pointToPoint) Sets if interfaces marked as point to point should be handled.
void	setPreferInterface(List<String> preferInterface) Sets the preferred interfaces.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultHostInfoDiscovery

public DefaultHostInfoDiscovery()

Method Detail

getHostInfo

public HostInfoDiscovery.HostInfo getHostInfo()

Description copied from interface: HostInfoDiscovery

Gets the host info.

Specified by:

getHostInfo in interface HostInfoDiscovery

Returns:

the host info

setMatchIpv4

public void setMatchIpv4(String matchIpv4)

Sets the match ipv4. Used to match ip address from a network using a cidr notation. For example, "192.168.0.1/24" matches range "192.168.0.1-192.168.0.254", "192.168.0.1/16" matches ranre "192.168.0.1-192.168.255.254" and "10.0.0.1/8" matches range "10.0.0.1-10.255.255.254"

Parameters:

matchIpv4 - the new match ipv4

setMatchInterface

public void setMatchInterface(String matchInterface)

Use interface as a candidate if its name is matching with a given pattern. Default value is is empty.

Parameters:

matchInterface - the new match interface regex patter

See Also:

NetworkInterface.getName()

setPreferInterface

public void setPreferInterface(List<String> preferInterface)

Sets the preferred interfaces. Sort interfaces in such order that interface names prefixed with values found from a list is considered first candidates. Defaults to "eth" and "en" which usually are the ones found from unix systems.

Parameters:

preferInterface - the new preferred interface list

setPointToPoint

public void setPointToPoint(boolean pointToPoint)

Sets if interfaces marked as point to point should be handled. Point to point nic is usually a vpn tunnel which may not be no use to talk to a host unless communication goes through vpn. Default value is FALSE.

Parameters:

pointToPoint - the new point to point flag

See Also:

NetworkInterface.isPointToPoint()

setLoopback

public void setLoopback(boolean loopback)

Sets if loopback should be discovered. Default value is FALSE.

Parameters:

loopback - the new loopback flag

getAllAvailableInterfaces

protected List<NetworkInterface> getAllAvailableInterfaces()
                                                    throws SocketException

Throws:

SocketException

toString

public String toString()

Overrides:

toString in class Object