org.onosproject.vtnrsc.subnet

Interface SubnetService

All Known Implementing Classes:

SubnetManager

public interface SubnetService

Service for interacting with the inventory of subnets.

Method Summary

Modifier and Type	Method and Description
boolean	createSubnets(Iterable<Subnet> subnets) Creates new subnets.
boolean	exists(SubnetId subnetId) Returns the subnet with the specified identifier.
Subnet	getSubnet(SubnetId subnetId) Returns the subnet with the specified identifier.
Iterable<Subnet>	getSubnets() Returns a collection of the currently known subnets.
boolean	removeSubnets(Iterable<SubnetId> subnetIds) Administratively removes the specified subnets from the store.
boolean	updateSubnets(Iterable<Subnet> subnets) Updates existing subnets.

Method Detail

exists

boolean exists(SubnetId subnetId)

Returns the subnet with the specified identifier.

Parameters:

subnetId - subnet identifier

Returns:

true or false

getSubnets

Iterable<Subnet> getSubnets()

Returns a collection of the currently known subnets.

Returns:

iterable collection of subnets

getSubnet

Subnet getSubnet(SubnetId subnetId)

Returns the subnet with the specified identifier.

Parameters:

subnetId - subnet identifier

Returns:

subnet or null if one with the given identifier is not known

createSubnets

boolean createSubnets(Iterable<Subnet> subnets)

Creates new subnets.

Parameters:

subnets - the iterable collection of subnets

Returns:

true if the identifier subnet has been created right

updateSubnets

boolean updateSubnets(Iterable<Subnet> subnets)

Updates existing subnets.

Parameters:

subnets - the iterable collection of subnets

Returns:

true if all subnets were updated successfully

removeSubnets

boolean removeSubnets(Iterable<SubnetId> subnetIds)

Administratively removes the specified subnets from the store.

Parameters:

subnetIds - the iterable collection of subnets identifier

Returns:

true if remove identifier subnets successfully