com.samysadi.acs.hardware.network

Interface NetworkInterface

All Superinterfaces:

Cloneable, Entity, FailureProneEntity, Notifier, Probed

All Known Implementing Classes:

NetworkInterfaceDefault

public interface NetworkInterface
extends Entity, FailureProneEntity

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.samysadi.acs.core.entity.FailureProneEntity

FailureProneEntity.FailureState

Method Summary

Methods

Modifier and Type	Method and Description
NetworkInterface	clone() The clone will have the same up and down links and ip / mask.
NetworkLink	getDownLink() Returns the down-link that is associated with this interface.
IpAddress	getIp() Returns the IP address of this networkInterface or null if no IP is set for this interface.
NetworkDevice	getParent() Returns the parent of this entity, or null if no parent is set
NetworkInterface	getRemoteNetworkInterface() Returns null or the remote interface that is connected to this interface through up-link or down-link.
NetworkLink	getUpLink() Returns the up-link that is associated with this interface.
void	setDownLink(NetworkLink link) Update the down-link associated with this interface. This link is used when downloading (ie: receiving data) from the remote interface.
void	setIp(IpAddress ip)
void	setUpLink(NetworkLink link) Update the up-link associated with this interface. This link is used when uploading (ie: sending data) to the remote interface.

Methods inherited from interface com.samysadi.acs.core.entity.FailureProneEntity

getFailureState, setFailureState, supportsFailureStateUpdate

Methods inherited from interface com.samysadi.acs.core.entity.Entity

addEntity, getConfig, getConfigRec, getEntities, getId, getLogger, getName, getProperties, getProperty, getProperty, hasParentRec, lockParent, lockParentRec, removeEntity, setConfig, setName, setParent, setProperty, unlockParent, unlockParentRec, unsetProperty

Methods inherited from interface com.samysadi.acs.core.notifications.Notifier

addGlobalListener, addListener, cancelNotifications, cleanupListeners, disableNotifications, enableNotifications, getGlobalListeners, getListeners, isNotificationsDisabled, notify, notifyNow, removeAllGlobalListeners, removeAllListeners, removeAllListeners, removeGlobalListener, removeListener

Methods inherited from interface com.samysadi.acs.core.tracing.Probed

addProbe, getProbe, getProbe, getProbes, removeProbe, removeProbe

Method Detail

clone

NetworkInterface clone()

The clone will have the same up and down links and ip / mask.

Specified by:

clone in interface Entity

Specified by:

clone in interface FailureProneEntity

Specified by:

clone in interface Notifier

getParent

NetworkDevice getParent()

Description copied from interface: Entity

Returns the parent of this entity, or null if no parent is set

Specified by:

getParent in interface Entity

Returns:

the parent of this entity, or null

getRemoteNetworkInterface

NetworkInterface getRemoteNetworkInterface()

Returns null or the remote interface that is connected to this interface through up-link or down-link.

Returns:

null or the remote interface that is connected to this interface through up-link or down-link

getUpLink

NetworkLink getUpLink()

Returns the up-link that is associated with this interface.

This link is used when uploading (ie: sending data) to the remote interface.

Returns:

the up-link that is associated with this interface

setUpLink

void setUpLink(NetworkLink link)

Update the up-link associated with this interface.
This link is used when uploading (ie: sending data) to the remote interface.

Will also ensure that the down-link of the remote network interface is the same as this interface's up-link. Thus, you don't need to call setDownLink(NetworkLink) on the remote interface after calling this.

Parameters:

link -

Throws:

IllegalArgumentException - if the given link cannot be assigned to this interface either because this interface is not one of the end-points of the link, or if the the remote interface of the down-link is not the same as the one that is specified in the given link

getDownLink

NetworkLink getDownLink()

Returns the down-link that is associated with this interface.

This link is used when downloading (ie: receiving data) from the remote interface.

Returns:

the down-link that is associated with this interface

setDownLink

void setDownLink(NetworkLink link)

Update the down-link associated with this interface.
This link is used when downloading (ie: receiving data) from the remote interface.

Will also ensure that the up-link of the remote network interface is the same as this interface's down-link. Thus, you don't need to call setUpLink(NetworkLink) on the remote interface after calling this.

Parameters:

link -

Throws:

IllegalArgumentException - if the given link cannot be assigned to this interface either because this interface is not one of the end-points of the link, or if the the remote interface of the up-link is not the same as the one that is specified in the given link

getIp

IpAddress getIp()

Returns the IP address of this networkInterface or null if no IP is set for this interface.

Returns:

the IP address of this networkInterface or null

setIp

void setIp(IpAddress ip)