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
boolean	assignSpecifiedPublicIp(org.onlab.packet.IpAddress publicIpAddress, org.onlab.packet.IpAddress privateIpAddress) Tries to assign a given public IP address to a private IP address.
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.
Map<String,org.onosproject.net.ConnectPoint>	getNodeToPort() Gets the host to port map.
org.onlab.packet.MacAddress	getPublicFacingMac() Gets the MAC address configured for all the public IP addresses.
org.onlab.packet.IpAddress	getXosIpAddress() Gets the IP address configured for XOS server.
int	getXosRestPort() Gets the REST communication port configured for XOS server.
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

getXosIpAddress

org.onlab.packet.IpAddress getXosIpAddress()

Gets the IP address configured for XOS server.

Returns:

the IP address configured for the XOS server

getXosRestPort

int getXosRestPort()

Gets the REST communication port configured for XOS server.

Returns:

the REST communication port configured for XOS server

getNodeToPort

Map<String,org.onosproject.net.ConnectPoint> getNodeToPort()

Gets the host to port map.

Returns:

host to port map

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

assignSpecifiedPublicIp

boolean assignSpecifiedPublicIp(org.onlab.packet.IpAddress publicIpAddress,
                                org.onlab.packet.IpAddress privateIpAddress)

Tries to assign a given public IP address to a private IP address. If success, then sets up the mapping from this private IP address to the public IP address, and stores the mapping.

Parameters:

publicIpAddress - the public IP address try to assign

privateIpAddress - a private IP address

Returns:

true if this public IP address is available, otherwise false