org.ws4d.java.communication.structures

Class IPAutoInterfaceCommons

java.lang.Object

org.ws4d.java.communication.structures.IPAutoInterfaceCommons

All Implemented Interfaces:

NetworkInterfaceChangeListener, CommunicationStructureListener, NetworkChangeListener, MementoSupport

Direct Known Subclasses:

IPCommunicationAutoBinding, IPDiscoveryAutoBinding

public abstract class IPAutoInterfaceCommons
extends java.lang.Object
implements NetworkInterfaceChangeListener, NetworkChangeListener, MementoSupport

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	addressFamilies
protected java.lang.String	comManId
protected CredentialInfo	credentialInfo
protected java.lang.String[]	interfaceNames
protected HashMap	interfaces
static java.lang.String	IPADDRESS_FAMILY_IPV4
static java.lang.String	IPADDRESS_FAMILY_IPV6
protected boolean	ipv4
protected boolean	ipv6
protected DataStructure	listenerList
protected HashMap	loopbackInterfaces
protected boolean	suppressLoopbackIfPossible if suppressLoopbackIfPossible is "true" loopback interface will not used for bindings if any not loopback interfaces available.
protected boolean	suppressMulticastDisabledInterfaces

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IPAutoInterfaceCommons()
protected	IPAutoInterfaceCommons(java.lang.String comManId)
protected	IPAutoInterfaceCommons(java.lang.String comManId, java.lang.String[] interfacesNames, java.lang.String[] addressFamilies, boolean suppressLoopbackIfPossible, boolean suppressMulticastDisabledInterfaces)

Method Summary

Modifier and Type	Method and Description
protected void	addInterface(NetworkInterface iface)
boolean	equals(java.lang.Object obj)
java.lang.String[]	getAddressFamilies() Returns all address families.
DataStructure	getAllInterfaces() Returns all Interfaces.
java.lang.String	getCommunicationManagerId() Returns the CommunicationManager id.
CredentialInfo	getCredentialInfo() Returns the CredentialInfo.
java.lang.String[]	getInterfaceNames() Returns all interface names.
DataStructure	getInterfaces() Returns all not loopback interfaces.
DataStructure	getLoopbackInterfaces() Returns all loopback interfaces.
int	hashCode()
protected void	initAutoBinding(java.lang.String[] interfacesNames, java.lang.String[] addressFamilies)
protected boolean	interfaceNamesContainsIfaceName(java.lang.String ifaceName)
boolean	isIpv4() Returns whether ipv4 is enabled for this autoBinding.
boolean	isIpv6() Returns whether ipv6 is enabled for this autoBinding.
boolean	isSuppressLoopbackIfPossible() Returns whether suppress loopback interfaces if possible.
boolean	isSuppressMulticastDisabledInterfaces() Returns whether suppress multicast disabled interfaces.
void	readFromMemento(Memento m)
void	saveToMemento(Memento m)
void	setCredentialInfo(CredentialInfo credentialInfo) Sets the CredentialInfo if given CredentialInfo is not null or CredentialInfo.EMPTY_CREDENTIAL_INFO.
void	startUpdates() Announce all listener that updates can be perfomed from now.
void	stopUpdates() Announce all listener that no more updates will be announced from now.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ws4d.java.communication.connection.ip.listener.NetworkInterfaceChangeListener

announceAddressesAdded, announceAddressesChanged, announceAddressesDeleted, announceInterfaceDown, announceInterfaceNotAvailable, announceInterfaceUp, announceSupportsMulticastChanged

Methods inherited from interface org.ws4d.java.service.listener.NetworkChangeListener

announceNewInterfaceAvailable

Field Detail

IPADDRESS_FAMILY_IPV4

public static final java.lang.String IPADDRESS_FAMILY_IPV4

See Also:

Constant Field Values

IPADDRESS_FAMILY_IPV6

public static final java.lang.String IPADDRESS_FAMILY_IPV6

See Also:

Constant Field Values

ipv4

protected boolean ipv4

ipv6

protected boolean ipv6

suppressLoopbackIfPossible

