Rename and move around classes

Author: stoty

httpclient5-testing/src/test/java/org/apache/hc/client5/testing/compatibility/spnego/SpnegoTestUtil.java

@@ -49,12 +49,12 @@
 import org.apache.hc.client5.http.SystemDefaultDnsResolver;
 import org.apache.hc.client5.http.auth.AuthSchemeFactory;
 import org.apache.hc.client5.http.auth.KerberosCredentials;
-import org.apache.hc.client5.http.auth.MutualKerberosConfig;
 import org.apache.hc.client5.http.auth.StandardAuthScheme;
+import org.apache.hc.client5.http.auth.gss.GssConfig;
 import org.apache.hc.client5.http.impl.auth.BasicSchemeFactory;
 import org.apache.hc.client5.http.impl.auth.BearerSchemeFactory;
 import org.apache.hc.client5.http.impl.auth.DigestSchemeFactory;
-import org.apache.hc.client5.http.impl.auth.MutualSpnegoSchemeFactory;
+import org.apache.hc.client5.http.impl.auth.gss.SpnegoSchemeFactory;
 import org.apache.hc.client5.testing.compatibility.ContainerImages;
 import org.apache.hc.client5.testing.util.SecurityUtils;
 import org.apache.hc.core5.http.config.Registry;
@@ -65,10 +65,10 @@
 
 public class SpnegoTestUtil {
 
-    static private final MutualKerberosConfig NO_MUTUAL_KERBEROS_CONFIG =
-            MutualKerberosConfig.custom().setRequestMutualAuth(false).build();
-    static private final MutualSpnegoSchemeFactory NO_MUTUAL_SCHEME_FACTORY =
-            new MutualSpnegoSchemeFactory(NO_MUTUAL_KERBEROS_CONFIG, SystemDefaultDnsResolver.INSTANCE);
+    static private final GssConfig NO_MUTUAL_KERBEROS_CONFIG =
+            GssConfig.custom().setRequestMutualAuth(false).build();
+    static private final SpnegoSchemeFactory NO_MUTUAL_SCHEME_FACTORY =
+            new SpnegoSchemeFactory(NO_MUTUAL_KERBEROS_CONFIG, SystemDefaultDnsResolver.INSTANCE);
 
     public static KerberosCredentials createCredentials(final Subject subject) {
         return SecurityUtils.callAs(subject, new Callable<KerberosCredentials>() {
@@ -94,7 +94,7 @@ public static Registry<AuthSchemeFactory> getSpnegoSchemeRegistry() {
                 .register(StandardAuthScheme.BEARER, BearerSchemeFactory.INSTANCE)
                 .register(StandardAuthScheme.BASIC, BasicSchemeFactory.INSTANCE)
                 .register(StandardAuthScheme.DIGEST, DigestSchemeFactory.INSTANCE)
-                .register(StandardAuthScheme.SPNEGO, MutualSpnegoSchemeFactory.DEFAULT)
+                .register(StandardAuthScheme.SPNEGO, SpnegoSchemeFactory.DEFAULT)
                 // register other schemes as needed
                 .build();
     }

…testing/sync/TestMutualSpnegoScheme.java …ient5/testing/sync/TestSpnegoScheme.javahttpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMutualSpnegoScheme.java renamed to httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestSpnegoScheme.java httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestMutualSpnegoScheme.java renamed to httpclient5-testing/src/test/java/org/apache/hc/client5/testing/sync/TestSpnegoScheme.java

@@ -43,12 +43,12 @@
 import org.apache.hc.client5.http.auth.AuthenticationException;
 import org.apache.hc.client5.http.auth.Credentials;
 import org.apache.hc.client5.http.auth.CredentialsProvider;
-import org.apache.hc.client5.http.auth.MutualKerberosConfig;
 import org.apache.hc.client5.http.auth.StandardAuthScheme;
+import org.apache.hc.client5.http.auth.gss.GssConfig;
 import org.apache.hc.client5.http.classic.methods.HttpGet;
 import org.apache.hc.client5.http.impl.DefaultAuthenticationStrategy;
 import org.apache.hc.client5.http.impl.auth.CredentialsProviderBuilder;
-import org.apache.hc.client5.http.impl.auth.MutualSpnegoScheme;
+import org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme;
 import org.apache.hc.client5.http.protocol.HttpClientContext;
 import org.apache.hc.client5.http.utils.Base64;
 import org.apache.hc.client5.testing.extension.sync.ClientProtocolLevel;
@@ -77,11 +77,11 @@
 import org.mockito.Mockito;
 
 /**
- * Tests for {@link SPNegoScheme}.
+ * Tests for {@link org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme}.
  */
-public class TestMutualSpnegoScheme extends AbstractIntegrationTestBase {
+public class TestSpnegoScheme extends AbstractIntegrationTestBase {
 
-    protected TestMutualSpnegoScheme() {
+    protected TestSpnegoScheme() {
         super(URIScheme.HTTP, ClientProtocolLevel.STANDARD);
     }
 
@@ -103,7 +103,7 @@ protected TestMutualSpnegoScheme() {
     private static final byte[] BAD_MUTUAL_AUTH_TOKEN_BYTES = BAD_MUTUAL_AUTH_TOKEN.getBytes(StandardCharsets.UTF_8);
     private static final byte[] BAD_MUTUAL_AUTH_TOKEN_B64_BYTES = Base64.encodeBase64(BAD_MUTUAL_AUTH_TOKEN_BYTES);
 
-    static MutualKerberosConfig MUTUAL_KERBEROS_CONFIG = MutualKerberosConfig.DEFAULT;
+    static GssConfig MUTUAL_KERBEROS_CONFIG = GssConfig.DEFAULT;
 
     private static class SpnegoAuthenticationStrategy extends DefaultAuthenticationStrategy {
 
@@ -146,13 +146,13 @@ public void handle(
     /**
      * This service implements a normal mutualAuth flow
      */
-    private static class SPNEGOMutualService implements HttpRequestHandler {
+    private static class SpnegoService implements HttpRequestHandler {
 
         int callCount = 1;
         final boolean sendMutualToken;
         final byte[] encodedMutualAuthToken;
 
-        SPNEGOMutualService (final boolean sendMutualToken, final byte[] encodedMutualAuthToken) {
+        SpnegoService (final boolean sendMutualToken, final byte[] encodedMutualAuthToken) {
             this.sendMutualToken = sendMutualToken;
             this.encodedMutualAuthToken = encodedMutualAuthToken;
         }
@@ -190,14 +190,14 @@ public void handle(
      * Kerberos configuration.
      *
      */
-    private static class NegotiateSchemeWithMockGssManager extends MutualSpnegoScheme {
+    private static class NegotiateSchemeWithMockGssManager extends SpnegoScheme {
 
         final GSSManager manager = Mockito.mock(GSSManager.class);
         final GSSName name = Mockito.mock(GSSName.class);
         final GSSContext context = Mockito.mock(GSSContext.class);
 
         NegotiateSchemeWithMockGssManager() throws Exception {
-            super(MutualKerberosConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE);
+            super(GssConfig.DEFAULT, SystemDefaultDnsResolver.INSTANCE);
             Mockito.when(context.initSecContext(
                     ArgumentMatchers.any(), ArgumentMatchers.anyInt(), ArgumentMatchers.anyInt()))
                     .thenReturn("12345678".getBytes());
@@ -217,7 +217,7 @@ protected GSSManager getManager() {
 
     }
 
-    private static class MutualNegotiateSchemeWithMockGssManager extends MutualSpnegoScheme {
+    private static class MutualNegotiateSchemeWithMockGssManager extends SpnegoScheme {
 
         final GSSManager manager = Mockito.mock(GSSManager.class);
         final GSSName name = Mockito.mock(GSSName.class);
@@ -354,7 +354,7 @@ void testNoTokenGeneratedError() throws Exception {
     @Test
     void testMutualSuccess() throws Exception {
         configureServer(t -> {
-            t.register("*", new SPNEGOMutualService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
+            t.register("*", new SpnegoService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
         });
         final HttpHost target = startServer();
 
@@ -388,7 +388,7 @@ void testMutualSuccess() throws Exception {
     @Test
     void testMutualFailureNoToken() throws Exception {
         configureServer(t -> {
-            t.register("*", new SPNEGOMutualService(false, null));
+            t.register("*", new SpnegoService(false, null));
         });
 
         final MutualNegotiateSchemeWithMockGssManager mockAuthScheme = new MutualNegotiateSchemeWithMockGssManager(false, false);
@@ -430,7 +430,7 @@ void testMutualFailureNoToken() throws Exception {
     @Test
     void testMutualFailureEstablishedStatusFalse() throws Exception {
         configureServer(t -> {
-            t.register("*", new SPNEGOMutualService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
+            t.register("*", new SpnegoService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
         });
 
         final MutualNegotiateSchemeWithMockGssManager mockAuthScheme = new MutualNegotiateSchemeWithMockGssManager(false, false);
@@ -471,7 +471,7 @@ void testMutualFailureEstablishedStatusFalse() throws Exception {
     @Test
     void testMutualFailureMutualStatusFalse() throws Exception {
         configureServer(t -> {
-            t.register("*", new SPNEGOMutualService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
+            t.register("*", new SpnegoService(true, GOOD_MUTUAL_AUTH_TOKEN_B64_BYTES));
         });
 
         final MutualNegotiateSchemeWithMockGssManager mockAuthScheme = new MutualNegotiateSchemeWithMockGssManager(true, false);
@@ -512,7 +512,7 @@ void testMutualFailureMutualStatusFalse() throws Exception {
     @Test
     void testMutualFailureBadToken() throws Exception {
         configureServer(t -> {
-            t.register("*", new SPNEGOMutualService(true, BAD_MUTUAL_AUTH_TOKEN_B64_BYTES));
+            t.register("*", new SpnegoService(true, BAD_MUTUAL_AUTH_TOKEN_B64_BYTES));
         });
 
         // We except that the initSecContent throws an exception, so the status is irrelevant

httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosConfig.java

@@ -37,9 +37,10 @@
  *
  * @deprecated Do not use. The old GGS based experimental authentication schemes are no longer
  * supported.
- * Use MutualSpnegoScheme, or consider using Basic or Bearer authentication with TLS instead.
- * @see org.apache.hc.client5.http.impl.auth.MutualSpnegoScheme
- * @see MutualKerberosConfig
+ * Use org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme, or consider using Basic or Bearer
+ * authentication with TLS instead.
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme
+ * @see org.apache.hc.client5.http.auth.gss.GssConfig
  */
 @Deprecated
 @Contract(threading = ThreadingBehavior.IMMUTABLE)

httpclient5/src/main/java/org/apache/hc/client5/http/auth/KerberosCredentials.java

@@ -39,10 +39,10 @@
  * @since 4.4
  *
  *
- * Optionally used both by {@link org.apache.hc.client5.http.impl.auth.MutualSpnegoScheme}
+ * Optionally used both by {@link org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme}
  * and the old deprecated GGS based experimental authentication schemes.
  *
- * @see org.apache.hc.client5.http.impl.auth.MutualSpnegoScheme
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme
  */
 @Contract(threading = ThreadingBehavior.IMMUTABLE)
 public class KerberosCredentials implements Credentials, Serializable {

httpclient5/src/main/java/org/apache/hc/client5/http/auth/StandardAuthScheme.java

@@ -67,7 +67,7 @@ private StandardAuthScheme() {
     /**
      * SPNEGO authentication scheme as defined in RFC 4559 and RFC 4178.
      *
-     * Use {@link org.apache.hc.client5.http.impl.auth.MutualSpnegoScheme} instead of the old
+     * Use {@link org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme} instead of the old
      * deprecated {@link org.apache.hc.client5.http.impl.auth.SPNegoScheme}
      */
     public static final String SPNEGO = "Negotiate";

…ent5/http/auth/MutualKerberosConfig.java …/hc/client5/http/auth/gss/GssConfig.javahttpclient5/src/main/java/org/apache/hc/client5/http/auth/MutualKerberosConfig.java renamed to httpclient5/src/main/java/org/apache/hc/client5/http/auth/gss/GssConfig.java httpclient5/src/main/java/org/apache/hc/client5/http/auth/MutualKerberosConfig.java renamed to httpclient5/src/main/java/org/apache/hc/client5/http/auth/gss/GssConfig.java

@@ -25,13 +25,14 @@
  *
  */
 
-package org.apache.hc.client5.http.auth;
+package org.apache.hc.client5.http.auth.gss;
 
 import org.apache.hc.core5.annotation.Contract;
 import org.apache.hc.core5.annotation.ThreadingBehavior;
 
 /**
- * Immutable class encapsulating Kerberos configuration options for MutualSpnegoScheme.
+ * Immutable class encapsulating Kerberos configuration options for the new mutual auth capable
+ * SpnegoScheme.
  *
  * Unlike the deprecated {@link KerberosConfig}, this class uses explicit defaults, and
  * primitive booleans.
@@ -43,10 +44,10 @@
  *
  */
 @Contract(threading = ThreadingBehavior.IMMUTABLE)
-public class MutualKerberosConfig implements Cloneable {
+public class GssConfig implements Cloneable {
 
 
-    public static final MutualKerberosConfig DEFAULT = new Builder().build();
+    public static final GssConfig DEFAULT = new Builder().build();
 
     private final boolean addPort;
     private final boolean useCanonicalHostname;
@@ -56,11 +57,11 @@ public class MutualKerberosConfig implements Cloneable {
     /**
      * Intended for CDI compatibility
     */
-    protected MutualKerberosConfig() {
+    protected GssConfig() {
         this(false, false, true, false);
     }
 
-    MutualKerberosConfig(
+    GssConfig(
             final boolean stripPort,
             final boolean useCanonicalHostname,
             final boolean requestMutualAuth,
@@ -89,8 +90,8 @@ public boolean isRequestMutualAuth() {
     }
 
     @Override
-    protected MutualKerberosConfig clone() throws CloneNotSupportedException {
-        return (MutualKerberosConfig) super.clone();
+    protected GssConfig clone() throws CloneNotSupportedException {
+        return (GssConfig) super.clone();
     }
 
     @Override
@@ -105,11 +106,11 @@ public String toString() {
         return builder.toString();
     }
 
-    public static MutualKerberosConfig.Builder custom() {
+    public static GssConfig.Builder custom() {
         return new Builder();
     }
 
-    public static MutualKerberosConfig.Builder copy(final MutualKerberosConfig config) {
+    public static GssConfig.Builder copy(final GssConfig config) {
         return new Builder()
                 .setAddPort(config.isAddPort())
                 .setUseCanonicalHostname(config.isUseCanonicalHostname())
@@ -148,8 +149,8 @@ public Builder setRequestDelegCreds(final boolean requuestDelegCreds) {
             return this;
         }
 
-        public MutualKerberosConfig build() {
-            return new MutualKerberosConfig(
+        public GssConfig build() {
+            return new GssConfig(
                     addPort,
                     useCanonicalHostname,
                     requestMutualAuth,

httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/GGSSchemeBase.java

@@ -61,9 +61,9 @@
  * @since 4.2
  *
  * @deprecated Do not use. The GGS based experimental authentication schemes are no longer
- * supported. Use MutualSpnegoScheme, or consider using Basic or Bearer authentication with TLS
- * instead.
- * @see MutualSpnegoScheme
+ * supported. Use org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme, or consider using Basic or
+ * Bearer authentication with TLS instead.
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme
  * @see BasicScheme
  * @see BearerScheme
  */

httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosScheme.java

@@ -42,9 +42,10 @@
  * @since 4.2
  *
  * @deprecated Do not use. The old GGS based experimental authentication schemes are no longer
- * supported. Use MutualSpnegoScheme, or consider using Basic or Bearer authentication with TLS
+ * supported. Use org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme, or consider using Basic or
+ * Bearer authentication with TLS
  * instead.
- * @see MutualSpnegoScheme
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme
  * @see BasicScheme
  * @see BearerScheme
  */

httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/KerberosSchemeFactory.java

@@ -46,9 +46,9 @@
  * @since 4.2
  *
  * @deprecated Do not use. The old GGS based experimental authentication schemes are no longer
- * supported. Use MutualSpnegoSchemeFactory, or consider using Basic or Bearer authentication
- * with TLS instead.
- * @see MutualSpnegoSchemeFactory
+ * supported. Use org.apache.hc.client5.http.impl.auth.gss.SpnegoSchemeFactory, or consider using
+ * Basic or Bearer authentication with TLS instead.
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoSchemeFactory
  * @see BasicSchemeFactory
  * @see BearerSchemeFactory
  */

httpclient5/src/main/java/org/apache/hc/client5/http/impl/auth/SPNegoScheme.java

@@ -43,9 +43,9 @@
  * @since 4.2
  *
  * @deprecated Do not use. The old GGS based experimental authentication schemes are no longer
- * supported. Use MutualSpnegoScheme, or consider using Basic or Bearer authentication with TLS
- * instead.
- * @see MutualSpnegoScheme
+ * supported. Use org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme, or consider using Basic or
+ * Bearer authentication with TLS instead.
+ * @see org.apache.hc.client5.http.impl.auth.gss.SpnegoScheme
  * @see BasicScheme
  * @see BearerScheme
  */