com.hp.sdn.link

Interface LinkService

All Known Implementing Classes:

LinkServiceAdapter

public interface LinkService

Set of services to allow consumers to query the network information base regarding the available infrastructure link information.

Author:

Thomas Vachuska, Uyen Chau, Simon Hunt, Marjorie Krueger

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(LinkListener listener) Adds the specified link update listener.
Iterator<Link>	getLinks() Returns an iterator over the set of all infrastructure links.
Set<Link>	getLinks(ConnectionPoint cp) Returns the link(s) that contain the given connection point.
Set<Link>	getLinks(DeviceId device) Returns the set of all links for which the given device is either the source or the destination.
Set<Link>	getLinks(DeviceId deviceA, DeviceId deviceB) Returns the set of all links between the two given devices.
Set<Link>	getLinksFrom(ConnectionPoint src) Returns the set of all links for which this connection point is the source.
Set<Link>	getLinksFrom(DeviceId device) Returns the set of all links for which this device is the source.
Set<Link>	getLinksTo(ConnectionPoint dst) Returns the set of all links for which this connection point is the destination.
Set<Link>	getLinksTo(DeviceId device) Returns the set of all links for which this device is the destination.
Set<LinkListener>	getListeners() Returns the set of all link update listeners.
void	removeListener(LinkListener listener) Removes the specified link update listener.

Method Detail

getLinks

Iterator<Link> getLinks()

Returns an iterator over the set of all infrastructure links.

Returns:

all links

getLinks

Set<Link> getLinks(DeviceId device)

Returns the set of all links for which the given device is either the source or the destination. If no such links exist, an empty set is returned.

Parameters:

device - the device ID

Returns:

the set of matching links

Throws:

NullPointerException - if device is null

getLinks

Set<Link> getLinks(DeviceId deviceA,
                 DeviceId deviceB)

Returns the set of all links between the two given devices. If no such links exist, an empty set is returned.

Parameters:

deviceA - the first device ID

deviceB - the second device ID

Returns:

the set of matching links

Throws:

NullPointerException - if any param is null

getLinksFrom

Set<Link> getLinksFrom(DeviceId device)

Returns the set of all links for which this device is the source. If no such links exist, an empty set is returned.

Parameters:

device - the device ID

Returns:

the set of matching links

Throws:

NullPointerException - if any param is null

getLinksTo

Set<Link> getLinksTo(DeviceId device)

Returns the set of all links for which this device is the destination. If no such links exist, an empty set is returned.

Parameters:

device - the device ID

Returns:

the set of matching links

Throws:

NullPointerException - if device is null

getLinks

Set<Link> getLinks(ConnectionPoint cp)

Returns the link(s) that contain the given connection point. If no such links exist, an empty set is returned.

Note that a connection point can appear to be part of more than one link when switches not connected to this controller are in the path.

Parameters:

cp - the connection point to match

Returns:

the set of matching links

Throws:

NullPointerException - if cp is null

getLinksFrom

Set<Link> getLinksFrom(ConnectionPoint src)

Returns the set of all links for which this connection point is the source. If no such links exist, an empty set is returned.

Parameters:

src - the source connection point

Returns:

the set of matching links

Throws:

NullPointerException - if src is null

getLinksTo

Set<Link> getLinksTo(ConnectionPoint dst)

Returns the set of all links for which this connection point is the destination. If no such links exist, an empty set is returned.

Parameters:

dst - the source connection point

Returns:

the set of matching links

Throws:

NullPointerException - if dst is null

addListener

void addListener(LinkListener listener)

Adds the specified link update listener.

Parameters:

listener - the listener to be added

Throws:

NullPointerException - if the listener is null

removeListener

void removeListener(LinkListener listener)

Removes the specified link update listener.

Parameters:

listener - the listener to be removed

Throws:

NullPointerException - if the listener is null

getListeners

Set<LinkListener> getListeners()

Returns the set of all link update listeners.

Returns:

all link listeners