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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.libraries.entitlement;
import android.os.Build;
import android.os.Build.VERSION;
import com.google.auto.value.AutoValue;
/**
* Service entitlement HTTP request parameters, as defiend in GSMA spec TS.43 section 2.2.
*/
@AutoValue
public abstract class ServiceEntitlementRequest {
/**
* Disables notification token.
*/
public static final int NOTICATION_ACTION_DISABLE = 0;
/**
* Enables FCM notification token.
*/
public static final int NOTICATION_ACTION_ENABLE_FCM = 2;
/**
* Returns the version of configuration currently stored on the client. Used by HTTP parameter
* "vers".
*/
public abstract int configurationVersion();
/**
* Returns the version of the entitlement specification. Used by HTTP parameter
* "entitlement_version".
*/
public abstract String entitlementVersion();
/**
* Returns the authentication token. Used by HTTP parameter "token".
*/
public abstract String authenticationToken();
/**
* Returns the unique identifier of the device like IMEI. Used by HTTP parameter "terminal_id".
*/
public abstract String terminalId();
/**
* Returns the OEM of the device. Used by HTTP parameter "terminal_vendor".
*/
public abstract String terminalVendor();
/**
* Returns the model of the device. Used by HTTP parameter "terminal_model".
*/
public abstract String terminalModel();
/**
* Returns the software version of the device. Used by HTTP parameter "terminal_sw_version".
*/
public abstract String terminalSoftwareVersion();
/**
* Returns the name of the device application making the request. Used by HTTP parameter
* "app_name".
*/
public abstract String appName();
/**
* Returns the version of the device application making the request. Used by HTTP parameter
* "app_version".
*/
public abstract String appVersion();
/**
* Returns the FCM registration token used to register for entitlement configuration request
* from network. Used by HTTP parameter "notif_token".
*/
public abstract String notificationToken();
/**
* Returns the action associated with the FCM registration token. Used by HTTP parameter
* "notif_action".
*
* @see #NOTICATION_ACTION_ENABLE_FCM
* @see #NOTICATION_ACTION_DISABLE
*/
public abstract int notificationAction();
/**
* Returns a new {@link Builder} object.
*/
public static Builder builder() {
return new AutoValue_ServiceEntitlementRequest.Builder()
.setConfigurationVersion(0)
.setEntitlementVersion("2.0")
.setAuthenticationToken("")
.setTerminalId("")
.setTerminalVendor(Build.MANUFACTURER)
.setTerminalModel(Build.MODEL)
.setTerminalSoftwareVersion(VERSION.BASE_OS)
.setAppName("")
.setAppVersion("")
.setNotificationToken("")
.setNotificationAction(NOTICATION_ACTION_ENABLE_FCM);
}
/**
* Builder.
*/
@AutoValue.Builder
public abstract static class Builder {
/**
* Sets the version of configuration currently stored on the client. Used by HTTP parameter
* "vers".
*
* <p>If not set, default to 0 indicating no existing configuration.
*/
public abstract Builder setConfigurationVersion(int value);
/**
* Sets the current version of the entitlement specification. Used by HTTP parameter
* "entitlement_version".
*
* <p>If not set, default to "2.0" base on TS.43-v5.0.
*/
public abstract Builder setEntitlementVersion(String value);
/**
* Sets the authentication token. Used by HTTP parameter "token".
*
* <p>If not set, will trigger embedded EAP-AKA authentication as decribed in TS.43 section
* 2.6.1.
*/
public abstract Builder setAuthenticationToken(String value);
/**
* Sets the unique identifier of the device like IMEI. Used by HTTP parameter
* "terminal_id".
*
* <p>If not set, will use the device IMEI.
*/
public abstract Builder setTerminalId(String value);
/**
* Sets the OEM of the device. Used by HTTP parameter "terminal_vendor".
*
* <p>If not set, will use {@link android.os.Build#MANUFACTURER}.
*/
public abstract Builder setTerminalVendor(String value);
/**
* Sets the model of the device. Used by HTTP parameter "terminal_model".
*
* <p>If not set, will use {@link android.os.Build#MODEL}.
*/
public abstract Builder setTerminalModel(String value);
/**
* Sets the software version of the device. Used by HTTP parameter "terminal_sw_version".
*
* <p>If not set, will use {@link android.os.Build.VERSION#BASE_OS}.
*/
public abstract Builder setTerminalSoftwareVersion(String value);
/**
* Sets the name of the device application making the request. Used by HTTP parameter
* "app_name".
*
* <p>Optional.
*/
public abstract Builder setAppName(String value);
/**
* Sets the version of the device application making the request. Used by HTTP parameter
* "app_version".
*
* <p>Optional.
*/
public abstract Builder setAppVersion(String value);
/**
* Sets the FCM registration token used to register for entitlement configuration request
* from network. Used by HTTP parameter "notif_token".
*
* <p>Optional.
*/
public abstract Builder setNotificationToken(String value);
/**
* Sets the action associated with the FCM registration token. Used by HTTP parameter
* "notif_action".
*
* <p>Required if a token is set with {@link #setNotificationToken}, and default to {@link
* #NOTICATION_ACTION_ENABLE_FCM}; otherwise ignored.
*
* @see #NOTICATION_ACTION_ENABLE_FCM
* @see #NOTICATION_ACTION_DISABLE
*/
public abstract Builder setNotificationAction(int value);
public abstract ServiceEntitlementRequest build();
}
}
|
