com.hp.sdn.model

Interface NodeInfo

All Superinterfaces:

ModelInfo<NodeInfo.Field>

All Known Implementing Classes:

DefaultNodeInfo

public interface NodeInfo
extends ModelInfo<NodeInfo.Field>

Updatable information about a specific node. See Node for the complete information for a specific node.

Author:

Thomas Vachuska

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NodeInfo.Field Fields which indicate portions of the node information that have been specified.

Method Summary

Methods

Modifier and Type	Method and Description
NodeLocation	location() Returns the most recent node location.
MacAddress	mac() Returns the node's MAC address.
Interface	netInterface() Returns the network interface through which the node attaches to the network.
long	timeout() Returns the time offset (in seconds) at which the node will be removed.
NetworkElement.Type	type() Returns the node type.

Methods inherited from interface com.hp.sdn.model.ModelInfo

dirtyFields

Method Detail

netInterface

Interface netInterface()

Returns the network interface through which the node attaches to the network. This is an interface on the node itself, not the interface on a Device to which the node is attached.

Returns:

node network interface; null if unspecified

type

NetworkElement.Type type()

Returns the node type. If the type has not been specified, then null is returned.

Returns:

node type; null if unspecified

location

NodeLocation location()

Returns the most recent node location. If the location has not been specified, then null is returned.

Returns:

node location; null if unspecified

mac

MacAddress mac()

Returns the node's MAC address. If the MAC has not been specified, then null is returned.

Returns:

node MAC; null if unspecified

timeout

long timeout()

Returns the time offset (in seconds) at which the node will be removed. A value of Long.MAX_VALUE indicates an infinite offset, which means the node will never be automatically removed. A value of 0 indicates that the value has not been specified.

Returns:

node removal time offset, in seconds