com.cisco.provisioning.cpe.extensions.services
Interface ExtensionServices

public interface ExtensionServices

The ExtensionServices interface provides RDU extension points access to essential CSRC services that are exposed via the extension point interfaces. Any extension point invoked by the RDU will be passed a reference to the ExtensionServices interface.

Method Summary

CSRCProperties	getCSRCProperties() Return a reference to the CSRC Properties.
CSRCProperties	getDeviceProperties(IPDevice device) Returns a collection of properties for device from device property hierarchy.
DOCSISOptionFactory	getDOCSISOptionFactory(OptionDescType optionDescType) Return a reference to the DOCSISOptionFactory.
com.cisco.provisioning.cpe.api.LeaseResults	getLeasesForIPAddress(String ipAddress, List<String> provGroups) Returns lease information for the specified IP address.
com.cisco.provisioning.cpe.api.LeaseResults	getLeasesForIPDevice(IPDevice ipDevice) Returns lease information for the specified IP device.
LogManager	getLogManager() Return a reference to the logging/tracing manager.
Capabilities	getProvGroupCapabilities() Returns the enabled capabilities associated with the device's provisioning group.
TemplateParser	getTemplateParser() Return the template parser singleton instance.

Method Detail

getLeasesForIPAddress

com.cisco.provisioning.cpe.api.LeaseResults getLeasesForIPAddress(String ipAddress,
                                                                  List<String> provGroups)
                                                                  throws LeaseInfoNotAvailable

Returns lease information for the specified IP address. This method has the same behavior as the IPDevice.getAllForIPAddress(...) however this version is available for use from extension points. If provGroups is null or empty, all provisioning groups will be searched for lease information. If an error occurs retrieving lease info, LeaseInfoNotAvailable exception will be thrown.

Throws:

LeaseInfoNotAvailable

getLeasesForIPDevice

com.cisco.provisioning.cpe.api.LeaseResults getLeasesForIPDevice(IPDevice ipDevice)
                                                                 throws LeaseInfoNotAvailable

Returns lease information for the specified IP device. This method has the similar behavior as the IPDevice.getAllForIPAddress(...) however this version queries for lease information based on a specified IP device and is available for use from extension points. If the device is not currently assigned a provisioning group, the query will fail. If an error occurs retrieving lease info, LeaseInfoNotAvailable exception will be thrown.

Throws:

LeaseInfoNotAvailable

getCSRCProperties

CSRCProperties getCSRCProperties()

Return a reference to the CSRC Properties. The CSRC Properties object provides access to all properties defined in CSRC BPR.

getDeviceProperties

CSRCProperties getDeviceProperties(IPDevice device)

Returns a collection of properties for device from device property hierarchy. The hierarchy is traversed until the property value is found. The order is as follows: IPDevice->ClassOfService->DHCPCriteria->DeviceType->System Defaults.

getLogManager

LogManager getLogManager()

Return a reference to the logging/tracing manager. The LogManager provides methods to write entries to the CSRC log and trace files.

Returns:

LogManager

getDOCSISOptionFactory

DOCSISOptionFactory getDOCSISOptionFactory(OptionDescType optionDescType)

Return a reference to the DOCSISOptionFactory. The DOCSISOptionFactory provides methods to create dynamic DOCSIS option values that can be used to programmatically create DOCSIS configuration files.

Parameters:

optionDescType - the type of option descriptions to create

Returns:

DOCSISOptionFactory

getTemplateParser

TemplateParser getTemplateParser()

Return the template parser singleton instance.

Returns:

the template parser singleton instance.

getProvGroupCapabilities

Capabilities getProvGroupCapabilities()

Returns the enabled capabilities associated with the device's provisioning group.

Returns:

the enabled capabilities associated with the device's provisioning group.