org.onosproject.vtnrsc.portpair

Interface PortPairService

All Superinterfaces:

org.onosproject.event.ListenerService<PortPairEvent,PortPairListener>

All Known Implementing Classes:

PortPairManager

public interface PortPairService
extends org.onosproject.event.ListenerService<PortPairEvent,PortPairListener>

Service for interacting with the inventory of port pairs.

Method Summary

Modifier and Type	Method and Description
boolean	createPortPair(PortPair portPair) Creates a PortPair in the store.
boolean	exists(PortPairId portPairId) Returns if the port pair is existed.
PortPair	getPortPair(PortPairId portPairId) Returns the portPair with the given identifier.
int	getPortPairCount() Returns the number of port pairs known to the system.
Iterable<PortPair>	getPortPairs() Returns an iterable collection of the currently known port pairs.
boolean	removePortPair(PortPairId portPairId) Deletes portPair by given portPairId.
boolean	updatePortPair(PortPair portPair) Updates the portPair in the store.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

exists

boolean exists(PortPairId portPairId)

Returns if the port pair is existed.

Parameters:

portPairId - port pair identifier

Returns:

true or false if one with the given identifier exists.

getPortPairCount

int getPortPairCount()

Returns the number of port pairs known to the system.

Returns:

number of port pairs.

getPortPairs

Iterable<PortPair> getPortPairs()

Returns an iterable collection of the currently known port pairs.

Returns:

collection of port pairs.

getPortPair

PortPair getPortPair(PortPairId portPairId)

Returns the portPair with the given identifier.

Parameters:

portPairId - port pair identifier

Returns:

PortPair or null if port pair with the given identifier is not known.

createPortPair

boolean createPortPair(PortPair portPair)

Creates a PortPair in the store.

Parameters:

portPair - the port pair to create

Returns:

true if given port pair is created successfully.

updatePortPair

boolean updatePortPair(PortPair portPair)

Updates the portPair in the store.

Parameters:

portPair - the port pair to update

Returns:

true if given port pair is updated successfully.

removePortPair

boolean removePortPair(PortPairId portPairId)

Deletes portPair by given portPairId.

Parameters:

portPairId - id of port pair to remove

Returns:

true if the give port pair is deleted successfully.