Class OAuthAccessTokenHolder


  • public class OAuthAccessTokenHolder
    extends Object
    Class holding OAuth access token key and secret.
    Since:
    12686 (moved from gui.preferences.server package)
    • Method Detail

      • 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
      • getAccessTokenKey

        public String getAccessTokenKey()
        Replies the access token key. null, if no access token key is currently set.
        Returns:
        the access token key
      • setAccessTokenKey

        public void setAccessTokenKey​(String accessTokenKey)
        Sets the access token key. Pass in null to remove the current access token key.
        Parameters:
        accessTokenKey - the access token key
      • getAccessTokenSecret

        public String getAccessTokenSecret()
        Replies the access token secret. null, if no access token secret is currently set.
        Returns:
        the access token secret
      • setAccessTokenSecret

        public void setAccessTokenSecret​(String accessTokenSecret)
        Sets the access token secret. Pass in null to remove the current access token secret.
        Parameters:
        accessTokenSecret - access token secret, or null
      • setAccessToken

        public void setAccessToken​(String accessTokenKey,
                                   String accessTokenSecret)
        Sets the access token hold by this holder.
        Parameters:
        accessTokenKey - the access token key
        accessTokenSecret - the access token secret
      • setAccessToken

        public void setAccessToken​(OAuthToken token)
        Sets the access token hold by this holder.
        Parameters:
        token - the access token. Can be null to clear the content in this holder.
      • containsAccessToken

        public boolean containsAccessToken()
        Replies true if this holder contains an complete access token, consisting of an Access Token Key and an Access Token Secret.
        Returns:
        true if this holder contains an complete access token
      • 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:
        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:
        IllegalArgumentException - if cm is null
      • clear

        public void clear()
        Clears the content of this holder