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


public interface TFTPConfig

TFTP Configuration. The TFTPConfig object contains the configuration files associated with a device. The TFTPConfig object is contained within the ConfigContext. The TFTPConfig object contains one or more TFTPFile objects corresponding to configuration files that are requested via TFTP get operations on the DPE. While the TFTPFile objects can represent any configuration file that is requested by the device, it is recommended that only dynamically generated configurations be represented as TFTPFile objects. Static files that are used by multiple devices should be registered with the RDU and distributed via the RDU/DPE file synchronization service.

See Also:
TFTPFile, ConfigContext

Method Summary
 void addFile(TFTPFile file)
          Add a TFTP file.
 void clear()
          Clear the TFTP Configuration.
 TFTPFile getFile()
          Get a TFTP file.
 TFTPFile getFile(String filename)
          Get the named TFTP file.
 List<TFTPFile> getFileList()
          Get the list of TFTPFile objects in this TFTP configuration.
 int size()
          Get the number of TFTPFile objects in the TFTP configuration.
 

Method Detail

addFile

void addFile(TFTPFile file)
Add a TFTP file.

Parameters:
file - the TFTPFile object to add to the TFTP configuration

getFile

TFTPFile getFile()
Get a TFTP file. Assumes only one TFTP configuration file is contained in the TFTP configuration

Returns:
the TFTPFile object, or null if no file found

getFile

TFTPFile getFile(String filename)
Get the named TFTP file. This method is used if more than one TFTPFile is contained in the TFTP configuration.

Parameters:
filename - the name of the TFTPFile object to get
Returns:
the TFTPFile object, or null if no file found

size

int size()
Get the number of TFTPFile objects in the TFTP configuration.

Returns:
number of TFTPFile objects.

clear

void clear()
Clear the TFTP Configuration. This removes all TFTPFile objects from the TFTP Configuration.


getFileList

List<TFTPFile> getFileList()
Get the list of TFTPFile objects in this TFTP configuration. The List is write-through to the list of TFTPFile objects contained in the TFTPConfig. Use synchronization on iteration of the list.

Returns:
List of TFTPFile objects, or null if no TFTPFile objects defined