org.onosproject.vtnrsc.portchain

Interface PortChainService

All Superinterfaces:

org.onosproject.event.ListenerService<PortChainEvent,PortChainListener>

All Known Implementing Classes:

PortChainManager

public interface PortChainService
extends org.onosproject.event.ListenerService<PortChainEvent,PortChainListener>

Service for interacting with the inventory of port chains.

Method Summary

Modifier and Type	Method and Description
boolean	createPortChain(PortChain portChain) Creates a PortChain in the store.
boolean	exists(PortChainId portChainId) Returns if the port chain is existed.
PortChain	getPortChain(PortChainId portChainId) Returns the portChain with the given identifier.
int	getPortChainCount() Returns the number of port chains known to the system.
Iterable<PortChain>	getPortChains() Returns an iterable collection of the currently known port chains.
boolean	removePortChain(PortChainId portChainId) Deletes portChain by given portChainId.
boolean	updatePortChain(PortChain portChain) Updates the portChain in the store.

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Method Detail

exists

boolean exists(PortChainId portChainId)

Returns if the port chain is existed.

Parameters:

portChainId - port chain identifier

Returns:

true or false if one with the given identifier exists.

getPortChainCount

int getPortChainCount()

Returns the number of port chains known to the system.

Returns:

number of port chains.

getPortChains

Iterable<PortChain> getPortChains()

Returns an iterable collection of the currently known port chains.

Returns:

collection of port chains.

getPortChain

PortChain getPortChain(PortChainId portChainId)

Returns the portChain with the given identifier.

Parameters:

portChainId - port chain identifier

Returns:

PortChain or null if port chain with the given identifier is not known.

createPortChain

boolean createPortChain(PortChain portChain)

Creates a PortChain in the store.

Parameters:

portChain - the port chain to create

Returns:

true if given port chain is created successfully.

updatePortChain

boolean updatePortChain(PortChain portChain)

Updates the portChain in the store.

Parameters:

portChain - the port chain to update

Returns:

true if given port chain is updated successfully.

removePortChain

boolean removePortChain(PortChainId portChainId)

Deletes portChain by given portChainId.

Parameters:

portChainId - id of port chain to remove

Returns:

true if the give port chain is deleted successfully.