org.onosproject.virtualbng

Class VbngConfigurationManager

java.lang.Object

org.onosproject.virtualbng.VbngConfigurationManager

All Implemented Interfaces:

VbngConfigurationService

@Service
public class VbngConfigurationManager
extends Object
implements VbngConfigurationService

Implementation of ConfigurationService which reads virtual BNG configuration from a file.

Constructor Summary

Constructors

Constructor and Description
VbngConfigurationManager()

Method Summary

Modifier and Type	Method and Description
void	activate()
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.
void	deactivate()
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.
void	readConfiguration() Instructs the configuration reader to read the configuration from the file.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VbngConfigurationManager

public VbngConfigurationManager()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

readConfiguration

public void readConfiguration()

Instructs the configuration reader to read the configuration from the file.

getNextHopIpAddress

public org.onlab.packet.IpAddress getNextHopIpAddress()

Description copied from interface: VbngConfigurationService

Gets the IP address configured for the next hop.

Specified by:

getNextHopIpAddress in interface VbngConfigurationService

Returns:

the IP address of next hop

getPublicFacingMac

public org.onlab.packet.MacAddress getPublicFacingMac()

Description copied from interface: VbngConfigurationService

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

Specified by:

getPublicFacingMac in interface VbngConfigurationService

Returns:

the MAC address

getXosIpAddress

public org.onlab.packet.IpAddress getXosIpAddress()

Description copied from interface: VbngConfigurationService

Gets the IP address configured for XOS server.

Specified by:

getXosIpAddress in interface VbngConfigurationService

Returns:

the IP address configured for the XOS server

getXosRestPort

public int getXosRestPort()

Description copied from interface: VbngConfigurationService

Gets the REST communication port configured for XOS server.

Specified by:

getXosRestPort in interface VbngConfigurationService

Returns:

the REST communication port configured for XOS server

getNodeToPort

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

Description copied from interface: VbngConfigurationService

Gets the host to port map.

Specified by:

getNodeToPort in interface VbngConfigurationService

Returns:

host to port map

getAvailablePublicIpAddress

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

Description copied from interface: VbngConfigurationService

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

Specified by:

getAvailablePublicIpAddress in interface VbngConfigurationService

Parameters:

privateIpAddress - a private IP address

Returns:

an available public IP address if it exists, otherwise null

getAssignedPublicIpAddress

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

Description copied from interface: VbngConfigurationService

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

Specified by:

getAssignedPublicIpAddress in interface VbngConfigurationService

Parameters:

privateIpAddress - a private IP address

Returns:

the assigned public IP address if it exists, otherwise null

isAssignedPublicIpAddress

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

Description copied from interface: VbngConfigurationService

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

Specified by:

isAssignedPublicIpAddress in interface VbngConfigurationService

Parameters:

ipAddress - the IP address to evaluate

Returns:

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

recycleAssignedPublicIpAddress

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

Description copied from interface: VbngConfigurationService

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.

Specified by:

recycleAssignedPublicIpAddress in interface VbngConfigurationService

Parameters:

privateIpAddress - a private IP address

Returns:

the assigned public IP address if it exists, otherwise null

getIpAddressMappings

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

Description copied from interface: VbngConfigurationService

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

Specified by:

getIpAddressMappings in interface VbngConfigurationService

Returns:

the address map from private IP address to public IP address

assignSpecifiedPublicIp

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

Description copied from interface: VbngConfigurationService

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.

Specified by:

assignSpecifiedPublicIp in interface VbngConfigurationService

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