org.ws4d.java.communication.connection.ip

Class IPNetworkDetection

java.lang.Object

org.ws4d.java.communication.connection.ip.IPNetworkDetection

Direct Known Subclasses:

IPNetworkDetectionNotCLDC

public abstract class IPNetworkDetection
extends java.lang.Object

This abstract class defines some methods for the platform specific network detection.

Field Summary

Fields

Modifier and Type	Field and Description
static IPAddress	ANY_LOCAL_V4_ADDRESS
static IPAddress	ANY_LOCAL_V6_ADDRESS
static java.lang.String	IPv4
protected HashMap	ipv4Address2InterfaceList
protected HashMap	ipv4Addresses
protected HashMap	ipv4AddressesNotUseableButInBinding
protected HashMap	ipv4DiscoveryDomains
protected HashMap	ipv4discoveryDomainsNotUseableButInBinding
protected IPAddress	IPv4LoopbackAddress
static java.lang.String	IPv6
protected HashMap	ipv6Address2InterfaceList
protected HashMap	ipv6Addresses
protected HashMap	ipv6AddressesNotUseableButInBinding
protected HashMap	ipv6DiscoveryDomains
protected HashMap	ipv6discoveryDomainsNotUseableButInBinding
protected HashMap	networkChangeListener
protected HashMap	networkinterfaces

Constructor Summary

Constructors

Constructor and Description
IPNetworkDetection()

Method Summary

Modifier and Type	Method and Description
void	addNetworkChangeListener(NetworkChangeListener listener)
protected void	checkInitiatedAddresses()
protected void	checkInitiatedInterfaces()
protected void	checkInitiatedIPDomains()
protected IPAddress	getAddress(HashMap addressMap, java.lang.Long[] key)
Iterator	getAddressesForInterface(boolean isIPv6, java.lang.String ifaceName) Returns an iterator with all available addresses.
Iterator	getAllAddresses() Returns an iterator with all available addresses.
Iterator	getAllAddresses(boolean excludeLoopback) Returns an iterator with all available addresses.
Iterator	getAllAddressesForInterface(java.lang.String ifaceName)
Iterator	getAllAvailableDiscoveryDomains()
int	getAllAvailableDiscoveryDomainsSize()
IPAddress	getAssignedIPAddressForInterface(NetworkInterface iface, boolean useIPv6)
Iterator	getAvailableDiscoveryDomains(boolean useIPv6)
Iterator	getAvailableDiscoveryDomainsForInterfaces(DataStructure interfaces, boolean useIPv6)
abstract java.lang.String	getCanonicalAddress(java.lang.String address) This method returns the canonical form of the supplied address.
static IPNetworkDetection	getInstance()
IPAddress	getIPAddressOfAnyLocalInterface(java.lang.String address, boolean useAnyLocalAddress) Looks for the given ipaddress if it is an local address.If useAnyLocalAddress is true anyLocalAddress(0.0.0.0) is returning.
protected IPAddress	getIPAddressOfAnyLocalInterface(java.lang.String address, boolean useAnyLocalAddress, java.lang.Long[] key)
IPDiscoveryDomain	getIPDiscoveryDomainForInterface(NetworkInterface iface, boolean useIPv6)
Iterator	getIPv4Addresses() Returns an iterator with all available ipv4 addresses.
Iterator	getIPv4Addresses(boolean excludeLoopback) Returns an iterator with all available ipv4 addresses.
Iterator	getIPv6Addresses() Returns an iterator with all available ipv6 addresses.
Iterator	getIPv6Addresses(boolean excludeLoopback) Returns an iterator with all available ipv6 addresses.
NetworkInterface	getNetworkInterface(java.lang.String name) Returns the network interface found for the given name.
java.lang.String[]	getNetworkInterfaceNames()
Iterator	getNetworkInterfaces() Returns all network interfaces found on this platform.
int	getNetworkInterfacesCount()
DataStructure	getNetworkInterfacesForAddress(IPAddress ipAddress) Returns the NetworkInterfaces which has the ipAddress or null if no interfaces with ipAddress is available
boolean	hasIPAddress(java.lang.Long[] key)
protected void	prepareMaps()
protected void	putAddress(IPAddress ipAddress)
abstract void	refreshNetworkInterfaces()
protected void	removeAddress(IPAddress ipAddress, boolean inUse)
void	removeNetworkChangeListener(NetworkChangeListener listener)
abstract void	startRefreshNetworkInterfacesThread()
abstract void	stopRefreshNetworkInterfacesThread()

Methods inherited from class java.lang.Object

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

Field Detail

IPv4

public static final java.lang.String IPv4

See Also:

Constant Field Values

IPv6

public static final java.lang.String IPv6

See Also:

Constant Field Values

ANY_LOCAL_V4_ADDRESS

public static final IPAddress ANY_LOCAL_V4_ADDRESS

ANY_LOCAL_V6_ADDRESS

public static final IPAddress ANY_LOCAL_V6_ADDRESS

networkinterfaces

protected volatile HashMap networkinterfaces

ipv4Addresses

protected volatile HashMap ipv4Addresses

ipv4AddressesNotUseableButInBinding

protected volatile HashMap ipv4AddressesNotUseableButInBinding

ipv6Addresses

protected volatile HashMap ipv6Addresses

ipv6AddressesNotUseableButInBinding

protected volatile HashMap ipv6AddressesNotUseableButInBinding

IPv4LoopbackAddress

protected volatile IPAddress IPv4LoopbackAddress

ipv4DiscoveryDomains

protected volatile HashMap ipv4DiscoveryDomains

ipv4discoveryDomainsNotUseableButInBinding

protected volatile HashMap ipv4discoveryDomainsNotUseableButInBinding

