org.onosproject.vtnrsc.floatingip

Interface FloatingIpService

All Known Implementing Classes:

FloatingIpManager

public interface FloatingIpService

Service for interacting with the inventory of floating IP.

Method Summary

Modifier and Type	Method and Description
void	addListener(FloatingIpListener listener) Adds the specified listener to floating Ip manager.
boolean	createFloatingIps(Collection<FloatingIp> floatingIps) Creates new floatingIps.
boolean	exists(FloatingIpId floatingIpId) Returns exists or not of specific floatingIp identifier.
boolean	fixedIpIsUsed(org.onlab.packet.IpAddress fixedIpAddr, TenantId tenantId, FloatingIpId floatingIpId) Returns is used or not of specific fixed IP address.
boolean	floatingIpIsUsed(org.onlab.packet.IpAddress floatingIpAddr, FloatingIpId floatingIpId) Returns is used or not of specific floating IP address.
FloatingIp	getFloatingIp(FloatingIpId floatingIpId) Returns the floatingIp with the specified identifier.
Collection<FloatingIp>	getFloatingIps() Returns a collection of the currently known floating IP.
boolean	removeFloatingIps(Collection<FloatingIpId> floatingIpIds) Removes the specified floatingIp from the store.
void	removeListener(FloatingIpListener listener) Removes the specified listener to floating Ip manager.
boolean	updateFloatingIps(Collection<FloatingIp> floatingIps) Updates existing floatingIps.

Method Detail

exists

boolean exists(FloatingIpId floatingIpId)

Returns exists or not of specific floatingIp identifier.

Parameters:

floatingIpId - floatingIp identifier

Returns:

true or false

floatingIpIsUsed

boolean floatingIpIsUsed(org.onlab.packet.IpAddress floatingIpAddr,
                         FloatingIpId floatingIpId)

Returns is used or not of specific floating IP address.

Parameters:

floatingIpAddr - floatingIp address

floatingIpId - floatingIp identifier

Returns:

true or false

fixedIpIsUsed

boolean fixedIpIsUsed(org.onlab.packet.IpAddress fixedIpAddr,
                      TenantId tenantId,
                      FloatingIpId floatingIpId)

Returns is used or not of specific fixed IP address.

Parameters:

fixedIpAddr - fixedIp address

tenantId - the tenant identifier of floating IP

floatingIpId - floatingIp identifier

Returns:

true or false

getFloatingIps

Collection<FloatingIp> getFloatingIps()

Returns a collection of the currently known floating IP.

Returns:

collection of floating IP

getFloatingIp

FloatingIp getFloatingIp(FloatingIpId floatingIpId)

Returns the floatingIp with the specified identifier.

Parameters:

floatingIpId - floatingIp identifier

Returns:

floatingIp or null if one with the given identifier is not known

createFloatingIps

boolean createFloatingIps(Collection<FloatingIp> floatingIps)

Creates new floatingIps.

Parameters:

floatingIps - the collection of floatingIp

Returns:

true if the identifier floatingIp has been created right

updateFloatingIps

boolean updateFloatingIps(Collection<FloatingIp> floatingIps)

Updates existing floatingIps.

Parameters:

floatingIps - the collection of floatingIp

Returns:

true if all floatingIp were updated successfully

removeFloatingIps

boolean removeFloatingIps(Collection<FloatingIpId> floatingIpIds)

Removes the specified floatingIp from the store.

Parameters:

floatingIpIds - the collection of floatingIp identifier

Returns:

true if remove identifier floatingIp successfully

addListener

void addListener(FloatingIpListener listener)

Adds the specified listener to floating Ip manager.

Parameters:

listener - floating Ip listener

removeListener

void removeListener(FloatingIpListener listener)

Removes the specified listener to floating Ip manager.

Parameters:

listener - floating Ip listener