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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
/*
* 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.android.libraries.entitlement.utils.Ts43Constants;
import com.google.auto.value.AutoValue;
/**
* Service entitlement HTTP request parameters, as defined in GSMA spec TS.43 section 2.2.
*/
@AutoValue
public abstract class ServiceEntitlementRequest {
/** Accepts the content type in XML format. */
public static final String ACCEPT_CONTENT_TYPE_XML = "text/vnd.wap.connectivity-xml";
/** Accepts the content type in JSON format. */
public static final String ACCEPT_CONTENT_TYPE_JSON =
"application/vnd.gsma.eap-relay.v1.0+json";
/** Accepts the content type in JSON or XML format. */
public static final String ACCEPT_CONTENT_TYPE_JSON_AND_XML =
"application/vnd.gsma.eap-relay.v1.0+json, text/vnd.wap.connectivity-xml";
/** Default value of configuration version. */
public static final int DEFAULT_CONFIGURATION_VERSION = 0;
/**
* 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 temporary token. Used by HTTP parameter "temporary_token".
*/
public abstract String temporaryToken();
/**
* 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".
*/
@Ts43Constants.NotificationAction
public abstract int notificationAction();
/**
* Returns the accepted content type of http response.
*
* @see #ACCEPT_CONTENT_TYPE_XML
* @see #ACCEPT_CONTENT_TYPE_JSON
* @see #ACCEPT_CONTENT_TYPE_JSON_AND_XML
*/
public abstract String acceptContentType();
/**
* Returns the boost type for premium network. Used for premium network slice entitlement.
*/
public abstract String boostType();
/**
* Returns a new {@link Builder} object.
*/
public static Builder builder() {
return new AutoValue_ServiceEntitlementRequest.Builder()
.setConfigurationVersion(DEFAULT_CONFIGURATION_VERSION)
.setEntitlementVersion(Ts43Constants.DEFAULT_ENTITLEMENT_VERSION)
.setAuthenticationToken("")
.setTemporaryToken("")
.setTerminalId("")
.setTerminalVendor(Build.MANUFACTURER)
.setTerminalModel(Build.MODEL)
.setTerminalSoftwareVersion(VERSION.RELEASE)
.setAppName("")
.setAppVersion("")
.setNotificationToken("")
.setNotificationAction(Ts43Constants.NOTIFICATION_ACTION_ENABLE_FCM)
.setAcceptContentType(ACCEPT_CONTENT_TYPE_JSON_AND_XML)
.setBoostType("");
}
/**
* 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 {@link #DEFAULT_CONFIGURATION_VERSION} 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 {@link Ts43Constants#DEFAULT_ENTITLEMENT_VERSION} 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 temporary token. Used by HTTP parameter "temporary_token".
*
* <p>Optional.
*/
public abstract Builder setTemporaryToken(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 Ts43Constants#NOTIFICATION_ACTION_ENABLE_FCM}; otherwise ignored.
*/
public abstract Builder setNotificationAction(@Ts43Constants.NotificationAction int value);
/**
* Sets the configuration document format the caller accepts, e.g. XML or JSON. Used by HTTP
* request header "Accept".
*
* <p>If not set, will use {@link #ACCEPT_CONTENT_TYPE_JSON_AND_XML}.
*
* @see #ACCEPT_CONTENT_TYPE_XML
* @see #ACCEPT_CONTENT_TYPE_JSON
* @see #ACCEPT_CONTENT_TYPE_JSON_AND_XML
*/
public abstract Builder setAcceptContentType(String contentType);
/**
* Sets the boost type for premium network. Used by HTTP parameter
* "boost_type" in case of premium network slice entitlement.
*
* <p>Optional.
*/
public abstract Builder setBoostType(String value);
public abstract ServiceEntitlementRequest build();
}
}
|
