changes from review - rename resolveAlias to followLinks

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>

documentation/jetty-documentation/src/main/asciidoc/operations-guide/modules/module-ssl-reload.adoc

@@ -23,4 +23,5 @@ The module properties are:
 include::{JETTY_HOME}/modules/ssl-reload.mod[tags=documentation]
 ----
 
-The `resolveAlias` property is used to specify whether aliases should be resolved in the path of the KeyStore. If set to false and the path of the KeyStore is a symbolic link, the scanner will monitor the symbolic link file for changes instead of its target.
+The `followLinks` property is used to specify whether symlinks should be resolved in the path of the KeyStore.
+If set to false and the path of the KeyStore is a symbolic link, the scanner will monitor the symbolic link file for changes instead of its target.

jetty-server/src/main/config/etc/jetty-ssl-context-reload.xml

@@ -5,7 +5,7 @@
     <Arg>
       <New id="keyStoreScanner" class="org.eclipse.jetty.util.ssl.KeyStoreScanner">
         <Arg><Ref refid="sslContextFactory"/></Arg>
-        <Arg type="boolean"><Property name="jetty.sslContext.reload.resolveAlias" default="true"/></Arg>
+        <Arg type="boolean"><Property name="jetty.sslContext.reload.followLinks" default="true"/></Arg>
         <Set name="scanInterval"><Property name="jetty.sslContext.reload.scanInterval" default="1"/></Set>
       </New>
     </Arg>

jetty-server/src/main/config/modules/ssl-reload.mod

@@ -16,6 +16,6 @@ etc/jetty-ssl-context-reload.xml
 # Monitored directory scan period, in seconds.
 # jetty.sslContext.reload.scanInterval=1
 
-# Whether to resolve aliases in the KeyStore path.
-# jetty.sslContext.reload.resolveAlias=true
+# Whether to resolve symbolic links in the KeyStore path.
+# jetty.sslContext.reload.followLinks=true
 # end::documentation[]

jetty-util/src/main/java/org/eclipse/jetty/util/ssl/KeyStoreScanner.java

@@ -47,7 +47,7 @@ public class KeyStoreScanner extends ContainerLifeCycle implements Scanner.Discr
         this(sslContextFactory, true);
     }
 
