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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package ai.vespa.feed.client;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.SSLContext;
import java.net.URI;
import java.nio.file.Path;
import java.security.PrivateKey;
import java.security.cert.X509Certificate;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.function.Supplier;
/**
* Builder for creating a {@link FeedClient} instance.
*
* @author bjorncs
* @author jonmv
*/
public interface FeedClientBuilder {
String PREFERRED_IMPLEMENTATION_PROPERTY = "vespa.feed.client.builder.implementation";
/** Creates a builder for a single container endpoint **/
static FeedClientBuilder create(URI endpoint) { return create(Collections.singletonList(endpoint)); }
/** Creates a builder for multiple container endpoints **/
static FeedClientBuilder create(List<URI> endpoints) {
return Helper.getFeedClientBuilderSupplier().get().setEndpointUris(endpoints);
}
/** Override FeedClientBuilder. This will be preferred in {@link #create} */
static void setFeedClientBuilderSupplier(Supplier<FeedClientBuilder> supplier) {
Helper.setFeedClientBuilderSupplier(supplier);
}
/**
* Sets the number of connections this client will use per endpoint.
*
* A reasonable value here is a value that lets all feed clients (if more than one)
* collectively have a number of connections which is a small multiple of the numbers
* of containers in the cluster to feed, so load can be balanced across these containers.
* In general, this value should be kept as low as possible, but poor connectivity
* between feeder and cluster may also warrant a higher number of connections.
*/
FeedClientBuilder setConnectionsPerEndpoint(int max);
/**
* Sets the maximum number of streams per HTTP/2 connection for this client.
*
* This determines the maximum number of concurrent, inflight requests for this client,
* which is {@code maxConnections * maxStreamsPerConnection}. Prefer more streams over
* more connections, when possible.
* The feed client automatically throttles load to achieve the best throughput, and the
* actual number of streams per connection is usually lower than the maximum.
*/
FeedClientBuilder setMaxStreamPerConnection(int max);
/** Sets {@link SSLContext} instance. */
FeedClientBuilder setSslContext(SSLContext context);
/** Sets {@link HostnameVerifier} instance (e.g for disabling default SSL hostname verification). */
FeedClientBuilder setHostnameVerifier(HostnameVerifier verifier);
/** Turns off benchmarking. Attempting to get {@link FeedClient#stats()} will result in an exception. */
FeedClientBuilder noBenchmarking();
/** Adds HTTP request header to all client requests. */
FeedClientBuilder addRequestHeader(String name, String value);
/**
* Adds HTTP request header to all client requests. Value {@link Supplier} is invoked for each HTTP request,
* i.e. value can be dynamically updated during a feed.
*/
FeedClientBuilder addRequestHeader(String name, Supplier<String> valueSupplier);
/**
* Overrides default retry strategy.
* @see FeedClient.RetryStrategy
*/
FeedClientBuilder setRetryStrategy(FeedClient.RetryStrategy strategy);
/**
* Overrides default circuit breaker.
* @see FeedClient.CircuitBreaker
*/
FeedClientBuilder setCircuitBreaker(FeedClient.CircuitBreaker breaker);
/** Sets path to client SSL certificate/key PEM files */
FeedClientBuilder setCertificate(Path certificatePemFile, Path privateKeyPemFile);
/** Sets client SSL certificates/key */
FeedClientBuilder setCertificate(Collection<X509Certificate> certificate, PrivateKey privateKey);
/** Sets client SSL certificate/key */
FeedClientBuilder setCertificate(X509Certificate certificate, PrivateKey privateKey);
FeedClientBuilder setDryrun(boolean enabled);
/**
* Overrides JVM default SSL truststore
* @param caCertificatesFile Path to PEM encoded file containing trusted certificates
*/
FeedClientBuilder setCaCertificatesFile(Path caCertificatesFile);
/** Overrides JVM default SSL truststore */
FeedClientBuilder setCaCertificates(Collection<X509Certificate> caCertificates);
/** Overrides endpoint URIs for this client */
FeedClientBuilder setEndpointUris(List<URI> endpoints);
/** Constructs instance of {@link FeedClient} from builder configuration */
FeedClient build();
}
|
