blob: d0a63f86b8be5199137772eb4a76e333ca3b7411 (
plain)
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
|
/*
* 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.net.Network;
import androidx.annotation.Nullable;
import com.google.auto.value.AutoValue;
/**
* Carrier specific customization to be used in the service entitlement queries and operations.
*
* @see #ServiceEntitlement
*/
@AutoValue
public abstract class CarrierConfig {
/** Default value of {@link #timeoutInSec} if not set. */
public static final int DEFAULT_TIMEOUT_IN_SEC = 30;
public static final String CLIENT_TS_43_IMS_ENTITLEMENT = "IMS-Entitlement";
public static final String CLIENT_TS_43_COMPANION_ODSA = "Companion-ODSA";
public static final String CLIENT_TS_43_PRIMARY_ODSA = "Primary-ODSA";
public static final String CLIENT_TS_43_SERVER_ODSA = "Server-ODSA";
/** The carrier's entitlement server URL. See {@link Builder#setServerUrl}. */
public abstract String serverUrl();
/**
* Client-ts43 attribute. Used to set the User-Agent header in HTTP requests as defined in TS.43
* section 2.2.
*/
public abstract String clientTs43();
/** Returns {@code true} if HTTP POST, instead of GET, should be used for TS.43 requests. */
public abstract boolean useHttpPost();
/** Client side timeout for HTTP connection. See {@link Builder#setTimeoutInSec}. */
public abstract int timeoutInSec();
/** The {@link Network} used for HTTP connection. See {@link Builder#setNetwork}. */
@Nullable
public abstract Network network();
/** Returns a new {@link Builder} object. */
public static Builder builder() {
return new AutoValue_CarrierConfig.Builder()
.setServerUrl("")
.setClientTs43("")
.setUseHttpPost(false)
.setTimeoutInSec(DEFAULT_TIMEOUT_IN_SEC);
}
/** Builder. */
@AutoValue.Builder
public abstract static class Builder {
public abstract CarrierConfig build();
/**
* Sets the carrier's entitlement server URL. If not set, will use {@code
* https://aes.mnc<MNC>.mcc<MCC>.pub.3gppnetwork.org} as defined in GSMA TS.43 section 2.1.
*/
public abstract Builder setServerUrl(String url);
/** Sets the Client-ts43 attribute. Used to set the User-Agent header in HTTP requests. */
public abstract Builder setClientTs43(String clientTs43);
/** Set to {@code true} to use HTTP POST instead of GET for TS.43 requests. */
public abstract Builder setUseHttpPost(boolean useHttpPost);
/**
* Sets the client side timeout for HTTP connection. Default to
* {@link DEFAULT_TIMEOUT_IN_SEC}.
*
* <p>This timeout is used by both {@link java.net.URLConnection#setConnectTimeout} and
* {@link java.net.URLConnection#setReadTimeout}.
*/
public abstract Builder setTimeoutInSec(int timeoutInSec);
/**
* Sets the {@link Network} used for HTTP connection. If not set, the device default network
* is used.
*/
public abstract Builder setNetwork(Network network);
}
}
|
