blob: 767151afeeef1b3fd1ba6027bd0a24ecab2943d3 (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.config.protocol;
import com.yahoo.vespa.config.PayloadChecksums;
/**
* Interface for config requests used by clients.
*
* @author Ulf Lilleengen
*/
public interface JRTClientConfigRequest extends JRTConfigRequest {
/**
* Validate config response given by the server. If none is given, or an error occurred, this should return false.
*
* @return true if valid response, false if not.
*/
boolean validateResponse();
/**
* Test whether ot not the returned config has an updated generation. This should return false if no response have
* been given.
*
* @return true if generation is updated, false if not.
*/
boolean hasUpdatedGeneration();
/**
* Return the payload in the response given by the server. The payload will be empty if no response was given.
*
* @return the config payload.
*/
Payload getNewPayload();
/**
* Create a new {@link JRTClientConfigRequest} based on this request based on the same request parameters,
* but having the timeout changed.
*
* @param timeout server timeout of the new request.
* @return a new {@link JRTClientConfigRequest} instance.
*/
JRTClientConfigRequest nextRequest(long timeout);
/**
* Test whether or not the returned request is an error.
*
* @return true if error, false if not.
*/
boolean isError();
/**
* Get the generation of the newly provided config. If none has been given, 0 should be returned.
*
* @return the new generation.
*/
long getNewGeneration();
/** Returns true if this config should only be applied at the last restart, false if it should be applied immediately */
boolean responseIsApplyOnRestart();
/**
* Gets the config checksums of the config returned by the server. Returns an empty string if no response has been returned.
*
* @return a config checksum.
*/
PayloadChecksums getNewChecksums();
/**
* Test whether or not the response contains an updated config or not.
* False if no response has been returned.
*
* @return true if config is updated, false if not.
*/
boolean hasUpdatedConfig();
/**
* Get the {@link Trace} given in the response by the server.
* The {@link Trace} can be used to add further tracing and later printed to provide useful debug info.
*
* @return a {@link Trace}.
*/
Trace getResponseTrace();
/**
* Get config definition content.
*
* @return def as lines.
*/
DefContent getDefContent();
}
|
