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
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_POLICY_CORE_COMMON_SCHEMA_REGISTRY_H_
#define COMPONENTS_POLICY_CORE_COMMON_SCHEMA_REGISTRY_H_
#include <array>
#include <set>
#include "base/compiler_specific.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/ref_counted.h"
#include "base/observer_list.h"
#include "base/sequence_checker.h"
#include "components/policy/core/common/policy_namespace.h"
#include "components/policy/core/common/schema.h"
#include "components/policy/core/common/schema_map.h"
#include "components/policy/policy_export.h"
namespace policy {
class SchemaMap;
// Holds the main reference to the current SchemaMap, and allows a list of
// observers to get notified whenever it is updated.
// This object is not thread safe and must be used from the owner's thread,
// usually UI.
class POLICY_EXPORT SchemaRegistry {
public:
class POLICY_EXPORT Observer {
public:
// Invoked whenever schemas are registered or unregistered.
// |has_new_schemas| is true if a new component has been registered since
// the last update; this allows observers to ignore updates when
// components are unregistered but still get a handle to the current map
// (e.g. for periodic reloads).
virtual void OnSchemaRegistryUpdated(bool has_new_schemas) = 0;
// Invoked when all policy domains become ready.
virtual void OnSchemaRegistryReady() {}
protected:
virtual ~Observer();
};
// This observer is only meant to be used by subclasses.
class POLICY_EXPORT InternalObserver {
public:
// Invoked when |registry| is about to be destroyed.
virtual void OnSchemaRegistryShuttingDown(SchemaRegistry* registry) = 0;
protected:
virtual ~InternalObserver();
};
SchemaRegistry();
SchemaRegistry(const SchemaRegistry&) = delete;
SchemaRegistry& operator=(const SchemaRegistry&) = delete;
virtual ~SchemaRegistry();
const scoped_refptr<SchemaMap>& schema_map() const { return schema_map_; }
// Register a single component.
void RegisterComponent(const PolicyNamespace& ns,
const Schema& schema);
// Register a list of components for a given domain.
virtual void RegisterComponents(PolicyDomain domain,
const ComponentMap& components);
virtual void UnregisterComponent(const PolicyNamespace& ns);
// Returns true if all domains have registered the initial components.
bool IsReady() const;
// This indicates that the initial components for |domain| have all been
// registered. It must be invoked at least once for each policy domain;
// subsequent calls for the same domain are ignored.
void SetDomainReady(PolicyDomain domain);
// This is equivalent to calling |SetDomainReady| with each of the policy
// domains.
void SetAllDomainsReady();
// This is equivalent to calling |SetDomainReady| with each of the domains
// that correspond to policy for extensions.
void SetExtensionsDomainsReady();
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
void AddInternalObserver(InternalObserver* observer);
void RemoveInternalObserver(InternalObserver* observer);
protected:
void Notify(bool has_new_schemas);
SEQUENCE_CHECKER(sequence_checker_);
scoped_refptr<SchemaMap> schema_map_;
private:
base::ObserverList<Observer, true>::Unchecked observers_;
base::ObserverList<InternalObserver, true>::Unchecked internal_observers_;
std::array<bool, POLICY_DOMAIN_SIZE> domains_ready_;
};
// A registry that combines the maps of other registries.
class POLICY_EXPORT CombinedSchemaRegistry
: public SchemaRegistry,
public SchemaRegistry::Observer,
public SchemaRegistry::InternalObserver {
public:
CombinedSchemaRegistry();
CombinedSchemaRegistry(const CombinedSchemaRegistry&) = delete;
CombinedSchemaRegistry& operator=(const CombinedSchemaRegistry&) = delete;
~CombinedSchemaRegistry() override;
void Track(SchemaRegistry* registry);
// SchemaRegistry:
void RegisterComponents(PolicyDomain domain,
const ComponentMap& components) override;
void UnregisterComponent(const PolicyNamespace& ns) override;
// SchemaRegistry::Observer:
void OnSchemaRegistryUpdated(bool has_new_schemas) override;
// SchemaRegistry::InternalObserver:
void OnSchemaRegistryShuttingDown(SchemaRegistry* registry) override;
private:
void Combine(bool has_new_schemas);
std::set<raw_ptr<SchemaRegistry, SetExperimental>> registries_;
scoped_refptr<SchemaMap> own_schema_map_;
};
// A registry that wraps another schema registry.
class POLICY_EXPORT ForwardingSchemaRegistry
: public SchemaRegistry,
public SchemaRegistry::Observer,
public SchemaRegistry::InternalObserver {
public:
// This registry will stop updating its SchemaMap when |wrapped| is
// destroyed.
explicit ForwardingSchemaRegistry(SchemaRegistry* wrapped);
ForwardingSchemaRegistry(const ForwardingSchemaRegistry&) = delete;
ForwardingSchemaRegistry& operator=(const ForwardingSchemaRegistry&) = delete;
~ForwardingSchemaRegistry() override;
// SchemaRegistry:
void RegisterComponents(PolicyDomain domain,
const ComponentMap& components) override;
void UnregisterComponent(const PolicyNamespace& ns) override;
// SchemaRegistry::Observer:
void OnSchemaRegistryUpdated(bool has_new_schemas) override;
void OnSchemaRegistryReady() override;
// SchemaRegistry::InternalObserver:
void OnSchemaRegistryShuttingDown(SchemaRegistry* registry) override;
private:
void UpdateReadiness();
raw_ptr<SchemaRegistry> wrapped_;
};
} // namespace policy
#endif // COMPONENTS_POLICY_CORE_COMMON_SCHEMA_REGISTRY_H_
|