ipv6DiscoveryDomains

protected volatile HashMap ipv6DiscoveryDomains

ipv6discoveryDomainsNotUseableButInBinding

protected volatile HashMap ipv6discoveryDomainsNotUseableButInBinding

ipv4Address2InterfaceList

protected HashMap ipv4Address2InterfaceList

ipv6Address2InterfaceList

protected HashMap ipv6Address2InterfaceList

networkChangeListener

protected HashMap networkChangeListener

Constructor Detail

IPNetworkDetection

public IPNetworkDetection()

Method Detail

getInstance

public static IPNetworkDetection getInstance()

checkInitiatedInterfaces

protected void checkInitiatedInterfaces()

checkInitiatedAddresses

protected void checkInitiatedAddresses()

checkInitiatedIPDomains

protected void checkInitiatedIPDomains()

prepareMaps

protected void prepareMaps()

getNetworkInterfaces

public final Iterator getNetworkInterfaces()

Returns all network interfaces found on this platform. Starts an interface detection phase if necessary.

Returns:

all network interfaces.

getNetworkInterfacesCount

public final int getNetworkInterfacesCount()

getNetworkInterfaceNames

public final java.lang.String[] getNetworkInterfaceNames()

getNetworkInterface

public final NetworkInterface getNetworkInterface(java.lang.String name)

Returns the network interface found for the given name.

Parameters:

name -

Returns:

network interface

getNetworkInterfacesForAddress

public final DataStructure getNetworkInterfacesForAddress(IPAddress ipAddress)

Returns the NetworkInterfaces which has the ipAddress or null if no interfaces with ipAddress is available

Parameters:

ipAddress -

Returns:

getAllAddresses

public Iterator getAllAddresses()

Returns an iterator with all available addresses.

Returns:

iterator over every IPAddress

getAllAddresses

public Iterator getAllAddresses(boolean excludeLoopback)

Returns an iterator with all available addresses.

Parameters:

excludeLoopback -

Returns:

getIPv4Addresses

public Iterator getIPv4Addresses()

Returns an iterator with all available ipv4 addresses.

Returns:

iterator over all ipv4 addresses

getIPv4Addresses

public Iterator getIPv4Addresses(boolean excludeLoopback)

Returns an iterator with all available ipv4 addresses.

Parameters:

excludeLoopback -

Returns:

getIPv6Addresses

public Iterator getIPv6Addresses()

Returns an iterator with all available ipv6 addresses.

Returns:

iterator over all ipv6 addresses

getIPv6Addresses

public Iterator getIPv6Addresses(boolean excludeLoopback)

Returns an iterator with all available ipv6 addresses.

Parameters:

excludeLoopback -

Returns:

getAllAddressesForInterface

public Iterator getAllAddressesForInterface(java.lang.String ifaceName)

getAddressesForInterface

public Iterator getAddressesForInterface(boolean isIPv6,
                                         java.lang.String ifaceName)

Returns an iterator with all available addresses. Filtered by the type of protocol or by the interface name.

Parameters:

protocol -

ifaceName - for example eth0 or null for wildcard.

Returns:

iterator

getIPAddressOfAnyLocalInterface

public IPAddress getIPAddressOfAnyLocalInterface(java.lang.String address,
                                                 boolean useAnyLocalAddress)

Looks for the given ipaddress if it is an local address.If useAnyLocalAddress is true anyLocalAddress(0.0.0.0) is returning. If no matching interface with address is found null is returning.

Parameters:

address -

useAnyLocalAddress -

Returns:

getIPAddressOfAnyLocalInterface

protected IPAddress getIPAddressOfAnyLocalInterface(java.lang.String address,
                                                    boolean useAnyLocalAddress,
                                                    java.lang.Long[] key)

getAssignedIPAddressForInterface

public IPAddress getAssignedIPAddressForInterface(NetworkInterface iface,
                                                  boolean useIPv6)

hasIPAddress

public boolean hasIPAddress(java.lang.Long[] key)

getAllAvailableDiscoveryDomains

public Iterator getAllAvailableDiscoveryDomains()

getAllAvailableDiscoveryDomainsSize

public int getAllAvailableDiscoveryDomainsSize()

getAvailableDiscoveryDomains

public Iterator getAvailableDiscoveryDomains(boolean useIPv6)

getIPDiscoveryDomainForInterface

public IPDiscoveryDomain getIPDiscoveryDomainForInterface(NetworkInterface iface,
                                                          boolean useIPv6)

getAvailableDiscoveryDomainsForInterfaces

public Iterator getAvailableDiscoveryDomainsForInterfaces(DataStructure interfaces,
                                                          boolean useIPv6)

putAddress

protected void putAddress(IPAddress ipAddress)

removeAddress

protected void removeAddress(IPAddress ipAddress,
                             boolean inUse)

getAddress

protected IPAddress getAddress(HashMap addressMap,
                               java.lang.Long[] key)

addNetworkChangeListener

public void addNetworkChangeListener(NetworkChangeListener listener)

removeNetworkChangeListener

public void removeNetworkChangeListener(NetworkChangeListener listener)

getCanonicalAddress

public abstract java.lang.String getCanonicalAddress(java.lang.String address)

This method returns the canonical form of the supplied address.

Parameters:

address - either an IPv4, IPv6 address or a DNS name

Returns:

the canonical address corresponding to address, usually an IP address

startRefreshNetworkInterfacesThread

public abstract void startRefreshNetworkInterfacesThread()

stopRefreshNetworkInterfacesThread

public abstract void stopRefreshNetworkInterfacesThread()

refreshNetworkInterfaces

public abstract void refreshNetworkInterfaces()
                                       throws java.io.IOException

Throws:

java.io.IOException