com.hp.sdn.adm.devown

Interface DeviceOwnerService

public interface DeviceOwnerService

Provides controller ownership of a device based on a region configuration.

Author:

Frank Wood, Steve Britt

Method Summary

Methods

Modifier and Type	Method and Description
void	addDevice(UUID regionUid, IpAddress deviceIp) Add the specified device IpAddress to the Region with the specified UUID.
void	addListener(DeviceOwnerListener listener) Add a DeviceOwnerListener to hear about ownership change events.
void	addRegion(Region region) Add the specified Region.
Map<UUID,Set<OwnerState>>	getOwners() Returns a Map of region UIDs to Sets of run-time OwnerStates for all devices configured in each corresponding region.
Region	getRegion(IpAddress deviceIp) Returns the Region associated with the specified device IpAddress.
List<Region>	getRegions() Returns a List of all configured Regions.
void	handleAddDevice(UUID regionUid, IpAddress deviceIp) Called when a peer needs to notify us that a device IpAddress was added to a Region.
void	handleAddRegion(Region region) Called when a peer needs to notify us that a Region was added.
void	handlePeerOwnerChange(OwnerChangeData data) Called when a peer needs to update our local cache.
void	handleRemoveDevice(UUID regionUid, IpAddress deviceIp) Called when a peer needs to notify us that a device IpAddress was removed from a Region.
void	handleRemoveRegion(UUID regionUid) Called when a peer needs to notify us that a Region was removed.
boolean	isEnforcingRegions() Returns true if the service is enforcing the region policy.
boolean	isOwner(DataPathId dataPathId) Returns true if the local controller is the current device owner for the specified DataPathId.
boolean	isValidRegionAddress(IpAddress ip) Returns true if the given address is defined in a region.
List<OwnerListenerData>	listeners() Returns a List of OwnerListenerData objects that represent the current state of the registered listeners.
List<OwnerState>	ownedByController(IpAddress controllerIp) Returns a List of per-datapath OwnerStates for which the specified controller IpAddress is the owner.
OwnerState	ownerStateFor(DataPathId dataPathId) Returns the OwnerState for the specified DataPathId.
List<OwnerState>	ownerStatesFor(IpAddress deviceIp) Returns the per-datapath OwnerStates corresponding to the device IpAddress.
void	postHandshake(DataPathId dataPathId, IpAddress deviceIp, ProtocolVersion negotiated, Runnable task, Runnable ownerOnlyTask) Called to inform the service of a post-handshake.
void	preDisconnected(DataPathId dataPathId, IpAddress deviceIp, ProtocolVersion negotiated) Called to inform the service of a disconnection.
void	removeDevice(UUID regionUid, IpAddress deviceIp) Remove the specified device IpAddress from the Region with the specified UUID.
void	removeListener(DeviceOwnerListener listener) Remove a previously-added DeviceOwnerListener.
void	removeRegion(UUID regionUid) Remove the Region with the specified UUID.

Method Detail

addListener

void addListener(DeviceOwnerListener listener)

Add a DeviceOwnerListener to hear about ownership change events.

Parameters:

listener - DeviceOwnerListener to add

removeListener

void removeListener(DeviceOwnerListener listener)

Remove a previously-added DeviceOwnerListener.

Parameters:

listener - DeviceOwnerListener to remove

getOwners

Map<UUID,Set<OwnerState>> getOwners()

Returns a Map of region UIDs to Sets of run-time OwnerStates for all devices configured in each corresponding region.

Returns:

Map containing OwnerStates for all configured devices, keyed by region UID

getRegion

Region getRegion(IpAddress deviceIp)

Returns the Region associated with the specified device IpAddress.

Parameters:

deviceIp - IpAddress for which associated Region should be returned

Returns:

Region associated with device IpAddress, or null if there is no such Region

getRegions

List<Region> getRegions()

Returns a List of all configured Regions.

Returns:

List of configured Regions

handlePeerOwnerChange

void handlePeerOwnerChange(OwnerChangeData data)

Called when a peer needs to update our local cache. We can assume that we are running within the distributed critical section for a device.

Parameters:

data - owner change data

isEnforcingRegions

boolean isEnforcingRegions()

Returns true if the service is enforcing the region policy.

Returns:

true if the service is enforcing regions

