Skip to content

Commit 717d9f8

Browse files
committed
Store SSLConfig instead SSLContext
1 parent 39ed583 commit 717d9f8

5 files changed

Lines changed: 22 additions & 26 deletions

File tree

src/main/java/com/github/dockerjava/core/DefaultDockerClientConfig.java

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
import java.util.Properties;
1414
import java.util.Set;
1515

16-
import javax.net.ssl.SSLContext;
17-
1816
import org.apache.commons.lang.StringUtils;
1917
import org.apache.commons.lang.builder.EqualsBuilder;
2018
import org.apache.commons.lang.builder.HashCodeBuilder;
@@ -74,16 +72,16 @@ public class DefaultDockerClientConfig implements Serializable, DockerClientConf
7472

7573
private final String registryUsername, registryPassword, registryEmail, registryUrl, dockerConfig;
7674

77-
private final SSLContext sslContext;
75+
private final SSLConfig sslConfig;
7876

7977
private final RemoteApiVersion apiVersion;
8078

8179
DefaultDockerClientConfig(URI dockerHost, String dockerConfig, String apiVersion, String registryUrl,
82-
String registryUsername, String registryPassword, String registryEmail, SSLContext sslContext) {
80+
String registryUsername, String registryPassword, String registryEmail, SSLConfig sslConfig) {
8381
this.dockerHost = checkDockerHostScheme(dockerHost);
8482
this.dockerConfig = dockerConfig;
8583
this.apiVersion = RemoteApiVersion.parseConfigWithDefault(apiVersion);
86-
this.sslContext = sslContext;
84+
this.sslConfig = sslConfig;
8785
this.registryUsername = registryUsername;
8886
this.registryPassword = registryPassword;
8987
this.registryEmail = registryEmail;
@@ -296,8 +294,8 @@ public AuthConfigurations getAuthConfigurations() {
296294
}
297295

298296
@Override
299-
public SSLContext getSSLContext() {
300-
return sslContext;
297+
public SSLConfig getSSLConfig() {
298+
return sslConfig;
301299
}
302300

303301
// CHECKSTYLE:OFF
@@ -333,7 +331,7 @@ public static class Builder {
333331

334332
private boolean dockerTlsVerify;
335333

336-
private SSLContext customSslContext = null;
334+
private SSLConfig customSslConfig = null;
337335

338336
/**
339337
* This will set all fields in the builder to those contained in the Properties object. The Properties object should contain the
@@ -413,30 +411,30 @@ public final Builder withDockerTlsVerify(Boolean dockerTlsVerify) {
413411
}
414412

415413
/**
416-
* Overrides the default {@link SSLContext} that is used when calling {@link Builder#withDockerTlsVerify(true)} and
417-
* {@link Builder#withDockerCertPath(String)}. This way it is possible to pass a custom {@link SSLContext} to the resulting
414+
* Overrides the default {@link SSLConfig} that is used when calling {@link Builder#withDockerTlsVerify(java.lang.Boolean)} and
415+
* {@link Builder#withDockerCertPath(String)}. This way it is possible to pass a custom {@link SSLConfig} to the resulting
418416
* {@link DockerClientConfig} that may be created by other means than the local file system.
419417
*/
420-
public final Builder withCustomSslContext(SSLContext customSslContext) {
421-
this.customSslContext = customSslContext;
418+
public final Builder withCustomSslConfig(SSLConfig customSslConfig) {
419+
this.customSslConfig = customSslConfig;
422420
return this;
423421
}
424422

425423
public DefaultDockerClientConfig build() {
426424

427-
SSLContext sslContext = null;
425+
SSLConfig sslConfig = null;
428426

429-
if (customSslContext == null) {
427+
if (customSslConfig == null) {
430428
if (dockerTlsVerify) {
431429
dockerCertPath = checkDockerCertPath(dockerCertPath);
432-
sslContext = new LocalDirectorySSLConfig(dockerCertPath).getSSLContext();
430+
sslConfig = new LocalDirectorySSLConfig(dockerCertPath);
433431
}
434432
} else {
435-
sslContext = customSslContext;
433+
sslConfig = customSslConfig;
436434
}
437435

438436
return new DefaultDockerClientConfig(dockerHost, dockerConfig, apiVersion, registryUrl, registryUsername,
439-
registryPassword, registryEmail, sslContext);
437+
registryPassword, registryEmail, sslConfig);
440438
}
441439

442440
private String checkDockerCertPath(String dockerCertPath) {

src/main/java/com/github/dockerjava/core/DockerClientConfig.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66
import java.net.URI;
77

8-
import javax.net.ssl.SSLContext;
9-
108
import com.github.dockerjava.api.model.AuthConfig;
119
import com.github.dockerjava.api.model.AuthConfigurations;
1210

@@ -35,8 +33,8 @@ public interface DockerClientConfig {
3533
AuthConfigurations getAuthConfigurations();
3634

3735
/**
38-
* Returns an {@link SSLContext} when secure connection is configured or null if not.
36+
* Returns an {@link SSLConfig} when secure connection is configured or null if not.
3937
*/
40-
SSLContext getSSLContext();
38+
SSLConfig getSSLConfig();
4139

4240
}

src/main/java/com/github/dockerjava/jaxrs/DockerCmdExecFactoryImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ public void init(DockerClientConfig dockerClientConfig) {
161161
SSLContext sslContext = null;
162162

163163
try {
164-
sslContext = dockerClientConfig.getSSLContext();
164+
sslContext = dockerClientConfig.getSSLConfig().getSSLContext();
165165
} catch (Exception ex) {
166166
throw new DockerClientException("Error in SSL Configuration", ex);
167167
}

src/main/java/com/github/dockerjava/netty/DockerCmdExecFactoryImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ private SslHandler initSsl(DockerClientConfig dockerClientConfig) {
283283
String host = dockerClientConfig.getDockerHost().getHost();
284284
int port = dockerClientConfig.getDockerHost().getPort();
285285

286-
SSLContext sslContext = dockerClientConfig.getSSLContext();
286+
SSLContext sslContext = dockerClientConfig.getSSLConfig().getSSLContext();
287287

288288
if (sslContext != null) {
289289

src/test/java/com/github/dockerjava/core/DefaultDockerClientConfigTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ private static DefaultDockerClientConfig newExampleConfig() {
2828
String dockerCertPath = dockerCertPath();
2929

3030
return new DefaultDockerClientConfig(URI.create("tcp://foo"), "dockerConfig", "apiVersion", "registryUrl", "registryUsername", "registryPassword", "registryEmail",
31-
new LocalDirectorySSLConfig(dockerCertPath).getSSLContext());
31+
new LocalDirectorySSLConfig(dockerCertPath));
3232
}
3333

3434
private static String homeDir() {
@@ -107,7 +107,7 @@ public void defaults() throws Exception {
107107
assertEquals(config.getRegistryUrl(), AuthConfig.DEFAULT_SERVER_ADDRESS);
108108
assertEquals(config.getApiVersion(), RemoteApiVersion.unknown());
109109
assertEquals(config.getDockerConfig(), homeDir() + "/.docker");
110-
assertNull(config.getSSLContext());
110+
assertNull(config.getSSLConfig());
111111
}
112112

113113
@Test
@@ -152,7 +152,7 @@ public void testSslContextEmpty() throws Exception {
152152
@Test()
153153
public void testTlsVerifyAndCertPath() throws Exception {
154154
new DefaultDockerClientConfig(URI.create("tcp://foo"), "dockerConfig", "apiVersion", "registryUrl", "registryUsername", "registryPassword", "registryEmail",
155-
new LocalDirectorySSLConfig(dockerCertPath()).getSSLContext());
155+
new LocalDirectorySSLConfig(dockerCertPath()));
156156
}
157157

158158
@Test(expectedExceptions = DockerClientException.class)

0 commit comments

Comments
 (0)