summaryrefslogtreecommitdiff
path: root/src/com/google/gct/login/CredentialedUserRoster.java
blob: 21aa574d4e0aab0f697ef43e70d1ec5dbcd8661b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.gct.login;

import com.google.common.collect.Lists;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Tracks which users are logged in, and which of these (if any) is currently designated as the
 * "active user". Maintains a map from email addresses of logged-in users to the corresponding
 * {@link CredentialedUser} objects.
 */
public class CredentialedUserRoster {
  private final LinkedHashMap<String, CredentialedUser> myAllUsers = new LinkedHashMap<String, CredentialedUser>();
  private final Collection<GoogleLoginListener> myListeners = Lists.newLinkedList();
  private CredentialedUser myActiveUser;

  /**
   * Returns a copy of the map of the current logged in users.
   * @return Copy of current logged in users.
   */
  @NotNull
  public LinkedHashMap<String, CredentialedUser> getAllUsers() {
    synchronized (this) {
      LinkedHashMap<String, CredentialedUser> clone = new LinkedHashMap<String, CredentialedUser>();
      clone.putAll(myAllUsers);
      return clone;
    }
  }

  /**
   * Completely overrides current map of logged in users with <code>users</code>.
   * @param users Map of users to set.
   */
  public void setAllUsers(Map<String, CredentialedUser> users) {
    synchronized (this) {
      myAllUsers.clear();
      myAllUsers.putAll(users);
    }
  }

  /**
   * Returns the active user.
   * @return the active user.
   */
  @Nullable
  public CredentialedUser getActiveUser() {
    return myActiveUser;
  }

  /**
   * Sets the active user to <code>userEmail</code> if <code>userEmail</code> is a logged
   * in user.
   * @param userEmail The user to be set as active.
   * @throws IllegalArgumentException if the <code>userEmail</code> does not exist i.e. is
   * not a logged in user.
   */
  public void setActiveUser(@NotNull String userEmail) throws IllegalArgumentException {
    synchronized (this) {
      if (!myAllUsers.containsKey(userEmail)) {
        throw new IllegalArgumentException(userEmail + " is not a logged in user.");
      }

      if (myActiveUser != null) {
        myActiveUser.setActive(false);
      }

      myActiveUser = myAllUsers.get(userEmail);
      myActiveUser.setActive(true);
      GoogleLoginPrefs.saveActiveUser(userEmail);
      notifyLoginStatusChange();
    }
  }

  /**
   * If there is an active user, makes the active use no longer active.
   */
  public void removeActiveUser() {
    synchronized (this) {
      if (myActiveUser != null) {
        myActiveUser.setActive(false);
        myActiveUser = null;
        GoogleLoginPrefs.removeActiveUser();
        notifyLoginStatusChange();
      }
    }
  }

  /**
   * Returns the number of logged in users.
   * @return Number of logged in users.
   */
  public int numberOfUsers() {
    synchronized (this) {
      return myAllUsers.size();
    }
  }

  /**
   * Returns true if there is an active user and false otherwise.
   * @return True if there is an active user and false otherwise.
   */
  public boolean isActiveUserAvailable() {
    return myActiveUser != null;
  }

  /**
   * Adds a user to the list of current users. If the user already exists,
   * the user will be updated.
   * The <code>user</code> becomes the active user.
   * @param user
   * @return
   */
  public void addUser(CredentialedUser user) {
    synchronized (this) {
      myAllUsers.put(user.getEmail(), user);
      setActiveUser(user.getEmail());
    }
  }

  /**
   * Remove <code>userEmail</code> from the list of logged in users if <code>userEmail</code> is
   * a logged in user. If <code>userEmail</code> is the active user, there would no longer be
   * an active user once <code>userEmail</code> is removed. Another user will have to explicitly
   * selected for there to be an active user again.
   * @param userEmail The user to be removed.
   * @return  True if <code>userEmail</code> was successfully removed from the list of
   * logged in users and false if <code>userEmail</code> is not a logged in user.
   */
  public boolean removeUser(String userEmail) {
    synchronized (this) {
      if (!myAllUsers.containsKey(userEmail)) {
        return false;
      }

      if (myActiveUser.getEmail().equals(userEmail)) {
        myActiveUser = null;
        GoogleLoginPrefs.removeActiveUser();
      }

      myAllUsers.remove(userEmail);
      notifyLoginStatusChange();
      return true;
    }
  }

  /**
   * Removes all logged in users. There is no active user after this.
   */
  public void removeAllUsers() {
    synchronized (this) {
      myAllUsers.clear();
      myActiveUser = null;
      GoogleLoginPrefs.removeAllUsers();
      notifyLoginStatusChange();
    }
  }

  /**
   * Register a specified {@link GoogleLoginListener} to be notified of changes to the
   * logged-in state.
   *
   * @param listener the specified {@code GoogleLoginListener}
   */
  void addLoginListener(GoogleLoginListener listener) {
    synchronized(myListeners) {
      myListeners.add(listener);
    }
  }

  private void notifyLoginStatusChange() {
    synchronized(myListeners) {
      for (GoogleLoginListener listener : myListeners) {
        listener.statusChanged();
      }
    }
  }

}