Package org.openstreetmap.josm.data.oauth

Class OAuthAccessTokenHolder

java.lang.Object

org.openstreetmap.josm.data.oauth.OAuthAccessTokenHolder

public class OAuthAccessTokenHolder
extends java.lang.Object

Class holding OAuth access token key and secret.

Since:

12686 (moved from gui.preferences.server package)

Field Summary

Fields

Modifier and Type	Field	Description
private static OAuthAccessTokenHolder	instance
private boolean	saveToPreferences
private java.util.Map<java.lang.String,java.util.Map<OAuthVersion,IOAuthToken>>	tokenMap

Constructor Summary

Constructors

Constructor	Description
OAuthAccessTokenHolder()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the content of this holder
IOAuthToken	getAccessToken(java.lang.String api, OAuthVersion version)	Replies the access token.
static OAuthAccessTokenHolder	getInstance()	Replies the unique instance.
void	init(CredentialsAgent cm)	Initializes the content of this holder from the Access Token managed by the credential manager.
boolean	isSaveToPreferences()	Replies true if current access token should be saved to the preferences file.
void	save(CredentialsAgent cm)	Saves the content of this holder to the preferences and a credential store managed by a credential manager.
void	setAccessToken(java.lang.String api, IOAuthToken token)	Sets the access token hold by this holder.
void	setSaveToPreferences(boolean saveToPreferences)	Sets whether the current access token should be saved to the preferences file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instance

private static OAuthAccessTokenHolder instance

saveToPreferences

private boolean saveToPreferences

tokenMap

private final java.util.Map<java.lang.String,java.util.Map<OAuthVersion,IOAuthToken>> tokenMap

Constructor Detail

OAuthAccessTokenHolder

public OAuthAccessTokenHolder()

Method Detail

getInstance

public static OAuthAccessTokenHolder getInstance()

Replies the unique instance.

Returns:

The unique instance of OAuthAccessTokenHolder

isSaveToPreferences

public boolean isSaveToPreferences()

Replies true if current access token should be saved to the preferences file.

Returns:

true if current access token should be saved to the preferences file.

setSaveToPreferences

public void setSaveToPreferences(boolean saveToPreferences)

Sets whether the current access token should be saved to the preferences file.

If true, the access token is saved in clear text to the preferences file. The same access token can therefore be used in multiple JOSM sessions.

If false, the access token isn't saved to the preferences file. If JOSM is closed, the access token is lost and new token has to be generated by the OSM server the next time JOSM is used.

Parameters:

saveToPreferences - true to save to preferences file

getAccessToken

public IOAuthToken getAccessToken(java.lang.String api,
                                  OAuthVersion version)

Replies the access token.

Parameters:

api - The api the token is for

version - The OAuth version the token is for

Returns:

the access token, can be null

Since:

18650

setAccessToken

public void setAccessToken(java.lang.String api,
                           IOAuthToken token)

Sets the access token hold by this holder.

Parameters:

api - The api the token is for

token - the access token. Can be null to clear the content in this holder.

Since:

18650

init

public void init(CredentialsAgent cm)

Initializes the content of this holder from the Access Token managed by the credential manager.

Parameters:

cm - the credential manager. Must not be null.

Throws:

java.lang.IllegalArgumentException - if cm is null

save

public void save(CredentialsAgent cm)

Saves the content of this holder to the preferences and a credential store managed by a credential manager.

Parameters:

cm - the credentials manager. Must not be null.

Throws:

java.lang.IllegalArgumentException - if cm is null

clear

public void clear()

Clears the content of this holder