isOwner

boolean isOwner(DataPathId dataPathId)

Returns true if the local controller is the current device owner for the specified DataPathId.

Parameters:

dataPathId - DataPathId to check ownership for

Returns:

true if the local controller is the current owner

listeners

List<OwnerListenerData> listeners()

Returns a List of OwnerListenerData objects that represent the current state of the registered listeners.

Returns:

List of OwnerListenerData objects

ownedByController

List<OwnerState> ownedByController(IpAddress controllerIp)

Returns a List of per-datapath OwnerStates for which the specified controller IpAddress is the owner.

Parameters:

controllerIp - controller IpAddress

Returns:

List of OwnerState objects

ownerStateFor

OwnerState ownerStateFor(DataPathId dataPathId)

Returns the OwnerState for the specified DataPathId.

Parameters:

dataPathId - DataPathId of interest

Returns:

OwnerState for the specified DataPathId

ownerStatesFor

List<OwnerState> ownerStatesFor(IpAddress deviceIp)

Returns the per-datapath OwnerStates corresponding to the device IpAddress.

Parameters:

deviceIp - device IpAddress of interest

Returns:

List of OwnerStates

postHandshake

void postHandshake(DataPathId dataPathId,
                 IpAddress deviceIp,
                 ProtocolVersion negotiated,
                 Runnable task,
                 Runnable ownerOnlyTask)

Called to inform the service of a post-handshake. When enforcing regions both the tasks must be supplied so that they can be run within the protections of the distributed critical sections. When not enforcing regions this simply results in a DeviceOwnerEvent.Type.OWNERSHIP_ACQUIRED event.

Parameters:

dataPathId - DataPathId of the connection

deviceIp - device IpAddress of the connection

negotiated - ProtocolVersion that was negotiated

task - post-handshake task to run

ownerOnlyTask - addition post-handshake task to run if owner

preDisconnected

void preDisconnected(DataPathId dataPathId,
                   IpAddress deviceIp,
                   ProtocolVersion negotiated)

Called to inform the service of a disconnection. When enforcing regions this will process the data path within the protection of the distributed critical section and provides symmetry with postHandshake(com.hp.of.lib.dt.DataPathId, com.hp.util.ip.IpAddress, com.hp.of.lib.ProtocolVersion, java.lang.Runnable, java.lang.Runnable). When not enforcing regions this simply results in a DeviceOwnerEvent.Type.OWNERSHIP_LOST event.

Parameters:

dataPathId - DataPathId of the connection

deviceIp - device IpAddress of the connection

negotiated - ProtocolVersion that was negotiated

isValidRegionAddress

boolean isValidRegionAddress(IpAddress ip)

Returns true if the given address is defined in a region.

Returns:

true if the given address is defined in a region.

addDevice

void addDevice(UUID regionUid,
             IpAddress deviceIp)

Add the specified device IpAddress to the Region with the specified UUID.

Parameters:

regionUid - region UUID

deviceIp - device IpAddress to add

handleAddDevice

void handleAddDevice(UUID regionUid,
                   IpAddress deviceIp)

Called when a peer needs to notify us that a device IpAddress was added to a Region.

Parameters:

regionUid - region UUID

deviceIp - device IpAddress to add

removeDevice

void removeDevice(UUID regionUid,
                IpAddress deviceIp)

Remove the specified device IpAddress from the Region with the specified UUID.

Parameters:

regionUid - region UUID

deviceIp - device IpAddress to remove

handleRemoveDevice

void handleRemoveDevice(UUID regionUid,
                      IpAddress deviceIp)

Called when a peer needs to notify us that a device IpAddress was removed from a Region.

Parameters:

regionUid - region UUID

deviceIp - device IpAddress to remove

addRegion

void addRegion(Region region)

Add the specified Region.

Parameters:

region - Region to add

handleAddRegion

void handleAddRegion(Region region)

Called when a peer needs to notify us that a Region was added.

Parameters:

region - Region to add

removeRegion

void removeRegion(UUID regionUid)

Remove the Region with the specified UUID.

Parameters:

regionUid - region UUID

handleRemoveRegion

void handleRemoveRegion(UUID regionUid)

Called when a peer needs to notify us that a Region was removed.

Parameters:

regionUid - region UUID