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
|
// Copyright 2015 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 COMPONENTS_GCM_DRIVER_INSTANCE_ID_INSTANCE_ID_H_
#define COMPONENTS_GCM_DRIVER_INSTANCE_ID_INSTANCE_ID_H_
#include <map>
#include <string>
#include "base/callback.h"
#include "base/macros.h"
#include "base/time/time.h"
namespace gcm {
class GCMDriver;
} // namespace gcm
namespace instance_id {
// Encapsulates Instance ID functionalities that need to be implemented for
// different platform. One instance is created per application. Life of
// Instance ID is managed by the InstanceIdDriver.
class InstanceID {
public:
enum Result {
// Successful operation.
SUCCESS,
// Invalid parameter.
INVALID_PARAMETER,
// Instance ID is disabled.
DISABLED,
// Previous asynchronous operation is still pending to finish.
ASYNC_OPERATION_PENDING,
// Network socket error.
NETWORK_ERROR,
// Problem at the server.
SERVER_ERROR,
// Other errors.
UNKNOWN_ERROR
};
// Asynchronous callbacks.
typedef base::Callback<void(const std::string& app_id,
bool update_id)> TokenRefreshCallback;
typedef base::Callback<void(const std::string& id)> GetIDCallback;
typedef base::Callback<void(const base::Time& creation_time)>
GetCreationTimeCallback;
typedef base::Callback<void(const std::string& token,
Result result)> GetTokenCallback;
typedef base::Callback<void(Result result)> DeleteTokenCallback;
typedef base::Callback<void(Result result)> DeleteIDCallback;
static const int kInstanceIDByteLength = 8;
// Creator.
// |app_id|: identifies the application that uses the Instance ID.
// |gcm_driver|: driver to access the GCM functionalities needed to support
// Instance ID.
static InstanceID* Create(const std::string& app_id,
gcm::GCMDriver* gcm_driver);
virtual ~InstanceID();
// Sets the callback that will be invoked when the token refresh event needs
// to be triggered.
void SetTokenRefreshCallback(const TokenRefreshCallback& callback);
// Returns the Instance ID.
virtual void GetID(const GetIDCallback& callback) = 0;
// Returns the time when the InstanceID has been generated.
virtual void GetCreationTime(const GetCreationTimeCallback& callback) = 0;
// Retrieves a token that allows the authorized entity to access the service
// defined as "scope".
// |authorized_entity|: identifies the entity that is authorized to access
// resources associated with this Instance ID. It can be
// another Instance ID or a project ID.
// |scope|: identifies authorized actions that the authorized entity can take.
// E.g. for sending GCM messages, "GCM" scope should be used.
// |options|: allows including a small number of string key/value pairs that
// will be associated with the token and may be used in processing
// the request.
// |callback|: to be called once the asynchronous operation is done.
virtual void GetToken(const std::string& authorized_entity,
const std::string& scope,
const std::map<std::string, std::string>& options,
const GetTokenCallback& callback) = 0;
// Revokes a granted token.
// |authorized_entity|: the authorized entity that is passed for obtaining a
// token.
// |scope|: the scope that is passed for obtaining a token.
// |callback|: to be called once the asynchronous operation is done.
virtual void DeleteToken(const std::string& authorized_entity,
const std::string& scope,
const DeleteTokenCallback& callback) = 0;
// Resets the app instance identifier and revokes all tokens associated with
// it.
// |callback|: to be called once the asynchronous operation is done.
virtual void DeleteID(const DeleteIDCallback& callback) = 0;
std::string app_id() const { return app_id_; }
protected:
explicit InstanceID(const std::string& app_id);
void NotifyTokenRefresh(bool update_id);
private:
std::string app_id_;
TokenRefreshCallback token_refresh_callback_;
DISALLOW_COPY_AND_ASSIGN(InstanceID);
};
} // namespace instance_id
#endif // COMPONENTS_GCM_DRIVER_INSTANCE_ID_INSTANCE_ID_H_
|
