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

Timestamp:

2012-08-11T17:37:00+02:00 (12 years ago)

Author:

Don-vip

Message:

see #7943 - Introduce OsmApi.DEFAULT_API_URL, better handling of change of API URL in OAuth management, javadoc improvements

File:

• trunk/src/org/openstreetmap/josm/data/oauth/OAuthParameters.java (modified) (9 diffs)

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

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.data.oauth;
+
+import java.net.MalformedURLException;
+import java.net.URL;
 
 import oauth.signpost.OAuthConsumer;
@@ -8 +11 @@
 
 import org.openstreetmap.josm.data.Preferences;
+import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 
 /**
  * This class manages a set of OAuth parameters.
- *
+ * @since 2747
  */
 public class OAuthParameters {
 
+    /**
+     * The default JOSM OAuth consumer key.
+     */
     static public final String DEFAULT_JOSM_CONSUMER_KEY = "AdCRxTpvnbmfV8aPqrTLyA";
+    /**
+     * The default JOSM OAuth consumer secret.
+     */
     static public final String DEFAULT_JOSM_CONSUMER_SECRET = "XmYOiGY9hApytcBC3xCec3e28QBqOWz5g6DSb5UpE";
+    /**
+     * The default OSM OAuth request token URL.
+     */
     static public final String DEFAULT_REQUEST_TOKEN_URL = "http://www.openstreetmap.org/oauth/request_token";
+    /**
+     * The default OSM OAuth access token URL.
+     */
     static public final String DEFAULT_ACCESS_TOKEN_URL = "http://www.openstreetmap.org/oauth/access_token";
+    /**
+     * The default OSM OAuth authorize URL.
+     */
     static public final String DEFAULT_AUTHORISE_URL = "http://www.openstreetmap.org/oauth/authorize";
 
@@ -25 +44 @@
     /**
      * Replies a set of default parameters for a consumer accessing the standard OSM server
-     * at http://api.openstreetmap.org/api
+     * at {@link OsmApi#DEFAULT_API_URL}.
      *
      * @return a set of default parameters
      */
     static public OAuthParameters createDefault() {
+        return createDefault(null);
+    }
+
+    /**
+     * Replies a set of default parameters for a consumer accessing an OSM server
+     * at the given API url. URL parameters are only set if the URL equals {@link OsmApi#DEFAULT_API_URL}
+     * or references the domain "dev.openstreetmap.org", otherwise they may be <code>null</code>.
+     * 
+     * @param apiUrl The API URL for which the OAuth default parameters are created. If null or empty, the default OSM API url is used.
+     * @return a set of default parameters for the given {@code apiUrl}
+     * @since 5422
+     */
+    static public OAuthParameters createDefault(String apiUrl) {
         OAuthParameters parameters = new OAuthParameters();
         parameters.setConsumerKey(DEFAULT_JOSM_CONSUMER_KEY);
         parameters.setConsumerSecret(DEFAULT_JOSM_CONSUMER_SECRET);
-        parameters.setRequestTokenUrl(DEFAULT_REQUEST_TOKEN_URL);
-        parameters.setAccessTokenUrl(DEFAULT_ACCESS_TOKEN_URL);
-        parameters.setAuthoriseUrl(DEFAULT_AUTHORISE_URL);
+        if (apiUrl == null || apiUrl.isEmpty() || apiUrl.equals(OsmApi.DEFAULT_API_URL)) {
+            parameters.setRequestTokenUrl(DEFAULT_REQUEST_TOKEN_URL);
+            parameters.setAccessTokenUrl(DEFAULT_ACCESS_TOKEN_URL);
+            parameters.setAuthoriseUrl(DEFAULT_AUTHORISE_URL);
+        } else {
+            try {
+                String host = new URL(apiUrl).getHost();
+                if (host.endsWith("dev.openstreetmap.org")) {
+                    parameters.setRequestTokenUrl(DEFAULT_REQUEST_TOKEN_URL.replace("www.openstreetmap.org", host));
+                    parameters.setAccessTokenUrl(DEFAULT_ACCESS_TOKEN_URL.replace("www.openstreetmap.org", host));
+                    parameters.setAuthoriseUrl(DEFAULT_AUTHORISE_URL.replace("www.openstreetmap.org", host));
+                }
+            } catch (MalformedURLException e) {
+                // Ignored
+            }
+        }
         return parameters;
     }
@@ -48 +93 @@
         boolean useDefault = pref.getBoolean("oauth.settings.use-default", true );
         if (useDefault)
-            return createDefault();
+            return createDefault(pref.get("osm-server.url"));
         OAuthParameters parameters = new OAuthParameters();
         parameters.setConsumerKey(pref.get("oauth.settings.consumer-key", ""));
@@ -78 +123 @@
     private String authoriseUrl;
 
+    /**
+     * Constructs a new, unitialized, {@code OAuthParameters}.
+     * 
+     * @see #createDefault
+     * @see #createFromPreferences
+     */
     public OAuthParameters() {
     }
@@ -96 +147 @@
     }
 
