org.onosproject.vtnrsc

Class DefaultSubnet

java.lang.Object

org.onosproject.vtnrsc.DefaultSubnet

All Implemented Interfaces:

Subnet

public final class DefaultSubnet
extends Object
implements Subnet

Default implementation of Subnet interface .

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.vtnrsc.Subnet

Subnet.Mode

Constructor Summary

Constructors

Constructor and Description
DefaultSubnet(SubnetId id, String subnetName, TenantNetworkId networkId, TenantId tenantId, org.onlab.packet.IpAddress.Version ipVersion, org.onlab.packet.IpPrefix cidr, org.onlab.packet.IpAddress gatewayIp, boolean dhcpEnabled, boolean shared, Set<HostRoute> hostRoutes, Subnet.Mode ipV6AddressMode, Subnet.Mode ipV6RaMode, Set<AllocationPool> allocationPoolsIt) Creates a subnet object.

Method Summary

Modifier and Type	Method and Description
Iterable<AllocationPool>	allocationPools() Returns a collection of allocation_pools.
org.onlab.packet.IpPrefix	cidr() Returns the cidr.
boolean	dhcpEnabled() Returns true if DHCP is enabled and return false if DHCP is disabled.
boolean	equals(Object obj)
org.onlab.packet.IpAddress	gatewayIp() Returns the gateway IP address.
int	hashCode()
Iterable<HostRoute>	hostRoutes() Returns a collection of hostRoutes.
SubnetId	id() Returns the subnet identifier.
Subnet.Mode	ipV6AddressMode() Returns the ipV6AddressMode.
Subnet.Mode	ipV6RaMode() Returns the ipV6RaMode.A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.
org.onlab.packet.IpAddress.Version	ipVersion() Returns the IP version, which is 4 or 6.
TenantNetworkId	networkId() Returns the network identifier.
boolean	shared() Indicates whether this tenantNetwork is shared across all tenants.
String	subnetName() Returns the name of the subnet.
TenantId	tenantId() Returns tenant identifier.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultSubnet

public DefaultSubnet(SubnetId id,
                     String subnetName,
                     TenantNetworkId networkId,
                     TenantId tenantId,
                     org.onlab.packet.IpAddress.Version ipVersion,
                     org.onlab.packet.IpPrefix cidr,
                     org.onlab.packet.IpAddress gatewayIp,
                     boolean dhcpEnabled,
                     boolean shared,
                     Set<HostRoute> hostRoutes,
                     Subnet.Mode ipV6AddressMode,
                     Subnet.Mode ipV6RaMode,
                     Set<AllocationPool> allocationPoolsIt)

Creates a subnet object.

Parameters:

id - subnet identifier

subnetName - the name of subnet

networkId - network identifier

tenantId - tenant identifier

ipVersion - Version of ipv4 or ipv6

cidr - the cidr

gatewayIp - gateway ip

dhcpEnabled - dhcp enabled or not

shared - indicates whether this network is shared across all tenants, By default, only administrative user can change this value

hostRoutes - a collection of host routes

ipV6AddressMode - ipV6AddressMode

ipV6RaMode - ipV6RaMode

allocationPoolsIt - a collection of allocationPools

Method Detail

id

public SubnetId id()

Description copied from interface: Subnet

Returns the subnet identifier.

Specified by:

id in interface Subnet

Returns:

identifier

subnetName

public String subnetName()

Description copied from interface: Subnet

Returns the name of the subnet.

Specified by:

subnetName in interface Subnet

Returns:

subnetName

networkId

public TenantNetworkId networkId()

Description copied from interface: Subnet

Returns the network identifier.

Specified by:

networkId in interface Subnet

Returns:

the network identifier

tenantId

public TenantId tenantId()

Description copied from interface: Subnet

Returns tenant identifier.

Specified by:

tenantId in interface Subnet

Returns:

the tenant identifier

ipVersion

public org.onlab.packet.IpAddress.Version ipVersion()

Description copied from interface: Subnet

Returns the IP version, which is 4 or 6.

Specified by:

ipVersion in interface Subnet

Returns:

ipVersion

cidr

public org.onlab.packet.IpPrefix cidr()

Description copied from interface: Subnet

Returns the cidr.

Specified by:

cidr in interface Subnet

Returns:

cidr

gatewayIp

public org.onlab.packet.IpAddress gatewayIp()

Description copied from interface: Subnet

Returns the gateway IP address.

Specified by:

gatewayIp in interface Subnet

Returns:

gatewayIp

dhcpEnabled

public boolean dhcpEnabled()

Description copied from interface: Subnet

Returns true if DHCP is enabled and return false if DHCP is disabled.

Specified by:

dhcpEnabled in interface Subnet

Returns:

true or false

shared

public boolean shared()

Description copied from interface: Subnet

Indicates whether this tenantNetwork is shared across all tenants. By default, only administrative user can change this value.

Specified by:

shared in interface Subnet

Returns:

true or false

hostRoutes

public Iterable<HostRoute> hostRoutes()

Description copied from interface: Subnet

Returns a collection of hostRoutes.

Specified by:

hostRoutes in interface Subnet

Returns:

a collection of hostRoutes

ipV6AddressMode

public Subnet.Mode ipV6AddressMode()

Description copied from interface: Subnet

Returns the ipV6AddressMode. A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.

Specified by:

ipV6AddressMode in interface Subnet

Returns:

ipV6AddressMode whose value is dhcpv6-stateful, dhcpv6-stateless or slaac

ipV6RaMode

public Subnet.Mode ipV6RaMode()

Description copied from interface: Subnet

Returns the ipV6RaMode.A valid value is dhcpv6-stateful, dhcpv6-stateless, or slaac.

Specified by:

ipV6RaMode in interface Subnet

Returns:

ipV6RaMode whose value is dhcpv6-stateful, dhcpv6-stateless or slaac

allocationPools

public Iterable<AllocationPool> allocationPools()

Description copied from interface: Subnet

Returns a collection of allocation_pools.

Specified by:

allocationPools in interface Subnet

Returns:

a collection of allocationPools

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object