org.onosproject.dhcp.impl

Class DistributedDhcpStore

java.lang.Object

org.onosproject.dhcp.impl.DistributedDhcpStore

All Implemented Interfaces:

DhcpStore

@Service
public class DistributedDhcpStore
extends Object
implements DhcpStore

Manages the pool of available IP Addresses in the network and Remembers the mapping between MAC ID and IP Addresses assigned.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.service.StorageService	storageService

Constructor Summary

Constructors

Constructor and Description
DistributedDhcpStore()

Method Summary

Modifier and Type	Method and Description
protected void	activate()
boolean	assignIP(org.onosproject.net.HostId hostId, IpAssignment ipAssignment) Assigns the requested IP to the Mac ID, in response to a DHCP REQUEST message.
boolean	assignStaticIP(org.onlab.packet.MacAddress macAddress, IpAssignment ipAssignment) Assigns the requested IP to the MAC ID (if available) for an indefinite period of time.
protected void	deactivate()
Iterable<org.onlab.packet.Ip4Address>	getAvailableIPs() Returns the list of all the available IPs with the server.
IpAssignment	getIpAssignmentFromAllocationMap(org.onosproject.net.HostId hostId) Returns IpAssignment from map.
Map<org.onosproject.net.HostId,IpAssignment>	listAllMapping() Returns a collection of all the MacAddress to IPAddress mapping.
Map<org.onosproject.net.HostId,IpAssignment>	listAssignedMapping() Returns a collection of all the MacAddress to IPAddress mapping assigned to the hosts.
void	populateIPPoolfromRange(org.onlab.packet.Ip4Address startIP, org.onlab.packet.Ip4Address endIP) Appends all the IPs in a given range to the free pool of IPs.
org.onlab.packet.Ip4Address	releaseIP(org.onosproject.net.HostId hostId) Releases the IP assigned to a Mac ID into the free pool.
boolean	removeStaticIP(org.onlab.packet.MacAddress macID) Removes a static IP mapping associated with the given MAC ID from the DHCP Server.
void	setDefaultTimeoutForPurge(int timeInSeconds) Sets the default time for which suggested IP mappings are valid.
org.onlab.packet.Ip4Address	suggestIP(org.onosproject.net.HostId hostId, org.onlab.packet.Ip4Address requestedIP) Returns an IP Address for a Mac ID, in response to a DHCP DISCOVER message.

Methods inherited from class java.lang.Object

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

Field Detail

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

Constructor Detail

DistributedDhcpStore

public DistributedDhcpStore()

Method Detail

activate

@Activate
protected void activate()

deactivate

@Deactivate
protected void deactivate()

suggestIP

public org.onlab.packet.Ip4Address suggestIP(org.onosproject.net.HostId hostId,
                                             org.onlab.packet.Ip4Address requestedIP)

Description copied from interface: DhcpStore

Returns an IP Address for a Mac ID, in response to a DHCP DISCOVER message.

Specified by:

suggestIP in interface DhcpStore

Parameters:

hostId - Host ID of the client requesting an IP

requestedIP - requested IP address

Returns:

IP address assigned to the Mac address; null if no available IP

assignIP

public boolean assignIP(org.onosproject.net.HostId hostId,
                        IpAssignment ipAssignment)

Description copied from interface: DhcpStore

Assigns the requested IP to the Mac ID, in response to a DHCP REQUEST message.

Specified by:

assignIP in interface DhcpStore

Parameters:

hostId - Host Id of the client requesting an IP

ipAssignment - ip assignment

Returns:

returns true if the assignment was successful, false otherwise

releaseIP

public org.onlab.packet.Ip4Address releaseIP(org.onosproject.net.HostId hostId)

Description copied from interface: DhcpStore

Releases the IP assigned to a Mac ID into the free pool.

Specified by:

releaseIP in interface DhcpStore

Parameters:

hostId - the host ID for which the mapping needs to be changed

Returns:

released ip

setDefaultTimeoutForPurge

public void setDefaultTimeoutForPurge(int timeInSeconds)

Description copied from interface: DhcpStore

Sets the default time for which suggested IP mappings are valid.

Specified by:

setDefaultTimeoutForPurge in interface DhcpStore

Parameters:

timeInSeconds - default time for IP mappings to be valid

listAssignedMapping

public Map<org.onosproject.net.HostId,IpAssignment> listAssignedMapping()

Description copied from interface: DhcpStore

Returns a collection of all the MacAddress to IPAddress mapping assigned to the hosts.

Specified by:

listAssignedMapping in interface DhcpStore

Returns:

the collection of the mappings

listAllMapping

public Map<org.onosproject.net.HostId,IpAssignment> listAllMapping()

Description copied from interface: DhcpStore

Returns a collection of all the MacAddress to IPAddress mapping.

Specified by:

listAllMapping in interface DhcpStore

Returns:

the collection of the mappings

assignStaticIP

public boolean assignStaticIP(org.onlab.packet.MacAddress macAddress,
                              IpAssignment ipAssignment)

Description copied from interface: DhcpStore

Assigns the requested IP to the MAC ID (if available) for an indefinite period of time.

Specified by:

assignStaticIP in interface DhcpStore

Parameters:

macAddress - mac address of the client

ipAssignment - ip address and dhcp options requested for the client

Returns:

true if the mapping was successfully registered, false otherwise

removeStaticIP

public boolean removeStaticIP(org.onlab.packet.MacAddress macID)

Description copied from interface: DhcpStore

Removes a static IP mapping associated with the given MAC ID from the DHCP Server.

Specified by:

removeStaticIP in interface DhcpStore

Parameters:

macID - mac address of the client

Returns:

true if the mapping was successfully registered, false otherwise

getAvailableIPs

public Iterable<org.onlab.packet.Ip4Address> getAvailableIPs()

Description copied from interface: DhcpStore

Returns the list of all the available IPs with the server.

Specified by:

getAvailableIPs in interface DhcpStore

Returns:

list of available IPs

populateIPPoolfromRange

public void populateIPPoolfromRange(org.onlab.packet.Ip4Address startIP,
                                    org.onlab.packet.Ip4Address endIP)

Description copied from interface: DhcpStore

Appends all the IPs in a given range to the free pool of IPs.

Specified by:

populateIPPoolfromRange in interface DhcpStore

Parameters:

startIP - Start IP for the range

endIP - End IP for the range

getIpAssignmentFromAllocationMap

public IpAssignment getIpAssignmentFromAllocationMap(org.onosproject.net.HostId hostId)

Description copied from interface: DhcpStore

Returns IpAssignment from map.

Specified by:

getIpAssignmentFromAllocationMap in interface DhcpStore

Parameters:

hostId - host identification

Returns:

IpAssignment