{{ message }}
Repository navigation
Expand file tree
/
Copy pathRetryableException.java
More file actions
307 lines (289 loc) · 10.9 KB
/
Copy pathRetryableException.java
File metadata and controls
307 lines (289 loc) · 10.9 KB
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
/*
* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)
*
* 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 feign;
import feign.Request.HttpMethod;
import java.util.Collection;
import java.util.Date;
import java.util.Map;
/**
* This exception is raised when the {@link Response} is deemed to be retryable, typically via an
* {@link feign.codec.ErrorDecoder} when the {@link Response#status() status} is 503.
*/
public class RetryableException extends FeignException {
private static final long serialVersionUID = 3L;
private final Long retryAfter;
private final HttpMethod httpMethod;
private final String methodKey;
/**
* Represents a non-retryable exception when Retry-After information is explicitly not provided.
*
* <p>Use this constructor when the server response does not include a Retry-After header or when
* retries are not expected.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param request the original HTTP request
*/
public RetryableException(int status, String message, HttpMethod httpMethod, Request request) {
super(status, message, request);
this.httpMethod = httpMethod;
this.retryAfter = null;
this.methodKey = null;
}
/**
* Represents a non-retryable exception when Retry-After information is explicitly not provided.
*
* <p>Use this constructor when the server response does not include a Retry-After header or when
* retries are not expected.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param cause the underlying cause of the exception
* @param request the original HTTP request
*/
public RetryableException(
int status, String message, HttpMethod httpMethod, Throwable cause, Request request) {
super(status, message, request, cause);
this.httpMethod = httpMethod;
this.retryAfter = null;
this.methodKey = null;
}
/**
* Represents a retryable exception without retaining the original request.
*
* <p>Use this constructor when the request is unavailable or should not be retained by the
* exception.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param retryAfter the retry delay in milliseconds
*/
public RetryableException(int status, String message, HttpMethod httpMethod, Long retryAfter) {
super(status, message);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = null;
}
/**
* Represents a retryable exception without retaining the original request.
*
* <p>Use this constructor when the request is unavailable or should not be retained by the
* exception.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param cause the underlying cause of the exception
* @param retryAfter the retry delay in milliseconds
*/
public RetryableException(
int status, String message, HttpMethod httpMethod, Throwable cause, Long retryAfter) {
super(status, message, cause);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = null;
}
/**
* Represents a retryable exception when Retry-After information is available.
*
* <p>Use this constructor when the server response includes a Retry-After header specifying the
* delay in milliseconds before retrying.
*
* <p>If {@code retryAfter} is {@code null}, prefer using {@link #RetryableException(int, String,
* HttpMethod, Throwable, Request)} instead.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param cause the underlying cause of the exception
* @param retryAfter the retry delay in milliseconds retryAfter usually corresponds to the {@link
* feign.Util#RETRY_AFTER} header. If you don't want to retry, use {@link
* #RetryableException(int, String, HttpMethod, Throwable, Request)}.
* @param request the original HTTP request
*/
public RetryableException(
int status,
String message,
HttpMethod httpMethod,
Throwable cause,
Long retryAfter,
Request request) {
super(status, message, request, cause);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = null;
}
/**
* Represents a retryable exception with methodKey for identifying the method being retried.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param cause the underlying cause of the exception
* @param retryAfter the retry delay in milliseconds
* @param request the original HTTP request
* @param methodKey the method key identifying the Feign method
*/
public RetryableException(
int status,
String message,
HttpMethod httpMethod,
Throwable cause,
Long retryAfter,
Request request,
String methodKey) {
super(status, message, request, cause);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = methodKey;
}
/**
* @deprecated Use {@link #RetryableException(int, String, HttpMethod, Throwable, Long, Request)}
* instead. This constructor uses {@link Date} for retryAfter, which has been replaced by
* {@link Long}.
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param cause the underlying cause of the exception
* @param retryAfter the retry-after time as a {@link Date}
* @param request the original HTTP request
*/
@Deprecated
public RetryableException(
int status,
String message,
HttpMethod httpMethod,
Throwable cause,
Date retryAfter,
Request request) {
super(status, message, request, cause);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter != null ? retryAfter.getTime() : null;
this.methodKey = null;
}
/**
* Represents a retryable exception when Retry-After information is available.
*
* <p>Use this constructor when the server response includes a Retry-After header.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param retryAfter the retry delay in milliseconds retryAfter usually corresponds to the {@link
* feign.Util#RETRY_AFTER} header. If you don't want to retry, use {@link
* #RetryableException(int, String, HttpMethod, Request)}
* @param request the original HTTP request
*/
public RetryableException(
int status, String message, HttpMethod httpMethod, Long retryAfter, Request request) {
super(status, message, request);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = null;
}
/**
* @deprecated Use {@link #RetryableException(int, String, HttpMethod, Long, Request)} instead.
* This constructor uses {@link Date} for retryAfter, which has been replaced by {@link Long}.
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param retryAfter the retry-after time as a {@link Date}
* @param request the original HTTP request
*/
@Deprecated
public RetryableException(
int status, String message, HttpMethod httpMethod, Date retryAfter, Request request) {
super(status, message, request);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter != null ? retryAfter.getTime() : null;
this.methodKey = null;
}
/**
* Represents a retryable exception with response body and headers.
*
* <p>Use this constructor when handling HTTP responses that include Retry-After information.
*
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param retryAfter the retry delay in milliseconds retryAfter usually corresponds to the {@link
* feign.Util#RETRY_AFTER} header.
* @param request the original HTTP request
* @param responseBody the HTTP response body
* @param responseHeaders the HTTP response headers
*/
public RetryableException(
int status,
String message,
HttpMethod httpMethod,
Long retryAfter,
Request request,
byte[] responseBody,
Map<String, Collection<String>> responseHeaders) {
super(status, message, request, responseBody, responseHeaders);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter;
this.methodKey = null;
}
/**
* @deprecated Use {@link #RetryableException(int, String, HttpMethod, Long, Request, byte[],
* Map)} instead. This constructor uses {@link Date} for retryAfter, which has been replaced
* by {@link Long}.
* @param status the HTTP status code
* @param message the exception message
* @param httpMethod the HTTP method (GET, POST, etc.)
* @param retryAfter the retry-after time as a {@link Date}
* @param request the original HTTP request
* @param responseBody the HTTP response body
* @param responseHeaders the HTTP response headers
*/
@Deprecated
public RetryableException(
int status,
String message,
HttpMethod httpMethod,
Date retryAfter,
Request request,
byte[] responseBody,
Map<String, Collection<String>> responseHeaders) {
super(status, message, request, responseBody, responseHeaders);
this.httpMethod = httpMethod;
this.retryAfter = retryAfter != null ? retryAfter.getTime() : null;
this.methodKey = null;
}
/**
* Sometimes corresponds to the {@link feign.Util#RETRY_AFTER} header present in {@code 503}
* status. Other times parsed from an application-specific response. Null if unknown.
*/
public Long retryAfter() {
return retryAfter;
}
public HttpMethod method() {
return this.httpMethod;
}
/**
* Returns the method key identifying the Feign method that was being invoked. This corresponds to
* the methodKey parameter in {@link feign.codec.ErrorDecoder#decode}.
*
* @return the method key, or null if not set
*/
public String methodKey() {
return this.methodKey;
}
}
You can’t perform that action at this time.