Changeset 9396 in josm for trunk/src/org/openstreetmap/josm/io

Timestamp:

2016-01-10T20:09:16+01:00 (9 years ago)

Author:

simon04

Message:

fix #7122 - Improve HTTP authentication for parallel requests (TMS/WMS imagery)

File:

• trunk/src/org/openstreetmap/josm/io/auth/DefaultAuthenticator.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/io/auth/DefaultAuthenticator.java

@@ -4 +4 @@
 import java.net.Authenticator;
 import java.net.PasswordAuthentication;
-import java.util.EnumMap;
-import java.util.Map;
+import java.util.Collection;
+import java.util.HashSet;
 import java.util.Objects;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.io.OsmApi;
+import org.openstreetmap.josm.tools.Pair;
 
 /**
@@ -17 +18 @@
  */
 public final class DefaultAuthenticator extends Authenticator {
-    private static volatile DefaultAuthenticator instance;
+    private static final DefaultAuthenticator INSTANCE = new DefaultAuthenticator();
 
     /**
@@ -24 +25 @@
      */
     public static DefaultAuthenticator getInstance() {
-        return instance;
+        return INSTANCE;
     }
 
-    /**
-     * Creates the unique instance
-     */
-    public static void createInstance() {
-        instance = new DefaultAuthenticator();
-    }
-
-    private final Map<RequestorType, Boolean> credentialsTried = new EnumMap<>(RequestorType.class);
+    private final Collection<Pair<String, RequestorType>> failedCredentials = new HashSet<>();
     private boolean enabled = true;
 
@@ -54 +48 @@
                 return null;
             }
-            boolean tried = credentialsTried.get(getRequestorType()) != null;
-            CredentialsAgentResponse response = CredentialsManager.getInstance().getCredentials(getRequestorType(), getRequestingHost(), tried);
-            if (response == null || response.isCanceled())
+            final Pair<String, RequestorType> hostTypePair = Pair.create(getRequestingHost(), getRequestorType());
+            final boolean hasFailedPreviously = failedCredentials.contains(hostTypePair);
+            final CredentialsAgentResponse response = CredentialsManager.getInstance().getCredentials(
+                    getRequestorType(), getRequestingHost(), hasFailedPreviously);
+            if (response == null || response.isCanceled()) {
                 return null;
-            credentialsTried.put(getRequestorType(), Boolean.TRUE);
+            }
+            if (RequestorType.PROXY.equals(getRequestorType())) {
+                // Query user in case this authenticator is called (indicating that the authentication failed) the next time.
+                failedCredentials.add(hostTypePair);
+            } else {
+                // Other parallel requests should not ask the user again, thus wait till this request is finished.
+                // In case of invalid authentication, the host is added again to failedCredentials at HttpClient.connect()
+                failedCredentials.remove(hostTypePair);
+            }
             return new PasswordAuthentication(response.getUsername(), response.getPassword());
         } catch (CredentialsAgentException e) {
@@ -66 +70 @@
     }
 
+    /**
+     * Determines whether this authenticator is enabled, i.e.,
+     * provides {@link #getPasswordAuthentication() password authentication} via {@link CredentialsManager}.
+     * @return whether this authenticator is enabled
+     */
     public boolean isEnabled() {
         return enabled;
     }
 
+    /**
+     * Enabled/disables this authenticator, i.e., decides whether it
+     * should provide {@link #getPasswordAuthentication() password authentication} via {@link CredentialsManager}.
+     * @param enabled whether this authenticator should be enabled
+     */
     public void setEnabled(boolean enabled) {
         this.enabled = enabled;
     }
+
+    /**
+     * Marks for this host that the authentication failed, i.e.,
+     * the {@link CredentialsManager} will show a dialog at the next time.
+     * @param host the host to mark
+     * @return as per {@link Collection#add(Object)}
+     */
+    public boolean addFailedCredentialHost(String host) {
+        return failedCredentials.add(Pair.create(host, RequestorType.SERVER));
+    }
+
+    /**
+     * Un-marks the failed authentication attempt for the host
+     * @param host the host to un-mark
+     * @return as per {@link Collection#remove(Object)}
+     */
+    public boolean removeFailedCredentialHost(String host) {
+        return failedCredentials.remove(Pair.create(host, RequestorType.SERVER));
+    }
 }