chrome/browser/push_messaging/push_messaging_application_id.h


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

// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_APPLICATION_ID_H_
#define CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_APPLICATION_ID_H_

#include <string>
#include <vector>

#include "base/basictypes.h"
#include "url/gurl.h"

class Profile;

namespace user_prefs {
class PrefRegistrySyncable;
}

// The prefix used for all push messaging application ids.
extern const char kPushMessagingApplicationIdPrefix[];

// Type used to identify a web app from a Push API perspective.
// These can be persisted to disk, in a 1:1 mapping between app_id_guid and
// pair<origin, service_worker_registration_id>.
class PushMessagingApplicationId {
 public:
  // Register profile-specific prefs.
  static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);

  // Generates a new application id with random app_id_guid.
  static PushMessagingApplicationId Generate(
      const GURL& origin,
      int64 service_worker_registration_id);

  // Looks up an application id by app_id_guid. Will be invalid if not found.
  static PushMessagingApplicationId Get(Profile* profile,
                                        const std::string& app_id_guid);

  // Looks up an application id by origin & service worker registration id.
  // Will be invalid if not found.
  static PushMessagingApplicationId Get(Profile* profile,
                                        const GURL& origin,
                                        int64 service_worker_registration_id);

  // Returns all the PushMessagingApplicationId currently registered for the
  // given |profile|.
  static std::vector<PushMessagingApplicationId> GetAll(Profile* profile);

  ~PushMessagingApplicationId();

  // Persist this application id to disk.
  void PersistToDisk(Profile* profile) const;

  // Delete this application id from disk.
  void DeleteFromDisk(Profile* profile) const; // TODO: Does const make sense?

  bool IsValid() const;

  const std::string& app_id_guid() const { return app_id_guid_; }
  const GURL& origin() const { return origin_; }
  int64 service_worker_registration_id() const {
    return service_worker_registration_id_;
  }

 private:
  friend class PushMessagingApplicationIdTest;

  // Constructs an invalid app id.
  PushMessagingApplicationId();
  // Constructs a valid app id.
  PushMessagingApplicationId(const std::string& app_id_guid,
                             const GURL& origin,
                             int64 service_worker_registration_id);

  std::string app_id_guid_;
  GURL origin_;
  int64 service_worker_registration_id_;
};

#endif  // CHROME_BROWSER_PUSH_MESSAGING_PUSH_MESSAGING_APPLICATION_ID_H_