com.h3c.sdn.api

Interface ConfigTransferService

public interface ConfigTransferService

Configuration Artifact transfer service Sideways API.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(String component) Reset all configuration items for the given component back to their defaults.
List<Config>	getConfigs(SystemInformation system) Get Configs for all components (default and modified).
void	modify(Config modifiedConfig) Update the Config of a given component with the key/value pairs supplied.

Method Detail

getConfigs

List<Config> getConfigs(SystemInformation system)
                        throws Exception

Get Configs for all components (default and modified).

Parameters:

system - the system to fetch the configurations from

Returns:

a List of Configs for all components

Throws:

Exception - if error occurs fetching configurations

modify

void modify(Config modifiedConfig)

Update the Config of a given component with the key/value pairs supplied. The map of key/value pairs must be non-null and contain one or more entries with non-null keys that are valid keys for the given component.

Parameters:

modifiedConfig - the modified configuration

clear

void clear(String component)

Reset all configuration items for the given component back to their defaults.

Parameters:

component - the name of the component whose configuration will be reset