public class OAuthParameters extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
accessTokenUrl |
private java.lang.String |
authoriseUrl |
private java.lang.String |
consumerKey |
private java.lang.String |
consumerSecret |
static java.lang.String |
DEFAULT_JOSM_CONSUMER_KEY
The default JOSM OAuth consumer key (created by user josmeditor).
|
static java.lang.String |
DEFAULT_JOSM_CONSUMER_SECRET
The default JOSM OAuth consumer secret (created by user josmeditor).
|
private java.lang.String |
osmLoginUrl |
private java.lang.String |
osmLogoutUrl |
private java.lang.String |
requestTokenUrl |
Constructor and Description |
---|
OAuthParameters(OAuthParameters other)
Creates a clone of the parameters in
other . |
OAuthParameters(java.lang.String consumerKey,
java.lang.String consumerSecret,
java.lang.String requestTokenUrl,
java.lang.String accessTokenUrl,
java.lang.String authoriseUrl,
java.lang.String osmLoginUrl,
java.lang.String osmLogoutUrl)
Constructs a new
OAuthParameters . |
Modifier and Type | Method and Description |
---|---|
OAuthConsumer |
buildConsumer()
Builds an
OAuthConsumer based on these parameters. |
OAuthProvider |
buildProvider(OAuthConsumer consumer)
Builds an
OAuthProvider based on these parameters and a OAuth consumer consumer . |
static OAuthParameters |
createDefault()
Replies a set of default parameters for a consumer accessing the standard OSM server
at
OsmApi.DEFAULT_API_URL . |
static OAuthParameters |
createDefault(java.lang.String apiUrl)
Replies a set of default parameters for a consumer accessing an OSM server
at the given API url.
|
static OAuthParameters |
createFromPreferences(Preferences pref)
Replies a set of parameters as defined in the preferences.
|
boolean |
equals(java.lang.Object o) |
java.lang.String |
getAccessTokenUrl()
Gets the access token URL.
|
java.lang.String |
getAuthoriseUrl()
Gets the authorise URL.
|
java.lang.String |
getConsumerKey()
Gets the consumer key.
|
java.lang.String |
getConsumerSecret()
Gets the consumer secret.
|
java.lang.String |
getOsmLoginUrl()
Gets the URL used to login users on the website (for automatic mode).
|
java.lang.String |
getOsmLogoutUrl()
Gets the URL used to logout users on the website (for automatic mode).
|
java.lang.String |
getRequestTokenUrl()
Gets the request token URL.
|
int |
hashCode() |
void |
rememberPreferences(Preferences pref)
Remembers the current values in the preferences
pref . |
public static final java.lang.String DEFAULT_JOSM_CONSUMER_KEY
public static final java.lang.String DEFAULT_JOSM_CONSUMER_SECRET
private final java.lang.String consumerKey
private final java.lang.String consumerSecret
private final java.lang.String requestTokenUrl
private final java.lang.String accessTokenUrl
private final java.lang.String authoriseUrl
private final java.lang.String osmLoginUrl
private final java.lang.String osmLogoutUrl
public OAuthParameters(java.lang.String consumerKey, java.lang.String consumerSecret, java.lang.String requestTokenUrl, java.lang.String accessTokenUrl, java.lang.String authoriseUrl, java.lang.String osmLoginUrl, java.lang.String osmLogoutUrl)
OAuthParameters
.consumerKey
- consumer keyconsumerSecret
- consumer secretrequestTokenUrl
- request token URLaccessTokenUrl
- access token URLauthoriseUrl
- authorise URLosmLoginUrl
- the OSM login URL (for automatic mode)osmLogoutUrl
- the OSM logout URL (for automatic mode)createDefault()
,
createFromPreferences(org.openstreetmap.josm.data.Preferences)
public OAuthParameters(OAuthParameters other)
other
.other
- the other parameters. Must not be null.java.lang.IllegalArgumentException
- if other is nullpublic static OAuthParameters createDefault()
OsmApi.DEFAULT_API_URL
.public static OAuthParameters createDefault(java.lang.String apiUrl)
OsmApi.DEFAULT_API_URL
or references the domain "dev.openstreetmap.org", otherwise they may be null
.apiUrl
- The API URL for which the OAuth default parameters are created. If null or empty, the default OSM API url is used.apiUrl
public static OAuthParameters createFromPreferences(Preferences pref)
pref
- the preferencespublic void rememberPreferences(Preferences pref)
pref
.pref
- the preferences. Must not be null.java.lang.IllegalArgumentException
- if pref is null.public java.lang.String getConsumerKey()
public java.lang.String getConsumerSecret()
public java.lang.String getRequestTokenUrl()
public java.lang.String getAccessTokenUrl()
public java.lang.String getAuthoriseUrl()
public java.lang.String getOsmLoginUrl()
public java.lang.String getOsmLogoutUrl()
public OAuthConsumer buildConsumer()
OAuthConsumer
based on these parameters.public OAuthProvider buildProvider(OAuthConsumer consumer)
OAuthProvider
based on these parameters and a OAuth consumer consumer
.consumer
- the consumer. Must not be null.java.lang.IllegalArgumentException
- if consumer is nullpublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object