com.hp.sdn.node

Interface NodeService

All Known Implementing Classes:

NodeServiceAdapter

public interface NodeService

Provides read-only access to node-related information in the network model. For write access, see NodeSupplierService.

Author:

Shaun Wackerly, Vikram Bobade

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(NodeListener listener) Registers a listener for all node-related events.
Set<NodeListener>	getListeners() Returns the set of listeners for node-related events.
Node	getNode(IpAddress ip, SegmentId segmentId) Returns a specific node from the domain, based upon the globally-unique combination of IpAddress and SegmentId.
Node	getNode(NodeId id) Returns a specific node from the domain, based upon the globally-unique node ID.
Iterator<Node>	getNodes() Returns an iterator over all nodes in the domain.
Set<Node>	getNodes(ConnectionPoint cp) Returns all nodes in the domain where the nodes' most recent location matches the given connection point.
Set<Node>	getNodes(DeviceId device) Returns all nodes in the domain where the nodes' most recent location matches a connection point on the given device ID.
Set<Node>	getNodes(IpAddress ip) Returns all nodes in the domain with a given IP address.
Set<Node>	getNodes(MacAddress mac, SegmentId segmentId) Returns all nodes in the domain with a given MAC address.
Iterator<Node>	getNodes(NodeFilter filter) Returns an iterator over all nodes which match the given filter in the domain.
Iterator<Node>	getNodes(SegmentId segId) Returns an iterator all nodes in a given segment within the domain.
void	removeListener(NodeListener listener) Unregisters a listener from node-related events, regardless of which node-related events the listener was registered to receive.

Method Detail

getNodes

Iterator<Node> getNodes()

Returns an iterator over all nodes in the domain.

Returns:

an iterator over the set of all nodes

getNodes

Iterator<Node> getNodes(SegmentId segId)

Returns an iterator all nodes in a given segment within the domain.

Parameters:

segId - the given segment ID

Returns:

an iterator over the set of all nodes in the given network

getNodes

Set<Node> getNodes(IpAddress ip)

Returns all nodes in the domain with a given IP address. Each node returned is guaranteed to be on a unique SegmentId.

If no matches exist, an empty set will be returned.

Parameters:

ip - the given IP address

Returns:

a set of all nodes with the given IP address

getNodes

Set<Node> getNodes(MacAddress mac,
                 SegmentId segmentId)

Returns all nodes in the domain with a given MAC address. Each node returned is guaranteed to have a unique IpAddress within the given SegmentId.

If no matches exist, an empty set will be returned.

Parameters:

mac - the given MAC address

segmentId - the given segment ID

Returns:

a set of all nodes with the given MAC address

getNodes

Set<Node> getNodes(ConnectionPoint cp)

Returns all nodes in the domain where the nodes' most recent location matches the given connection point.

If no matches exist, an empty set will be returned.

Parameters:

cp - the given connection point

Returns:

a set of all nodes at the given location

getNodes

Set<Node> getNodes(DeviceId device)

Returns all nodes in the domain where the nodes' most recent location matches a connection point on the given device ID.

If no matches exist, an empty set will be returned.

Parameters:

device - the given device ID

Returns:

a set of all nodes on the given device

getNodes

Iterator<Node> getNodes(NodeFilter filter)

Returns an iterator over all nodes which match the given filter in the domain.

Parameters:

filter - the given filter

Returns:

an iterator over the set of all nodes which match the given filter

getNode

Node getNode(IpAddress ip,
           SegmentId segmentId)

Returns a specific node from the domain, based upon the globally-unique combination of IpAddress and SegmentId.

Parameters:

ip - IP address

segmentId - segment ID

Returns:

the matching node; null if not found

getNode

Node getNode(NodeId id)

Returns a specific node from the domain, based upon the globally-unique node ID.

Parameters:

id - Node ID

Returns:

the matching node; null if not found

addListener

void addListener(NodeListener listener)

Registers a listener for all node-related events. This registration will override any prior listener registrations for the same object.

Parameters:

listener - the event listener

removeListener

void removeListener(NodeListener listener)

Unregisters a listener from node-related events, regardless of which node-related events the listener was registered to receive.

Parameters:

listener - the event listener

Throws:

IllegalArgumentException - if the listener was not registered

getListeners

Set<NodeListener> getListeners()

Returns the set of listeners for node-related events.

Returns:

set of listeners