protected boolean suppressLoopbackIfPossible

if suppressLoopbackIfPossible is "true" loopback interface will not used for bindings if any not loopback interfaces available.

suppressMulticastDisabledInterfaces

protected boolean suppressMulticastDisabledInterfaces

interfaceNames

protected java.lang.String[] interfaceNames

addressFamilies

protected java.lang.String[] addressFamilies

interfaces

protected HashMap interfaces

loopbackInterfaces

protected HashMap loopbackInterfaces

credentialInfo

protected CredentialInfo credentialInfo

listenerList

protected DataStructure listenerList

comManId

protected java.lang.String comManId

Constructor Detail

IPAutoInterfaceCommons

protected IPAutoInterfaceCommons()

IPAutoInterfaceCommons

protected IPAutoInterfaceCommons(java.lang.String comManId)

IPAutoInterfaceCommons

protected IPAutoInterfaceCommons(java.lang.String comManId,
                                 java.lang.String[] interfacesNames,
                                 java.lang.String[] addressFamilies,
                                 boolean suppressLoopbackIfPossible,
                                 boolean suppressMulticastDisabledInterfaces)

Method Detail

initAutoBinding

protected void initAutoBinding(java.lang.String[] interfacesNames,
                               java.lang.String[] addressFamilies)

addInterface

protected void addInterface(NetworkInterface iface)

getCommunicationManagerId

public java.lang.String getCommunicationManagerId()

Returns the CommunicationManager id.

Returns:

CommunicationManager id

getCredentialInfo

public CredentialInfo getCredentialInfo()

Returns the CredentialInfo.

Returns:

the CredentialInfo

setCredentialInfo

public void setCredentialInfo(CredentialInfo credentialInfo)

Sets the CredentialInfo if given CredentialInfo is not null or CredentialInfo.EMPTY_CREDENTIAL_INFO.

Parameters:

credentialInfo -

getAllInterfaces

public DataStructure getAllInterfaces()

Returns all Interfaces.

Returns:

all interfaces.

getInterfaces

public DataStructure getInterfaces()

Returns all not loopback interfaces.

Returns:

all not loopback interfaces

getLoopbackInterfaces

public DataStructure getLoopbackInterfaces()

Returns all loopback interfaces.

Returns:

all loopback interfaces

interfaceNamesContainsIfaceName

protected boolean interfaceNamesContainsIfaceName(java.lang.String ifaceName)

startUpdates

public void startUpdates()

Description copied from interface: NetworkChangeListener

Announce all listener that updates can be perfomed from now.

Specified by:

startUpdates in interface NetworkChangeListener

stopUpdates

public void stopUpdates()

Description copied from interface: NetworkChangeListener

Announce all listener that no more updates will be announced from now.

Specified by:

stopUpdates in interface NetworkChangeListener

getInterfaceNames

public java.lang.String[] getInterfaceNames()

Returns all interface names.

Returns:

interfaces names

getAddressFamilies

public java.lang.String[] getAddressFamilies()

Returns all address families.

Returns:

all address families

isIpv4

public boolean isIpv4()

Returns whether ipv4 is enabled for this autoBinding.

Returns:

true if ipv4 is enabled, else false

isIpv6

public boolean isIpv6()

Returns whether ipv6 is enabled for this autoBinding.

Returns:

true if ipv6 is enabled, else false

isSuppressLoopbackIfPossible

public boolean isSuppressLoopbackIfPossible()

Returns whether suppress loopback interfaces if possible.

Returns:

true if suppress loopback interfaces if possible is activated, else false

isSuppressMulticastDisabledInterfaces

public boolean isSuppressMulticastDisabledInterfaces()

Returns whether suppress multicast disabled interfaces.

Returns:

true if suppress multicast disabled interfaces is activated, else false

saveToMemento

public void saveToMemento(Memento m)

Specified by:

saveToMemento in interface MementoSupport

readFromMemento

public void readFromMemento(Memento m)
                     throws java.io.IOException

Specified by:

readFromMemento in interface MementoSupport

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object