Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(104)

Side by Side Diff: components/signin/core/account_id/account_id.h

Issue 2529103002: Add account_type into AccountId (Closed)
Patch Set: more tests Created 4 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright 2015 The Chromium Authors. All rights reserved. 1 // Copyright 2015 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_ 5 #ifndef COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_
6 #define COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_ 6 #define COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_
7 7
8 #include <stddef.h> 8 #include <stddef.h>
9 9
10 #include <string> 10 #include <string>
11 #include "base/containers/hash_tables.h" 11 #include "base/containers/hash_tables.h"
12 12
13 enum class AccountType { UNKNOWN, GOOGLE, ACTIVE_DIRECTORY };
14
13 // Type that contains enough information to identify user. 15 // Type that contains enough information to identify user.
14 // 16 //
15 // TODO(alemate): we are in the process of moving away from std::string as a 17 // TODO(alemate): we are in the process of moving away from std::string as a
16 // type for storing user identifier to AccountId. At this time GaiaId is mostly 18 // type for storing user identifier to AccountId. At this time GaiaId is mostly
17 // empty, so this type is used as a replacement for e-mail string. 19 // empty, so this type is used as a replacement for e-mail string.
18 // But in near future AccountId will become full feature user identifier. 20 // But in near future AccountId will become full feature user identifier.
21 // TODO(alemate): Rename functions and fields to reflect different types of
22 // accounts. (see crbug.com/672253)
19 class AccountId { 23 class AccountId {
20 public: 24 public:
21 struct EmptyAccountId; 25 struct EmptyAccountId;
22 26
23 AccountId(const AccountId& other); 27 AccountId(const AccountId& other);
24 28
25 bool operator==(const AccountId& other) const; 29 bool operator==(const AccountId& other) const;
26 bool operator!=(const AccountId& other) const; 30 bool operator!=(const AccountId& other) const;
27 bool operator<(const AccountId& right) const; 31 bool operator<(const AccountId& right) const;
28 32
29 // empty() is deprecated. Use !is_valid() instead. 33 // empty() is deprecated. Use !is_valid() instead.
30 bool empty() const; 34 bool empty() const;
31 bool is_valid() const; 35 bool is_valid() const;
32 void clear(); 36 void clear();
33 37
34 const std::string& GetAccountType() const; 38 AccountType GetAccountType() const;
35 const std::string& GetGaiaId() const; 39 const std::string& GetGaiaId() const;
40 const std::string& GetObjGuid() const;
36 // Users of AccountId should make no assumptions on the format of email. 41 // Users of AccountId should make no assumptions on the format of email.
37 // I.e. it cannot be used as account identifier, because it is (in general) 42 // I.e. it cannot be used as account identifier, because it is (in general)
38 // non-comparable. 43 // non-comparable.
39 const std::string& GetUserEmail() const; 44 const std::string& GetUserEmail() const;
40 45
46 // Returns true if |GetAccountIdKey| would return valid key.
47 bool HasAccountIdKey() const;
41 // This returns prefixed some string that can be used as a storage key. 48 // This returns prefixed some string that can be used as a storage key.
42 // You should make no assumptions on the format of this string. 49 // You should make no assumptions on the format of this string.
43 const std::string GetAccountIdKey() const; 50 const std::string GetAccountIdKey() const;
44 51
45 void SetGaiaId(const std::string& gaia_id);
46 void SetUserEmail(const std::string& email); 52 void SetUserEmail(const std::string& email);
47 53
48 // This method is to be used during transition period only. 54 // This method is to be used during transition period only.
55 // AccountId with UNKNOWN AccountType;
49 static AccountId FromUserEmail(const std::string& user_email); 56 static AccountId FromUserEmail(const std::string& user_email);
57 // AccountId with GOOGLE AccountType;
50 // This method is to be used during transition period only. 58 // This method is to be used during transition period only.
51 static AccountId FromGaiaId(const std::string& gaia_id); 59 static AccountId FromGaiaId(const std::string& gaia_id);
52 // This method is the preferred way to construct AccountId if you have 60 // This method is the preferred way to construct AccountId if you have
53 // full account information. 61 // full account information.
62 // AccountId with GOOGLE AccountType;
54 static AccountId FromUserEmailGaiaId(const std::string& user_email, 63 static AccountId FromUserEmailGaiaId(const std::string& user_email,
55 const std::string& gaia_id); 64 const std::string& gaia_id);
65 // These methods are used to construct Active Directory AccountIds.
66 // AccountId with ACTIVE_DIRECTORY AccountType;
67 static AccountId AdFromUserEmailObjGuid(const std::string& email,
68 const std::string& obj_guid);
69 // AccountId with ACTIVE_DIRECTORY AccountType;
70 static AccountId AdFromObjGuid(const std::string& obj_guid);
71
72 // Translation functions between AccountType and std::string. Used for
73 // serialization.
74 static AccountType StringToAccountType(
75 const std::string& account_type_string);
76 static std::string AccountTypeToString(const AccountType& account_type);
56 77
57 // These are (for now) unstable and cannot be used to store serialized data to 78 // These are (for now) unstable and cannot be used to store serialized data to
58 // persistent storage. Only in-memory storage is safe. 79 // persistent storage. Only in-memory storage is safe.
59 // Serialize() returns JSON dictionary, 80 // Serialize() returns JSON dictionary,
60 // Deserialize() restores AccountId after serialization. 81 // Deserialize() restores AccountId after serialization.
61 std::string Serialize() const; 82 std::string Serialize() const;
62 static bool Deserialize(const std::string& serialized, 83 static bool Deserialize(const std::string& serialized,
63 AccountId* out_account_id); 84 AccountId* out_account_id);
64 85
65 private: 86 private:
66 AccountId(); 87 AccountId();
67 AccountId(const std::string& gaia_id, const std::string& user_email); 88 AccountId(const std::string& id,
89 const std::string& user_email,
90 const AccountType& account_type);
68 91
69 std::string gaia_id_; 92 std::string id_;
70 std::string user_email_; 93 std::string user_email_;
94 AccountType account_type_ = AccountType::UNKNOWN;
71 }; 95 };
72 96
73 // Returns a reference to a singleton. 97 // Returns a reference to a singleton.
74 const AccountId& EmptyAccountId(); 98 const AccountId& EmptyAccountId();
75 99
76 namespace BASE_HASH_NAMESPACE { 100 namespace BASE_HASH_NAMESPACE {
77 101
78 // Implement hashing of AccountId, so it can be used as a key in STL containers. 102 // Implement hashing of AccountId, so it can be used as a key in STL containers.
79 template <> 103 template <>
80 struct hash<AccountId> { 104 struct hash<AccountId> {
81 std::size_t operator()(const AccountId& user_id) const; 105 std::size_t operator()(const AccountId& user_id) const;
82 }; 106 };
83 107
84 } // namespace BASE_HASH_NAMESPACE 108 } // namespace BASE_HASH_NAMESPACE
85 109
86 #endif // COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_ 110 #endif // COMPONENTS_SIGNIN_CORE_ACCOUNT_ID_ACCOUNT_ID_H_
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698