src/chromeos/network/favorite_state.h

   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
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROMEOS_NETWORK_FAVORITE_STATE_H_
   6 #define CHROMEOS_NETWORK_FAVORITE_STATE_H_
   7
   8 #include <string>
   9
  10 #include "base/values.h"
  11 #include "chromeos/network/managed_state.h"
  12 #include "chromeos/network/network_ui_data.h"
  13 #include "components/onc/onc_constants.h"
  14
  15 namespace chromeos {
  16
  17 // A simple class to provide essential information for Services created
  18 // by Shill corresponding to Profile Entries (i.e. 'preferred' or 'favorite'
  19 // networks).
  20 // Note: NetworkStateHandler will store an entry for each member of
  21 // Manager.ServiceCompleteList, even for visible entries that are not
  22 // favorites. This is necessary to avoid unnecessarily re-requesting entries,
  23 // and to limit the code complexity. The IsFavorite() accessor is used to skip
  24 // entries that are not actually favorites.
  25 class CHROMEOS_EXPORT FavoriteState : public ManagedState {
  26  public:
  27   explicit FavoriteState(const std::string& path);
  28   virtual ~FavoriteState();
  29
  30   // ManagedState overrides
  31   virtual bool PropertyChanged(const std::string& key,
  32                                const base::Value& value) OVERRIDE;
  33   virtual void GetStateProperties(
  34       base::DictionaryValue* dictionary) const OVERRIDE;
  35
  36   // Accessors
  37   const std::string& profile_path() const { return profile_path_; }
  38   const NetworkUIData& ui_data() const { return ui_data_; }
  39   const base::DictionaryValue& proxy_config() const { return proxy_config_; }
  40   const std::string& guid() const { return guid_; }
  41
  42   // Returns true if this is a favorite stored in a profile (see note above).
  43   bool IsFavorite() const;
  44
  45   // Returns true if the network properties are stored in a user profile.
  46   bool IsPrivate() const;
  47
  48  private:
  49   std::string profile_path_;
  50   NetworkUIData ui_data_;
  51   std::string guid_;
  52
  53   // TODO(pneubeck): Remove this once (Managed)NetworkConfigurationHandler
  54   // provides proxy configuration. crbug.com/241775
  55   base::DictionaryValue proxy_config_;
  56
  57   DISALLOW_COPY_AND_ASSIGN(FavoriteState);
  58 };
  59
  60 }  // namespace chromeos
  61
  62 #endif  // CHROMEOS_NETWORK_FAVORITE_STATE_H_