-    public KeyStoreScanner(SslContextFactory sslContextFactory, boolean resolveAlias)
+    public KeyStoreScanner(SslContextFactory sslContextFactory, boolean followLinks)
     {
         this.sslContextFactory = sslContextFactory;
         try
@@ -59,7 +59,7 @@ public class KeyStoreScanner extends ContainerLifeCycle implements Scanner.Discr
             if (monitoredFile.isDirectory())
                 throw new IllegalArgumentException("expected keystore file not directory");
 
-            if (resolveAlias && keystoreResource.isAlias())
+            if (followLinks && keystoreResource.isAlias())
             {
                 // This resource has an alias, so monitor the target of the alias.
                 monitoredFile = new File(keystoreResource.getAlias());
@@ -78,7 +78,7 @@ public class KeyStoreScanner extends ContainerLifeCycle implements Scanner.Discr
         if (!parentFile.exists() || !parentFile.isDirectory())
             throw new IllegalArgumentException("error obtaining keystore dir");
 
-        _scanner = new Scanner(null, resolveAlias);
+        _scanner = new Scanner(null, followLinks);
         _scanner.addDirectory(parentFile.toPath());
         _scanner.setScanInterval(1);
         _scanner.setReportDirs(false);

tests/test-integration/src/test/java/org/eclipse/jetty/test/KeyStoreScannerTest.java

@@ -79,7 +79,7 @@ public class KeyStoreScannerTest
     {
         start(sslContextFactory ->
         {
-            String keystorePath = useKeystore("oldKeystore").toString();
+            String keystorePath = useKeystore("oldKeyStore").toString();
             sslContextFactory.setKeyStorePath(keystorePath);
             sslContextFactory.setKeyStorePassword("storepwd");
             sslContextFactory.setKeyManagerPassword("keypwd");
@@ -127,8 +127,8 @@ public class KeyStoreScannerTest
         X509Certificate cert1 = getCertificateFromServer();
         assertThat(getExpiryYear(cert1), is(2015));
 
-        // Switch to use newKeystore which has a later expiry date.
-        useKeystore("newKeystore");
+        // Switch to use newKeyStore which has a later expiry date.
+        useKeystore("newKeyStore");
         assertTrue(keyStoreScanner.scan(5000));
 
         // The scanner should have detected the updated keystore, expiry should be renewed.
@@ -177,7 +177,7 @@ public class KeyStoreScannerTest
         assertThrows(Throwable.class, this::getCertificateFromServer);
 
         // Switch to use keystore2 which has a later expiry date.
-        useKeystore("newKeystore");
+        useKeystore("newKeyStore");
         keyStoreScanner.scan(5000);
         X509Certificate cert2 = getCertificateFromServer();
         assertThat(getExpiryYear(cert2), is(2020));
@@ -187,13 +187,13 @@ public class KeyStoreScannerTest
     public void testReloadChangingSymbolicLink() throws Exception
     {
         assumeFileSystemSupportsSymlink();
-        Path newKeystore = useKeystore("newKeystore", "newKeystore");
-        Path oldKeystore = useKeystore("oldKeystore", "oldKeystore");
+        Path newKeyStore = useKeystore("newKeyStore", "newKeyStore");
+        Path oldKeyStore = useKeystore("oldKeyStore", "oldKeyStore");
 
         Path symlinkKeystorePath = keystoreDir.resolve("symlinkKeystore");
         start(sslContextFactory ->
         {
-            Files.createSymbolicLink(symlinkKeystorePath, oldKeystore);
+            Files.createSymbolicLink(symlinkKeystorePath, oldKeyStore);
             sslContextFactory.setKeyStorePath(symlinkKeystorePath.toString());
             sslContextFactory.setKeyStorePassword("storepwd");
             sslContextFactory.setKeyManagerPassword("keypwd");
@@ -203,9 +203,9 @@ public class KeyStoreScannerTest
         X509Certificate cert1 = getCertificateFromServer();
         assertThat(getExpiryYear(cert1), is(2015));
 
-        // Change the symlink to point to the newKeystore file location which has a later expiry date.
+        // Change the symlink to point to the newKeyStore file location which has a later expiry date.
         Files.delete(symlinkKeystorePath);
-        Files.createSymbolicLink(symlinkKeystorePath, newKeystore);
+        Files.createSymbolicLink(symlinkKeystorePath, newKeyStore);
         keyStoreScanner.scan(5000);
 
         // The scanner should have detected the updated keystore, expiry should be renewed.
@@ -218,13 +218,13 @@ public class KeyStoreScannerTest
     {
         assumeFileSystemSupportsSymlink();
         Path keystoreLink = keystoreDir.resolve("symlinkKeystore");
-        Path oldKeystoreSrc = MavenTestingUtils.getTestResourcePathFile("oldKeystore");
-        Path newKeystoreSrc = MavenTestingUtils.getTestResourcePathFile("newKeystore");
+        Path oldKeyStoreSrc = MavenTestingUtils.getTestResourcePathFile("oldKeyStore");
+        Path newKeyStoreSrc = MavenTestingUtils.getTestResourcePathFile("newKeyStore");
         Path target = keystoreDir.resolve("keystore");
 
         start(sslContextFactory ->
         {
-            Files.copy(oldKeystoreSrc, target);
+            Files.copy(oldKeyStoreSrc, target);
             Files.createSymbolicLink(keystoreLink, target);
             sslContextFactory.setKeyStorePath(keystoreLink.toString());
             sslContextFactory.setKeyStorePassword("storepwd");
@@ -235,8 +235,8 @@ public class KeyStoreScannerTest
         X509Certificate cert1 = getCertificateFromServer();
         assertThat(getExpiryYear(cert1), is(2015));
 
-        // Change the target file of the symlink to the newKeystore which has a later expiry date.
-        Files.copy(newKeystoreSrc, target, StandardCopyOption.REPLACE_EXISTING);
+        // Change the target file of the symlink to the newKeyStore which has a later expiry date.
+        Files.copy(newKeyStoreSrc, target, StandardCopyOption.REPLACE_EXISTING);
         System.err.println("### Triggering scan");
         keyStoreScanner.scan(5000);