org.onosproject.vtnrsc.virtualport

Interface VirtualPortService

All Known Implementing Classes:

VirtualPortManager

public interface VirtualPortService

Service for interacting with the inventory of virtualPort.

Method Summary

Modifier and Type	Method and Description
boolean	createPorts(Iterable<VirtualPort> virtualPorts) Creates virtualPorts by virtualPorts.
boolean	exists(VirtualPortId virtualPortId) Returns if the virtualPort is existed.
VirtualPort	getPort(VirtualPortId virtualPortId) Returns the virtualPort with the identifier.
Collection<VirtualPort>	getPorts() Returns the collection of the currently known virtualPort.
Collection<VirtualPort>	getPorts(org.onosproject.net.DeviceId deviceId) Returns the collection of the virtualPorts associated with the deviceId.
Collection<VirtualPort>	getPorts(TenantId tenantId) Returns the collection of the virtualPorts associated with the tenantId.
Collection<VirtualPort>	getPorts(TenantNetworkId networkId) Returns the collection of the virtualPorts associated with the networkId.
boolean	removePorts(Iterable<VirtualPortId> virtualPortIds) Deletes virtualPortIds by virtualPortIds.
boolean	updatePorts(Iterable<VirtualPort> virtualPorts) Updates virtualPorts by virtualPorts.

Method Detail

exists

boolean exists(VirtualPortId virtualPortId)

Returns if the virtualPort is existed.

Parameters:

virtualPortId - virtualPort identifier

Returns:

true or false if one with the given identifier is not existed.

getPort

VirtualPort getPort(VirtualPortId virtualPortId)

Returns the virtualPort with the identifier.

Parameters:

virtualPortId - virtualPort ID

Returns:

VirtualPort or null if one with the given ID is not know.

getPorts

Collection<VirtualPort> getPorts()

Returns the collection of the currently known virtualPort.

Returns:

collection of VirtualPort.

getPorts

Collection<VirtualPort> getPorts(TenantNetworkId networkId)

Returns the collection of the virtualPorts associated with the networkId.

Parameters:

networkId - the network identifer

Returns:

collection of virtualPort.

getPorts

Collection<VirtualPort> getPorts(TenantId tenantId)

Returns the collection of the virtualPorts associated with the tenantId.

Parameters:

tenantId - the tenant identifier

Returns:

collection of virtualPorts.

getPorts

Collection<VirtualPort> getPorts(org.onosproject.net.DeviceId deviceId)

Returns the collection of the virtualPorts associated with the deviceId.

Parameters:

deviceId - the device identifier

Returns:

collection of virtualPort.

createPorts

boolean createPorts(Iterable<VirtualPort> virtualPorts)

Creates virtualPorts by virtualPorts.

Parameters:

virtualPorts - the iterable collection of virtualPorts

Returns:

true if all given identifiers created successfully.

updatePorts

boolean updatePorts(Iterable<VirtualPort> virtualPorts)

Updates virtualPorts by virtualPorts.

Parameters:

virtualPorts - the iterable collection of virtualPorts

Returns:

true if all given identifiers updated successfully.

removePorts

boolean removePorts(Iterable<VirtualPortId> virtualPortIds)

Deletes virtualPortIds by virtualPortIds.

Parameters:

virtualPortIds - the iterable collection of virtualPort identifiers

Returns:

true or false if one with the given identifier to delete is successfully.