com.cisco.provisioning.cpe.extensions.detection
Interface DeviceDetectionContext

public interface DeviceDetectionContext

This interfaces defines the container for the device detection data passed in to/returned from the device detection RDU extension point.

For DHCP southbound data there are RFC standards (2132, 3315) that dictate the primary device identifier. For DHCPv4, RFC 2132 defines the device identifier to be a MAC address. For DHCPv6, RFC 3315 defines the device identifier to be a DUID address. During device detection, the device discovered data is analyzed for additional device identifiers that may be supplied. For CableLabs devices and relay agents, the discovered data often contains additional device identifiers.

Method Summary

com.cisco.bac.type.DeviceIdentifier	getDeviceID() Get device identifier supplied by the device.
com.cisco.bac.type.DeviceIdentifier	getDeviceInFront() Get device identifier of the device in front.
String	getDeviceType() Get the device type.
List<com.cisco.bac.type.DeviceIdentifier>	getDiscoveredDeviceIdentifiers() Return list of DeviceIdentifier that were detected from the device discovered data.
Map<String,Object>	getProperties() Return a map of properties to use for configuration generation.
boolean	isDeviceInFrontChanged() Tells whether the relay agent is changed or not.
void	setDeviceInFront(com.cisco.bac.type.DeviceIdentifier deviceInFront) Set device ID of the device in front.
void	setDeviceType(String deviceType) Set device type.
void	setDiscoveredDeviceIdentifiers(List<com.cisco.bac.type.DeviceIdentifier> deviceIdentifiers) Set a list of DeviceIdentifer that were detected from the device discovered data.
void	setProperties(Map<String,Object> properties) Set a map of properties to use for configuration generation.

Method Detail

getDeviceID

com.cisco.bac.type.DeviceIdentifier getDeviceID()

Get device identifier supplied by the device. This is the primary device identifier supplied by the device via southbound discovery interface.

Returns:

the device identifier

getDeviceInFront

com.cisco.bac.type.DeviceIdentifier getDeviceInFront()

Get device identifier of the device in front.

Returns:

the device identifier of the device in front.

getDeviceType

String getDeviceType()

Get the device type.

Returns:

the device type

getProperties

Map<String,Object> getProperties()

Return a map of properties to use for configuration generation.

Returns:

the detected properties.

getDiscoveredDeviceIdentifiers

List<com.cisco.bac.type.DeviceIdentifier> getDiscoveredDeviceIdentifiers()

Return list of DeviceIdentifier that were detected from the device discovered data.

Returns:

The discovered list of DeviceIdentifier

isDeviceInFrontChanged

boolean isDeviceInFrontChanged()

Tells whether the relay agent is changed or not.

Returns:

true if relay agent is changed

setDeviceInFront

void setDeviceInFront(com.cisco.bac.type.DeviceIdentifier deviceInFront)

Set device ID of the device in front.

Parameters:

deviceInFront - device ID of the device through which this device is connected.

setDeviceType

void setDeviceType(String deviceType)

Set device type.

Parameters:

deviceType - device type.

setProperties

void setProperties(Map<String,Object> properties)

Set a map of properties to use for configuration generation.

Parameters:

properties - the detected properties.

setDiscoveredDeviceIdentifiers

void setDiscoveredDeviceIdentifiers(List<com.cisco.bac.type.DeviceIdentifier> deviceIdentifiers)

Set a list of DeviceIdentifer that were detected from the device discovered data.

Parameters:

deviceIdentifiers - the list of DeviceIdentifier