Package org.opennms.features.deviceconfig.retrieval.api

Interface Retriever

All Known Implementing Classes:

RetrieverImpl

public interface Retriever

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Retriever.Failure
static class	Retriever.Protocol
static class	Retriever.Success

Method Summary

Modifier and Type	Method	Description
CompletionStage<io.vavr.control.Either<Retriever.Failure,Retriever.Success>>	retrieveConfig(Retriever.Protocol protocol, String script, String user, String password, SocketAddress target, String hostKeyFingerprint, String configType, Map<String,String> vars, java.time.Duration timeout)	Asks devices to upload their configuration by executing the given script and accepts the uploaded data.

Method Detail

retrieveConfig

CompletionStage<io.vavr.control.Either<Retriever.Failure,Retriever.Success>> retrieveConfig(Retriever.Protocol protocol,
                                                                                                  String script,
                                                                                                  String user,
                                                                                                  String password,
                                                                                                  SocketAddress target,
                                                                                                  String hostKeyFingerprint,
                                                                                                  String configType,
                                                                                                  Map<String,String> vars,
                                                                                                  java.time.Duration timeout)

Asks devices to upload their configuration by executing the given script and accepts the uploaded data.

Returns:

The returned completion stage is guaranteed to complete successfully, i.e. timeouts and all other kinds of failures are returned as a Failure instances.