com.hp.sdn.devown

Interface Region

All Superinterfaces:

Serializable, Transportable<Region,UUID>

All Known Implementing Classes:

RegionModel

public interface Region
extends Transportable<Region,UUID>

Represents a region of the controlled network, comprised of network elements and their prioritized set of master and slave controllers.

Author:

Steve Britt

Method Summary

Modifier and Type	Method and Description
boolean	addDevice(IpAddress toAdd) Attempts to add a new network element IP address to the existing Set.
boolean	addRange(IpRange toAdd) Attempts to add a new network element IP address range to the existing Set.
List<IpAddress>	getControllers() Retrieves the prioritized list of controllers IP addresses for this region.
Set<IpAddress>	getDevices() Retrieves the IP addresses of network elements for this region that were explicitly configured.
String	getName() Retrieves the name of this region.
Set<IpRange>	getRanges() Retrieves the IP address ranges of network elements for this region that were explicitly configured.
boolean	removeDevice(IpAddress toRemove) Attempts to remove a network element IP address from the existing Set of explicitly configured addresses.
boolean	removeRange(IpRange toRemove) Attempts to remove a network element IP address range from the existing Set of explicitly configured ranges.

Methods inherited from interface com.hp.api.Transportable

getId

Method Detail

addDevice

boolean addDevice(IpAddress toAdd)

Attempts to add a new network element IP address to the existing Set. Addresses that already exist in the Set cannot be added.

Parameters:

toAdd - IpAddress to add

Returns:

Boolean that is true if the address was added, false otherwise

addRange

boolean addRange(IpRange toAdd)

Attempts to add a new network element IP address range to the existing Set. Ranges that already exist as exact matches in the Set cannot be added.

Parameters:

toAdd - IpRange to add

Returns:

Boolean that is true if the address was added, false otherwise

getControllers

List<IpAddress> getControllers()

Retrieves the prioritized list of controllers IP addresses for this region.

Returns:

prioritized List of controller IP addresses

getDevices

Set<IpAddress> getDevices()

Retrieves the IP addresses of network elements for this region that were explicitly configured.

Returns:

Set of network element IP addresses

getName

String getName()

Retrieves the name of this region.

Returns:

region name

getRanges

Set<IpRange> getRanges()

Retrieves the IP address ranges of network elements for this region that were explicitly configured.

Returns:

Set of network element IP address ranges

removeDevice

boolean removeDevice(IpAddress toRemove)

Attempts to remove a network element IP address from the existing Set of explicitly configured addresses. If a nonexistent address is specified no Exception is thrown but a false value will be returned to indicate that no change was made.

Parameters:

toRemove - IpAddress to remove

Returns:

Boolean that is true if the address was removed, false otherwise

removeRange

boolean removeRange(IpRange toRemove)

Attempts to remove a network element IP address range from the existing Set of explicitly configured ranges. If a nonexistent range is specified no Exception is thrown but a false value will be returned to indicate that no change was made.

Parameters:

toRemove - IpRange to remove

Returns:

Boolean that is true if the range was removed, false otherwise