OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 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 CHROMEOS_NETWORK_FAVORITE_STATE_H_ | 5 #ifndef CHROMEOS_NETWORK_FAVORITE_STATE_H_ |
6 #define CHROMEOS_NETWORK_FAVORITE_STATE_H_ | 6 #define CHROMEOS_NETWORK_FAVORITE_STATE_H_ |
7 | 7 |
8 #include <string> | 8 #include <string> |
9 | 9 |
10 #include "base/values.h" | 10 #include "base/values.h" |
11 #include "chromeos/network/managed_state.h" | 11 #include "chromeos/network/managed_state.h" |
12 #include "chromeos/network/network_ui_data.h" | 12 #include "chromeos/network/network_ui_data.h" |
13 #include "components/onc/onc_constants.h" | 13 #include "components/onc/onc_constants.h" |
14 | 14 |
15 namespace chromeos { | 15 namespace chromeos { |
16 | 16 |
17 // A simple class to provide essential information for Services created | 17 // A simple class to provide essential information for Services created |
18 // by Shill corresponding to Profile Entries (i.e. 'preferred' or 'favorite' | 18 // by Shill corresponding to Profile Entries (i.e. 'preferred' or 'favorite' |
19 // networks). | 19 // networks). |
20 // Note: NetworkStateHandler will store an entry for each member of | 20 // Note: NetworkStateHandler will store an entry for each member of |
21 // Manager.ServiceCompleteList, even for visible entries that are not | 21 // Manager.ServiceCompleteList, even for visible entries that are not |
22 // favorites. This is necessary to avoid unnecessarily re-requesting entries, | 22 // saved. This is necessary to avoid unnecessarily re-requesting entries, |
23 // and to limit the code complexity. The IsFavorite() accessor is used to skip | 23 // and to limit the code complexity. It is also convenient for tracking the |
24 // entries that are not actually favorites. | 24 // complete list of "known" networks. The IsInProfile() accessor is used to |
| 25 // skip entries that are not actually saved in a profile. |
25 class CHROMEOS_EXPORT FavoriteState : public ManagedState { | 26 class CHROMEOS_EXPORT FavoriteState : public ManagedState { |
26 public: | 27 public: |
27 explicit FavoriteState(const std::string& path); | 28 explicit FavoriteState(const std::string& path); |
28 virtual ~FavoriteState(); | 29 virtual ~FavoriteState(); |
29 | 30 |
30 // ManagedState overrides | 31 // ManagedState overrides |
31 virtual bool PropertyChanged(const std::string& key, | 32 virtual bool PropertyChanged(const std::string& key, |
32 const base::Value& value) OVERRIDE; | 33 const base::Value& value) OVERRIDE; |
33 virtual void GetStateProperties( | 34 virtual void GetStateProperties( |
34 base::DictionaryValue* dictionary) const OVERRIDE; | 35 base::DictionaryValue* dictionary) const OVERRIDE; |
35 | 36 |
36 // Accessors | 37 // Accessors |
37 const std::string& profile_path() const { return profile_path_; } | 38 const std::string& profile_path() const { return profile_path_; } |
38 const NetworkUIData& ui_data() const { return ui_data_; } | 39 const NetworkUIData& ui_data() const { return ui_data_; } |
39 const base::DictionaryValue& proxy_config() const { return proxy_config_; } | 40 const base::DictionaryValue& proxy_config() const { return proxy_config_; } |
40 const std::string& guid() const { return guid_; } | 41 const std::string& guid() const { return guid_; } |
41 | 42 |
42 // Returns true if this is a favorite stored in a profile (see note above). | 43 // Returns true if this is a favorite stored in a profile (see note above). |
43 bool IsFavorite() const; | 44 bool IsInProfile() const; |
44 | 45 |
45 // Returns true if the network properties are stored in a user profile. | 46 // Returns true if the network properties are stored in a user profile. |
46 bool IsPrivate() const; | 47 bool IsPrivate() const; |
47 | 48 |
| 49 // Returns a specifier for identifying this network in the absence of a GUID. |
| 50 // This should only be used by NetworkStateHandler for keeping track of |
| 51 // GUIDs assigned to unsaved networks. |
| 52 std::string GetSpecifier() const; |
| 53 |
| 54 // Set the GUID. Called exclusively by NetworkStateHandler. |
| 55 void SetGuid(const std::string& guid); |
| 56 |
48 private: | 57 private: |
49 std::string profile_path_; | 58 std::string profile_path_; |
50 NetworkUIData ui_data_; | 59 NetworkUIData ui_data_; |
51 std::string guid_; | 60 std::string guid_; |
52 | 61 |
| 62 // Keep track of Service.Security. Only used for specifying wifi networks. |
| 63 std::string security_; |
| 64 |
53 // TODO(pneubeck): Remove this once (Managed)NetworkConfigurationHandler | 65 // TODO(pneubeck): Remove this once (Managed)NetworkConfigurationHandler |
54 // provides proxy configuration. crbug.com/241775 | 66 // provides proxy configuration. crbug.com/241775 |
55 base::DictionaryValue proxy_config_; | 67 base::DictionaryValue proxy_config_; |
56 | 68 |
57 DISALLOW_COPY_AND_ASSIGN(FavoriteState); | 69 DISALLOW_COPY_AND_ASSIGN(FavoriteState); |
58 }; | 70 }; |
59 | 71 |
60 } // namespace chromeos | 72 } // namespace chromeos |
61 | 73 |
62 #endif // CHROMEOS_NETWORK_FAVORITE_STATE_H_ | 74 #endif // CHROMEOS_NETWORK_FAVORITE_STATE_H_ |
OLD | NEW |