-
Notifications
You must be signed in to change notification settings - Fork 214
/
HttpProxyConfig.java
121 lines (99 loc) · 2.81 KB
/
HttpProxyConfig.java
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
116
117
118
119
120
121
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.base.service.config.http;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
import org.apache.pekko.http.javadsl.ClientTransport;
/**
* Provides configuration settings for the HTTP proxy.
*/
@Immutable
public interface HttpProxyConfig {
/**
* Indicates whether the HTTP proxy should be enabled.
*
* @return {@code true} if the HTTP proxy should be enabled, {@code false} else.
*/
boolean isEnabled();
/**
* Returns the host name of the HTTP proxy.
*
* @return the host name
*/
String getHostname();
/**
* Returns the port of the HTTP proxy.
*
* @return the port.
*/
int getPort();
/**
* Returns the user name of the HTTP proxy.
*
* @return the user name.
*/
String getUsername();
/**
* Returns the password of the HTTP proxy.
*
* @return the password.
*/
String getPassword();
/**
* Converts the proxy settings to an Akka HTTP client transport object.
* Does not check whether the proxy is enabled.
*
* @return an Akka HTTP client transport object matching this config.
*/
ClientTransport toClientTransport();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code HttpProxyConfig}.
*/
enum HttpProxyConfigValue implements KnownConfigValue {
/**
* Determines whether the HTTP proxy should be enabled.
*/
ENABLED("enabled", false),
/**
* The host name of the HTTP proxy.
*/
HOST_NAME("hostname", ""),
/**
* The port of the HTTP proxy.
*/
PORT("port", 0),
/**
* The user name of the HTTP proxy.
*/
USER_NAME("username", ""),
/**
* The password of the HTTP proxy.
*/
PASSWORD("password", "");
private final String path;
private final Object defaultValue;
private HttpProxyConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}