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
|
/*
* 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 androidx.annotation.IntDef;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Indicates errors happened in retrieving service entitlement configuration.
*/
public class ServiceEntitlementException extends Exception {
/**
* Unknown error.
*/
public static final int ERROR_UNKNOWN = 0;
// Android telephony related failures
/**
* Android telephony is unable to provide info like IMSI, e.g. when modem crashed.
*/
public static final int ERROR_PHONE_NOT_AVAILABLE = 10;
// EAP-AKA authentication related failures
/**
* SIM not returning a response to the EAP-AKA challenge, e.g. when the challenge is invalid.
* This can happen only when an embedded EAP-AKA challenge is conducted, as per GSMA spec TS.43
* section 2.6.1.
*/
public static final int ERROR_ICC_AUTHENTICATION_NOT_AVAILABLE = 20;
/**
* EAP-AKA synchronization failure that cannot be recovered even after the "Sequence number
* synchronization" procedure as defined in RFC 4187.
*/
public static final int ERROR_EAP_AKA_SYNCHRONIZATION_FAILURE = 21;
/**
* EAP-AKA failure that happens when the client fails to authenticate within the maximum number
* of attempts
*/
public static final int ERROR_EAP_AKA_FAILURE = 22;
// HTTP related failures
/**
* Cannot connect to the entitlement server, e.g. due to weak mobile network and Wi-Fi
* connection.
*/
public static final int ERROR_SERVER_NOT_CONNECTABLE = 30;
/**
* HTTP response received with a status code indicating failure, e.g. 4xx and 5xx. Use {@link
* #getHttpStatus} to get the status code and {@link #getMessage} the error message in the
* response body.
*/
public static final int ERROR_HTTP_STATUS_NOT_SUCCESS = 31;
/**
* HTTP response received with a malformed format. e.g. the response with content-type JSON but
* failing JSON parser.
*/
public static final int ERROR_MALFORMED_HTTP_RESPONSE = 32;
// ODSA errors
/**
* HTTP response does not contain the authentication token.
*/
public static final int ERROR_TOKEN_NOT_AVAILABLE = 60;
@Retention(RetentionPolicy.SOURCE)
@IntDef({
ERROR_UNKNOWN,
ERROR_PHONE_NOT_AVAILABLE,
ERROR_ICC_AUTHENTICATION_NOT_AVAILABLE,
ERROR_EAP_AKA_SYNCHRONIZATION_FAILURE,
ERROR_EAP_AKA_FAILURE,
ERROR_SERVER_NOT_CONNECTABLE,
ERROR_HTTP_STATUS_NOT_SUCCESS,
ERROR_MALFORMED_HTTP_RESPONSE,
ERROR_TOKEN_NOT_AVAILABLE
})
public @interface ErrorCode {}
/**
* Default HTTP status if not been specified.
*/
public static final int HTTP_STATUS_UNSPECIFIED = 0;
/**
* An empty string if Retry-After header in HTTP response not been specified.
*/
public static final String RETRY_AFTER_UNSPECIFIED = "";
@ErrorCode
private final int mError;
private final int mHttpStatus;
private final String mRetryAfter;
public ServiceEntitlementException(int error, String message) {
this(error, HTTP_STATUS_UNSPECIFIED, RETRY_AFTER_UNSPECIFIED, message);
}
public ServiceEntitlementException(int error, int httpStatus, String message) {
this(error, httpStatus, RETRY_AFTER_UNSPECIFIED, message);
}
public ServiceEntitlementException(
int error, int httpStatus, String retryAfter, String message) {
super(message);
this.mError = error;
this.mHttpStatus = httpStatus;
this.mRetryAfter = retryAfter;
}
public ServiceEntitlementException(int error, String message, Throwable cause) {
this(error, HTTP_STATUS_UNSPECIFIED, RETRY_AFTER_UNSPECIFIED, message, cause);
}
public ServiceEntitlementException(int error, int httpStatus, String message, Throwable cause) {
this(error, httpStatus, RETRY_AFTER_UNSPECIFIED, message, cause);
}
public ServiceEntitlementException(
int error, int httpStatus, String retryAfter, String message, Throwable cause) {
super(message, cause);
this.mError = error;
this.mHttpStatus = httpStatus;
this.mRetryAfter = retryAfter;
}
/**
* Returns the error code. {@link #ERROR_UNKNOWN} if not been specified.
*/
@ErrorCode
public int getErrorCode() {
return mError;
}
/**
* Returns the HTTP status code returned by entitlement server; {@link #HTTP_STATUS_UNSPECIFIED}
* if not been specified.
*/
public int getHttpStatus() {
return mHttpStatus;
}
/**
* Returns the "Retry-After" header in HTTP response, often set with HTTP status code 503; an
* empty string if unavailable.
*
* @return the HTTP-date or a number of seconds to delay, as defined in RFC 7231:
* <a href="https://tools.ietf.org/html/rfc7231#section-7.1.3">...</a>
*/
public String getRetryAfter() {
return mRetryAfter;
}
}
|
