Package org.opennms.features.deviceconfig.service

Interface DeviceConfigService

All Known Implementing Classes:

DeviceConfigServiceImpl

public interface DeviceConfigService

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DeviceConfigService.RetrievalDefinition	Definition of a backup job.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEVICE_CONFIG_PREFIX

Method Summary

Modifier and Type	Method	Description
CompletableFuture<DeviceConfig>	getDeviceConfig(String ipAddress, String location, String service, boolean persist, int timeout)	Get device config for the given ipAddress at given location.
List<DeviceConfigService.RetrievalDefinition>	getRetrievalDefinitions(String ipAddress, String location)	Gets the backup jobs defined for the given interface.
CompletableFuture<Boolean>	triggerConfigBackup(String ipAddress, String location, String service, boolean persist)	Trigger device config backup for the given ipAddress at given location.

Field Detail

DEVICE_CONFIG_PREFIX

static final String DEVICE_CONFIG_PREFIX

See Also:

Constant Field Values

Method Detail

triggerConfigBackup

CompletableFuture<Boolean> triggerConfigBackup(String ipAddress,
                                               String location,
                                               String service,
                                               boolean persist)
                                        throws IOException

Trigger device config backup for the given ipAddress at given location.

Parameters:

ipAddress - specific IpAddress for which we need to fetch device config.

location - specific minion location at which we need to fetch device config.

service - name of the bound service.

persist -

Returns:

Throws:

IOException

getDeviceConfig

CompletableFuture<DeviceConfig> getDeviceConfig(String ipAddress,
                                                String location,
                                                String service,
                                                boolean persist,
                                                int timeout)
                                         throws IOException

Get device config for the given ipAddress at given location.

Parameters:

ipAddress - specific IpAddress for which we need to fetch device config.

location - specific minion location at which we need to fetch device config.

service - name of the bound service.

persist -

timeout - timeout in milliseconds for retrieving device config

Returns:

Throws:

IOException

getRetrievalDefinitions

List<DeviceConfigService.RetrievalDefinition> getRetrievalDefinitions(String ipAddress,
                                                                      String location)

Gets the backup jobs defined for the given interface.

Parameters:

ipAddress - the IP address of the interface.

location - the location of the interface.

Returns:

the DeviceConfigService.RetrievalDefinitions for this interface