Package org.openstreetmap.josm.data
Class UserIdentityManager
java.lang.Object
org.openstreetmap.josm.data.UserIdentityManager
- All Implemented Interfaces:
PreferenceChangedListener
UserIdentityManager is a global object which keeps track of what JOSM knows about
the identity of the current user.
JOSM can be operated anonymously provided the current user never invokes an operation
on the OSM server which required authentication. In this case JOSM neither knows
the user name of the OSM account of the current user nor its unique id. Perhaps the
user doesn't have one.
If the current user supplies a user name and a password in the JOSM preferences JOSM
can partially identify the user.
The current user is fully identified if JOSM knows both the user name and the unique
id of the users OSM account. The latter is retrieved from the OSM server with a
GET /api/0.6/user/details request, submitted with the user name and password
of the current user.
The global UserIdentityManager listens to PreferenceChangeEvents and keeps track
of what the current JOSM instance knows about the current user. Other subsystems can
let the global UserIdentityManager know in case they fully identify the current user, see
setFullyIdentified(java.lang.String, org.openstreetmap.josm.data.osm.UserInfo).
The information kept by the UserIdentityManager can be used to
- safely query changesets owned by the current user based on its user id, not on its user name
- safely search for objects last touched by the current user based on its user id, not on its user name
- Since:
- 12743 (renamed from
org.openstreetmap.josm.gui.JosmUserIdentityManager), 2689 (creation)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceThis listener is notified whenever the osm user is changed. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate booleanprivate booleanprivate static UserIdentityManagerprivate final ListenerList<UserIdentityManager.UserIdentityListener>private UserInfoprivate String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a listener that listens to changes of the current user.asUser()Returns the identity as aUserobjectprivate voidstatic UserIdentityManagerReplies the unique instance of the JOSM user identity managerintReplies the user id of the current JOSM user.Replies verified additional information about the current user if the user isisFullyIdentified().Replies the user name of the current JOSM user.voidInitializes the user identity manager from OAuth request of user details.voidInitializes the user identity manager from Basic Authentication values in thePreferencesThis method should be called ifosm-server.auth-methodis set tobasic.booleanReplies true if the current JOSM user is anonymous.booleanisCurrentUser(String userName) Replies true if the user with nameusernameis the current userbooleanisCurrentUser(User user) Replies true if the current user isfully identifiedand theuser idsmatch, or if the current user is notfully identifiedand theuser namesmatch.booleanReplies true if the current JOSM user is fully identified.booleanReplies true if the current JOSM user is partially identified.voidTriggered when a preference entry value changes.voidRemembers the fact that the current JOSM user is anonymous.voidsetFullyIdentified(String userName, UserInfo userInfo) Remembers the fact that the current JOSM user is fully identified with a verified pair of user name and user id.voidsetPartiallyIdentified(String userName) Remembers the fact that the current JOSM user is partially identified by the user name of its OSM account.
-
Field Details
-
instance
-
listeners
-
userName
-
userInfo
-
accessTokenKeyChanged
-
accessTokenSecretChanged
-
-
Constructor Details
-
UserIdentityManager
private UserIdentityManager()
-
-
Method Details
-
getInstance
Replies the unique instance of the JOSM user identity manager- Returns:
- the unique instance of the JOSM user identity manager
-
setAnonymous
Remembers the fact that the current JOSM user is anonymous. -
setPartiallyIdentified
Remembers the fact that the current JOSM user is partially identified by the user name of its OSM account.- Parameters:
userName- the user name. Must not be null. Must not be empty (whitespace only).- Throws:
IllegalArgumentException- if userName is nullIllegalArgumentException- if userName is empty
-
setFullyIdentified
Remembers the fact that the current JOSM user is fully identified with a verified pair of user name and user id.- Parameters:
userName- the user name. Must not be null. Must not be empty.userInfo- additional information about the user, retrieved from the OSM server and including the user id- Throws:
IllegalArgumentException- if userName is nullIllegalArgumentException- if userName is emptyIllegalArgumentException- if userInfo is null
-
isAnonymous
Replies true if the current JOSM user is anonymous.- Returns:
trueif the current user is anonymous.
-
isPartiallyIdentified
Replies true if the current JOSM user is partially identified.- Returns:
- true if the current JOSM user is partially identified.
-
isFullyIdentified
Replies true if the current JOSM user is fully identified.- Returns:
- true if the current JOSM user is fully identified.
-
getUserName
Replies the user name of the current JOSM user. null, ifisAnonymous()is true.- Returns:
- the user name of the current JOSM user
-
getUserId
Replies the user id of the current JOSM user. 0, ifisAnonymous()orisPartiallyIdentified()is true.- Returns:
- the user id of the current JOSM user
-
getUserInfo
Replies verified additional information about the current user if the user isisFullyIdentified().- Returns:
- verified additional information about the current user
-
asUser
Returns the identity as aUserobject- Returns:
- the identity as user, or
User.getAnonymous()ifisAnonymous()
-
initFromPreferences
Initializes the user identity manager from Basic Authentication values in thePreferencesThis method should be called ifosm-server.auth-methodis set tobasic.- See Also:
-
initFromOAuth
Initializes the user identity manager from OAuth request of user details. This method should be called ifosm-server.auth-methodis set tooauth.- Since:
- 5434
- See Also:
-
isCurrentUser
Replies true if the user with nameusernameis the current user- Parameters:
userName- the user name- Returns:
- true if the user with name
usernameis the current user
-
isCurrentUser
Replies true if the current user isfully identifiedand theuser idsmatch, or if the current user is notfully identifiedand theuser namesmatch.- Parameters:
user- the user to test- Returns:
- true if given user is the current user
-
preferenceChanged
Description copied from interface:PreferenceChangedListenerTriggered when a preference entry value changes.- Specified by:
preferenceChangedin interfacePreferenceChangedListener- Parameters:
evt- the preference change event
-
addListener
Add a listener that listens to changes of the current user.- Parameters:
listener- The listener
-
fireUserIdentityChanged
-