Changeset 2641 in josm for trunk/src/org/openstreetmap/josm/io/auth/CredentialsManager.java

Timestamp:

2009-12-16T18:58:04+01:00 (14 years ago)

Author:

Gubaer

Message:

new: supports system defined proxies if JOSM is started with -Djava.net.useSystemProxies=true
fixed #1641: JOSM doesn't allow for setting HTTP proxy user/password distrinct from OSM server user/password
fixed #2865: SOCKS Proxy Support
fixed #4182: Proxy Authentication

Location:

trunk/src/org/openstreetmap/josm/io/auth

Files:

• . (added)
• CredentialsManager.java (moved) (moved from trunk/src/org/openstreetmap/josm/io/CredentialsManager.java ) (1 diff)

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

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
-package org.openstreetmap.josm.io;
+package org.openstreetmap.josm.io.auth;
 
-import org.openstreetmap.josm.io.OsmConnection.OsmAuth;
+import java.net.PasswordAuthentication;
+import java.net.Authenticator.RequestorType;
 
 /**
- * Manages how username and password are stored. In addition all
- * username/password-related user interaction is encapsulated here.
+ * A CredentialManager manages two credentials:
+ * <ul>
+ *   <li>the credential for {@see RequestorType#SERVER} which is equal to the OSM API credentials
+ *   in JOSM</li>
+ *   <li>the credential for {@see RequestorType#PROXY} which is equal to the credentials for an
+ *   optional HTTP proxy server a user may use</li>
+ *  </ul>
  */
 public interface CredentialsManager {
-    enum Key {
-        OSM_SERVER_URL("url"),
-        USERNAME("username"),
-        PASSWORD("password");
-        final private String pname;
-        private Key(String name) {
-            pname = name;
-        }
-        @Override public String toString() {
-            return pname;
-        }
-    };
 
     /**
-     * Should throw or return non-null, possibly empty String.
+     * Looks up the credentials for a given type.
+     * 
+     * @param the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * for a proxy server
+     * @return the credentials
+     * @throws CredentialsManagerException thrown if a problem occurs in a implementation of this interface
      */
-    public String lookup(Key key) throws CMException;
+    public PasswordAuthentication lookup(RequestorType requestorType) throws CredentialsManagerException;
 
     /**
-     * May silently fail to store.
+     * Saves the credentials in <code>credentials</code> for the given service type.
+     * 
+     * @param the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * for a proxy server
+     * @param credentials the credentials
+     * @throws CredentialsManagerException thrown if a problem occurs in a implementation of this interface
      */
-    public void store(Key key, String secret) throws CMException;
+    public void store(RequestorType requestorType, PasswordAuthentication credentials) throws CredentialsManagerException;
 
     /**
-     * If authentication using the stored credentials fails, this method is
-     * called to promt for new username/password.
+     * 
+     * @param requestorType  the type of service. {@see RequestorType#SERVER} for the OSM API server, {@see RequestorType#PROXY}
+     * for a proxy server
+     * @param noSuccessWithLastResponse true, if the last request with the supplied credentials failed; false otherwise.
+     * If true, implementations of this interface are adviced prompt user for new credentials.
+     * @throws CredentialsManagerException thrown if a problem occurs in a implementation of this interface
+
      */
-    public java.net.PasswordAuthentication getPasswordAuthentication(OsmAuth caller);
-
-    /**
-     * Credentials-related preference gui.
-     */
-    public interface PreferenceAdditions {
-        public void addPreferenceOptions(javax.swing.JPanel panel);
-        public void preferencesChanged();
-    }
-    public PreferenceAdditions newPreferenceAdditions();
-
-    public class CMException extends Exception {
-        public CMException() {super();}
-        public CMException(String message, Throwable cause) {super(message, cause);}
-        public CMException(String message) {super(message);}
-        public CMException(Throwable cause) {super(cause);}
-    }
-    public class NoContentException extends CMException {
-        public NoContentException() {super();}
-        public NoContentException(String message, Throwable cause) {super(message, cause);}
-        public NoContentException(String message) {super(message);}
-        public NoContentException(Throwable cause) {super(cause);}
-    }
+    public CredentialsManagerResponse getCredentials(RequestorType requestorType, boolean noSuccessWithLastResponse) throws CredentialsManagerException;
 }