aboutsummaryrefslogtreecommitdiffstats
path: root/config/src/vespa/config/common/configresponse.h
blob: 7c73bec127cd04ffd3e3fbb5d4b2a91b14df4b96 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include <vespa/vespalib/stllike/string.h>
#include <memory>

namespace config {

class ConfigValue;
class ConfigKey;
struct ConfigState;
class Trace;

/**
 * Baseclass for config responses.
 */
class ConfigResponse {
public:
    virtual ~ConfigResponse() = default;

    virtual const ConfigKey & getKey() const = 0;
    virtual const ConfigValue & getValue() const = 0;

    virtual const ConfigState & getConfigState() const = 0;
    virtual const Trace & getTrace() const = 0;

    virtual bool hasValidResponse() const = 0;

    /**
     * Verifies that the returned response meets any criteria (decided by the implementation) to use the getters
     * for return values. The result from this validation can be found without performing the validation
     * again by calling {@link ConfigResponse#hasValidResponse()}.
     *
     * @return true if the returned response meets criteria to use the getters for return values.
     */
    virtual bool validateResponse() = 0;

    /**
     * Fills all data received in the response in order to be able to retrieve
     * the config values. Should not be called before the response has been
     * validated.
     */
    virtual void fill() = 0;

    /** @return Error message if a request has failed, null otherwise. */
    virtual vespalib::string errorMessage() const = 0;

    virtual int errorCode() const = 0;

    virtual bool isError() const = 0;
};

}