chrome/browser/extensions/api/storage/policy_value_store.h

   1 // Copyright (c) 2012 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 CHROME_BROWSER_EXTENSIONS_API_STORAGE_POLICY_VALUE_STORE_H_
   6 #define CHROME_BROWSER_EXTENSIONS_API_STORAGE_POLICY_VALUE_STORE_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/compiler_specific.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "extensions/browser/api/storage/settings_observer.h"
  15 #include "extensions/browser/value_store/value_store.h"
  16
  17 namespace policy {
  18 class PolicyMap;
  19 }
  20
  21 namespace extensions {
  22
  23 // A ValueStore that is backed by another, persistent ValueStore, and stores
  24 // the policies for a specific extension there. This ValueStore is used to
  25 // run the function of the storage.managed namespace; it's read-only for the
  26 // extension. The ManagedValueStoreCache sends updated policy to this store
  27 // and manages its lifetime.
  28 class PolicyValueStore : public ValueStore {
  29  public:
  30   PolicyValueStore(const std::string& extension_id,
  31                    const scoped_refptr<SettingsObserverList>& observers,
  32                    scoped_ptr<ValueStore> delegate);
  33   virtual ~PolicyValueStore();
  34
  35   // Stores |policy| in the persistent database represented by the |delegate_|
  36   // and notifies observers with the changes from the previous policy.
  37   void SetCurrentPolicy(const policy::PolicyMap& policy);
  38
  39   // Clears all the stored data and deletes the database.
  40   void DeleteStorage();
  41
  42   // ValueStore implementation:
  43   virtual size_t GetBytesInUse(const std::string& key) OVERRIDE;
  44   virtual size_t GetBytesInUse(const std::vector<std::string>& keys) OVERRIDE;
  45   virtual size_t GetBytesInUse() OVERRIDE;
  46   virtual ReadResult Get(const std::string& key) OVERRIDE;
  47   virtual ReadResult Get(const std::vector<std::string>& keys) OVERRIDE;
  48   virtual ReadResult Get() OVERRIDE;
  49   virtual WriteResult Set(
  50       WriteOptions options,
  51       const std::string& key,
  52       const base::Value& value) OVERRIDE;
  53   virtual WriteResult Set(
  54       WriteOptions options, const base::DictionaryValue& values) OVERRIDE;
  55   virtual WriteResult Remove(const std::string& key) OVERRIDE;
  56   virtual WriteResult Remove(const std::vector<std::string>& keys) OVERRIDE;
  57   virtual WriteResult Clear() OVERRIDE;
  58   // Hopefully, as a Read-Only database, there is no reason to use these.
  59   virtual bool Restore() OVERRIDE;
  60   virtual bool RestoreKey(const std::string& key) OVERRIDE;
  61
  62   // For unit tests.
  63   ValueStore* delegate() { return delegate_.get(); }
  64
  65  private:
  66   std::string extension_id_;
  67   scoped_refptr<SettingsObserverList> observers_;
  68   scoped_ptr<ValueStore> delegate_;
  69
  70   DISALLOW_COPY_AND_ASSIGN(PolicyValueStore);
  71 };
  72
  73 }  // namespace extensions
  74
  75 #endif  // CHROME_BROWSER_EXTENSIONS_API_STORAGE_POLICY_VALUE_STORE_H_