com.cisco.provisioning.cpe.extensions.configuration
Interface ConfigContext


public interface ConfigContext

The Configuration Context is a container of configuration data for a specific device. The configuration data contains at least DHCP configuration and optionally TFTP and SNMP configurations. The configuration context itself (the references to configurations) is immutable. To modify the device configuration use the ConfigContext accessor methods to access the specific configuration data objects.

See Also:
DHCPConfig, TFTPConfig, SNMPConfig

Method Summary
 boolean containsDHCPConfig()
          Return true if this ConfigContext contains a DHCP configuration.
 boolean containsSNMPConfig()
          Return true if this ConfigContext contains a SNMP configuration.
 boolean containsTFTPConfig()
          Return true if this ConfigContext contains a TFTP configuration.
 Capabilities getCapabilities()
          Returns the available capabilities that restrict what can be included in this configuration context.
 com.cisco.bac.type.DeviceIdentifier getDeviceID()
          Returns the device ID for this configuration context.
 DHCPConfig getDHCPConfig()
          Returns the DHCP configuration data for this configuration context.
 SNMPConfig getSNMPConfig()
          Returns the SNMP configuration data for this configuration context.
 TFTPConfig getTFTPConfig()
          Returns the TFTP configuration data for this configuration context.
 

Method Detail

getDeviceID

com.cisco.bac.type.DeviceIdentifier getDeviceID()
Returns the device ID for this configuration context.

Returns:
device ID

getDHCPConfig

DHCPConfig getDHCPConfig()
Returns the DHCP configuration data for this configuration context. If one does not exist, it will be created.

Returns:
DHCP configuration reference

getSNMPConfig

SNMPConfig getSNMPConfig()
Returns the SNMP configuration data for this configuration context. If one does not exist, it will be created.

Returns:
SNMP configuration reference

getTFTPConfig

TFTPConfig getTFTPConfig()
Returns the TFTP configuration data for this configuration context. If one does not exist, it will be created.

Returns:
TFTP configuration reference

containsDHCPConfig

boolean containsDHCPConfig()
Return true if this ConfigContext contains a DHCP configuration.

Returns:
true if ConfigContext has DHCP configuration. Otherwise returns false.

containsSNMPConfig

boolean containsSNMPConfig()
Return true if this ConfigContext contains a SNMP configuration.

Returns:
true if ConfigContext has SNMP configuration. Otherwise returns false.

containsTFTPConfig

boolean containsTFTPConfig()
Return true if this ConfigContext contains a TFTP configuration.

Returns:
true if ConfigContext has TFTP configuration. Otherwise returns false.

getCapabilities

Capabilities getCapabilities()
Returns the available capabilities that restrict what can be included in this configuration context.

Returns:
the available capabilities that restrict what can be included in this configuration context.