+    /**
+     * Gets the consumer key.
+     * @return The consumer key
+     */
     public String getConsumerKey() {
         return consumerKey;
     }
+    
+    /**
+     * Sets the consumer key.
+     * @param consumerKey The consumer key
+     */
     public void setConsumerKey(String consumerKey) {
         this.consumerKey = consumerKey;
     }
+    
+    /**
+     * Gets the consumer secret. 
+     * @return The consumer secret
+     */
     public String getConsumerSecret() {
         return consumerSecret;
     }
+    
+    /**
+     * Sets the consumer secret.
+     * @param consumerSecret The consumer secret
+     */
     public void setConsumerSecret(String consumerSecret) {
         this.consumerSecret = consumerSecret;
     }
+    
+    /**
+     * Gets the request token URL.
+     * @return The request token URL
+     */
     public String getRequestTokenUrl() {
         return requestTokenUrl;
     }
+    
+    /**
+     * Sets the request token URL.
+     * @param requestTokenUrl the request token URL
+     */
     public void setRequestTokenUrl(String requestTokenUrl) {
         this.requestTokenUrl = requestTokenUrl;
     }
+    
+    /**
+     * Gets the access token URL.
+     * @return The access token URL
+     */
     public String getAccessTokenUrl() {
         return accessTokenUrl;
     }
+    
+    /**
+     * Sets the access token URL.
+     * @param accessTokenUrl The access token URL
+     */
     public void setAccessTokenUrl(String accessTokenUrl) {
         this.accessTokenUrl = accessTokenUrl;
     }
+    
+    /**
+     * Gets the authorise URL.
+     * @return The authorise URL
+     */
     public String getAuthoriseUrl() {
         return authoriseUrl;
     }
+    
+    /**
+     * Sets the authorise URL.
+     * @param authoriseUrl The authorise URL
+     */
     public void setAuthoriseUrl(String authoriseUrl) {
         this.authoriseUrl = authoriseUrl;
@@ -128 +228 @@
 
     /**
-     * Builds an {@link OAuthConsumer} based on these parameters
+     * Builds an {@link OAuthConsumer} based on these parameters.
      *
      * @return the consumer
      */
     public OAuthConsumer buildConsumer() {
-        OAuthConsumer consumer = new DefaultOAuthConsumer(consumerKey, consumerSecret);
-        return consumer;
+        return new DefaultOAuthConsumer(consumerKey, consumerSecret);
     }
 
@@ -142 +241 @@
      * @param consumer the consumer. Must not be null.
      * @return the provider
-     * @throws IllegalArgumentException thrown if consumer is null
+     * @throws IllegalArgumentException if consumer is null
      */
     public OAuthProvider buildProvider(OAuthConsumer consumer) throws IllegalArgumentException {
@@ -153 +252 @@
     }
 
+    /**
+     * Saves these OAuth parameters to the given {@code Preferences}.
+     * @param pref The Preferences into which are saved these OAuth parameters with the prefix "oauth.settings"
+     */
     public void saveToPreferences(Preferences pref) {
-        if (this.equals(createDefault())) {
+        if (this.equals(createDefault(pref.get("osm-server.url")))) {
             pref.put("oauth.settings.use-default", true );
             clearPreferences(pref);