Changeset 12928 in josm for trunk/src/org/openstreetmap/josm/data

Timestamp:

2017-10-06T15:17:51+02:00 (7 years ago)

Author:

bastiK

Message:

see #15229 - do not copy the entire preferences list, just to set a custom server API in OAuth wizard

Location:

trunk/src/org/openstreetmap/josm/data/oauth

Files:

• OAuthAccessTokenHolder.java (modified) (4 diffs)
• OAuthParameters.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/oauth/OAuthAccessTokenHolder.java

@@ -7 +7 @@
 import org.openstreetmap.josm.io.auth.CredentialsAgent;
 import org.openstreetmap.josm.io.auth.CredentialsAgentException;
+import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.Logging;
@@ -143 +144 @@
      * credential manager.
      *
+     * @param cm the credential manager. Must not be null.
+     * @throws IllegalArgumentException if cm is null
+     */
+    public void init(CredentialsAgent cm) {
+        CheckParameterUtil.ensureParameterNotNull(cm, "cm");
+        OAuthToken token = null;
+        try {
+            token = cm.lookupOAuthAccessToken();
+        } catch (CredentialsAgentException e) {
+            Logging.error(e);
+            Logging.warn(tr("Failed to retrieve OAuth Access Token from credential manager"));
+            Logging.warn(tr("Current credential manager is of type ''{0}''", cm.getClass().getName()));
+        }
+        saveToPreferences = Config.getPref().getBoolean("oauth.access-token.save-to-preferences", true);
+        if (token != null) {
+            accessTokenKey = token.getKey();
+            accessTokenSecret = token.getSecret();
+        }
+    }
+
+    /**
+     * Initializes the content of this holder from the Access Token managed by the
+     * credential manager.
+     *
      * @param pref the preferences. Must not be null.
      * @param cm the credential manager. Must not be null.
      * @throws IllegalArgumentException if cm is null
-     */
+     * @deprecated (since 12928) replaced by {@link #init(org.openstreetmap.josm.io.auth.CredentialsAgent)}
+     */
+    @Deprecated
     public void init(Preferences pref, CredentialsAgent cm) {
         CheckParameterUtil.ensureParameterNotNull(pref, "pref");
@@ -169 +196 @@
      * by a credential manager.
      *
-     * @param preferences the preferences. Must not be null.
      * @param cm the credentials manager. Must not be null.
-     * @throws IllegalArgumentException if preferences is null
-     * @throws IllegalArgumentException if cm is null
-     */
-    public void save(Preferences preferences, CredentialsAgent cm) {
-        CheckParameterUtil.ensureParameterNotNull(preferences, "preferences");
-        CheckParameterUtil.ensureParameterNotNull(cm, "cm");
-        preferences.putBoolean("oauth.access-token.save-to-preferences", saveToPreferences);
+     * @throws IllegalArgumentException if cm is null
+     */
+    public void save(CredentialsAgent cm) {
+        CheckParameterUtil.ensureParameterNotNull(cm, "cm");
+        Config.getPref().putBoolean("oauth.access-token.save-to-preferences", saveToPreferences);
         try {
             if (!saveToPreferences) {
@@ -192 +216 @@
 
     /**
+     * Saves the content of this holder to the preferences and a credential store managed
+     * by a credential manager.
+     *
+     * @param preferences the preferences. Must not be null.
+     * @param cm the credentials manager. Must not be null.
+     * @throws IllegalArgumentException if preferences is null
+     * @throws IllegalArgumentException if cm is null
+     * @deprecated (since 12928) replaced by {@link #save(org.openstreetmap.josm.io.auth.CredentialsAgent)}
+     */
+    @Deprecated
+    public void save(Preferences preferences, CredentialsAgent cm) {
+        CheckParameterUtil.ensureParameterNotNull(preferences, "preferences");
+        CheckParameterUtil.ensureParameterNotNull(cm, "cm");
+        preferences.putBoolean("oauth.access-token.save-to-preferences", saveToPreferences);
+        try {
+            if (!saveToPreferences) {
+                cm.storeOAuthAccessToken(null);
+            } else {
+                cm.storeOAuthAccessToken(new OAuthToken(accessTokenKey, accessTokenSecret));
+            }
+        } catch (CredentialsAgentException e) {
+            Logging.error(e);
+            Logging.warn(tr("Failed to store OAuth Access Token to credentials manager"));
+            Logging.warn(tr("Current credential manager is of type ''{0}''", cm.getClass().getName()));
+        }
+    }
+
+    /**
      * Clears the content of this holder
      */

trunk/src/org/openstreetmap/josm/data/oauth/OAuthParameters.java

@@ -7 +7 @@
 import org.openstreetmap.josm.data.Preferences;
 import org.openstreetmap.josm.io.OsmApi;
+import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.Utils;
@@ -79 +80 @@
      * Replies a set of parameters as defined in the preferences.
      *
+     * @param apiUrl the API URL. Must not be null.
+     * @return the parameters
+     */
+    public static OAuthParameters createFromApiUrl(String apiUrl) {
+        OAuthParameters parameters = createDefault(apiUrl);
+        return new OAuthParameters(
+                Config.getPref().get("oauth.settings.consumer-key", parameters.getConsumerKey()),
+                Config.getPref().get("oauth.settings.consumer-secret", parameters.getConsumerSecret()),
+                Config.getPref().get("oauth.settings.request-token-url", parameters.getRequestTokenUrl()),
+                Config.getPref().get("oauth.settings.access-token-url", parameters.getAccessTokenUrl()),
+                Config.getPref().get("oauth.settings.authorise-url", parameters.getAuthoriseUrl()),
+                Config.getPref().get("oauth.settings.osm-login-url", parameters.getOsmLoginUrl()),
+                Config.getPref().get("oauth.settings.osm-logout-url", parameters.getOsmLogoutUrl()));
+    }
+
+    /**
+     * Replies a set of parameters as defined in the preferences.
+     *
      * @param pref the preferences
      * @return the parameters
-     */
+     * @deprecated (since 12928) replaced by {@link #createFromApiUrl(java.lang.String)}
+     */
+    @Deprecated
     public static OAuthParameters createFromPreferences(Preferences pref) {
         OAuthParameters parameters = createDefault(pref.get("osm-server.url"));
@@ -95 +116 @@
 
     /**
+     * Remembers the current values in the preferences.
+     */
+    public void rememberPreferences() {
+        Config.getPref().put("oauth.settings.consumer-key", getConsumerKey());
+        Config.getPref().put("oauth.settings.consumer-secret", getConsumerSecret());
+        Config.getPref().put("oauth.settings.request-token-url", getRequestTokenUrl());
+        Config.getPref().put("oauth.settings.access-token-url", getAccessTokenUrl());
+        Config.getPref().put("oauth.settings.authorise-url", getAuthoriseUrl());
+        Config.getPref().put("oauth.settings.osm-login-url", getOsmLoginUrl());
+        Config.getPref().put("oauth.settings.osm-logout-url", getOsmLogoutUrl());
+    }
+
+    /**
      * Remembers the current values in the preferences <code>pref</code>.
      *
      * @param pref the preferences. Must not be null.
      * @throws IllegalArgumentException if pref is null.
-     */
+     * @deprecated (since 12928) replaced by {@link #rememberPreferences()}
+     */
+    @Deprecated
     public void rememberPreferences(Preferences pref) {
         CheckParameterUtil.ensureParameterNotNull(pref, "pref");
@@ -129 +165 @@
      * @param osmLogoutUrl the OSM logout URL (for automatic mode)
      * @see #createDefault
-     * @see #createFromPreferences
+     * @see #createFromApiUrl
      * @since 9220
      */