org.onosproject.virtualbng

Interface VbngConfigurationService

All Known Implementing Classes:

VbngConfigurationManager

public interface VbngConfigurationService

Provides information about the virtual BNG configuration.

Method Summary

Modifier and Type	Method and Description
org.onlab.packet.IpAddress	getAssignedPublicIpAddress(org.onlab.packet.IpAddress privateIpAddress) Gets the public IP address already assigned for a private IP address.
org.onlab.packet.IpAddress	getAvailablePublicIpAddress(org.onlab.packet.IpAddress privateIpAddress) Gets an available public IP address from local public IP prefixes.
Map<org.onlab.packet.IpAddress,org.onlab.packet.IpAddress>	getIpAddressMappings() Gets all the mapping entries from private IP address to public IP address.
org.onlab.packet.IpAddress	getNextHopIpAddress() Gets the IP address configured for the next hop.
org.onlab.packet.MacAddress	getPublicFacingMac() Gets the MAC address configured for all the public IP addresses.
boolean	isAssignedPublicIpAddress(org.onlab.packet.IpAddress ipAddress) Evaluates whether an IP address is an assigned public IP address.
org.onlab.packet.IpAddress	recycleAssignedPublicIpAddress(org.onlab.packet.IpAddress privateIpAddress) Recycles the public IP address assigned for a private IP address, and at the same time deletes the mapping entry from this private IP address to the public IP address.

Method Detail

getNextHopIpAddress

org.onlab.packet.IpAddress getNextHopIpAddress()

Gets the IP address configured for the next hop.

Returns:

the IP address of next hop

getPublicFacingMac

org.onlab.packet.MacAddress getPublicFacingMac()

Gets the MAC address configured for all the public IP addresses.

Returns:

the MAC address

isAssignedPublicIpAddress

boolean isAssignedPublicIpAddress(org.onlab.packet.IpAddress ipAddress)

Evaluates whether an IP address is an assigned public IP address.

Parameters:

ipAddress - the IP address to evaluate

Returns:

true if the input IP address is an assigned public IP address, otherwise false

getAvailablePublicIpAddress

org.onlab.packet.IpAddress getAvailablePublicIpAddress(org.onlab.packet.IpAddress privateIpAddress)

Gets an available public IP address from local public IP prefixes.

Parameters:

privateIpAddress - a private IP address

Returns:

an available public IP address if it exists, otherwise null

getAssignedPublicIpAddress

org.onlab.packet.IpAddress getAssignedPublicIpAddress(org.onlab.packet.IpAddress privateIpAddress)

Gets the public IP address already assigned for a private IP address.

Parameters:

privateIpAddress - a private IP address

Returns:

the assigned public IP address if it exists, otherwise null

recycleAssignedPublicIpAddress

org.onlab.packet.IpAddress recycleAssignedPublicIpAddress(org.onlab.packet.IpAddress privateIpAddress)

Recycles the public IP address assigned for a private IP address, and at the same time deletes the mapping entry from this private IP address to the public IP address.

Parameters:

privateIpAddress - a private IP address

Returns:

the assigned public IP address if it exists, otherwise null

getIpAddressMappings

Map<org.onlab.packet.IpAddress,org.onlab.packet.IpAddress> getIpAddressMappings()

Gets all the mapping entries from private IP address to public IP address.

Returns:

the address map from private IP address to public IP address