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 package org.apache.hc.client5.http.cache;
28
29 import java.io.Serializable;
30 import java.time.Instant;
31 import java.util.Collection;
32 import java.util.Collections;
33 import java.util.Date;
34 import java.util.HashMap;
35 import java.util.HashSet;
36 import java.util.Iterator;
37 import java.util.Map;
38 import java.util.Set;
39 import java.util.concurrent.atomic.AtomicReference;
40 import java.util.stream.Collectors;
41
42 import org.apache.hc.client5.http.utils.DateUtils;
43 import org.apache.hc.client5.http.validator.ETag;
44 import org.apache.hc.core5.annotation.Contract;
45 import org.apache.hc.core5.annotation.Internal;
46 import org.apache.hc.core5.annotation.ThreadingBehavior;
47 import org.apache.hc.core5.http.Header;
48 import org.apache.hc.core5.http.HttpHeaders;
49 import org.apache.hc.core5.http.HttpStatus;
50 import org.apache.hc.core5.http.MessageHeaders;
51 import org.apache.hc.core5.http.Method;
52 import org.apache.hc.core5.http.ProtocolException;
53 import org.apache.hc.core5.http.message.HeaderGroup;
54 import org.apache.hc.core5.util.Args;
55
56
57
58
59
60
61
62
63
64
65 @Contract(threading = ThreadingBehavior.IMMUTABLE)
66 public class HttpCacheEntry implements MessageHeaders, Serializable {
67
68 private static final long serialVersionUID = -6300496422359477413L;
69
70 private final Instant requestDate;
71 private final Instant responseDate;
72 private final String method;
73 private final String requestURI;
74 private final HeaderGroup requestHeaders;
75 private final int status;
76 private final HeaderGroup responseHeaders;
77 private final Resource resource;
78 private final Set<String> variants;
79 private final AtomicReference<Instant> dateRef;
80 private final AtomicReference<Instant> expiresRef;
81 private final AtomicReference<Instant> lastModifiedRef;
82
83 private final AtomicReference<ETag> eTagRef;
84
85
86
87
88
89 @Internal
90 public HttpCacheEntry(
91 final Instant requestDate,
92 final Instant responseDate,
93 final String method,
94 final String requestURI,
95 final HeaderGroup requestHeaders,
96 final int status,
97 final HeaderGroup responseHeaders,
98 final Resource resource,
99 final Collection<String> variants) {
100 super();
101 this.requestDate = requestDate;
102 this.responseDate = responseDate;
103 this.method = method;
104 this.requestURI = requestURI;
105 this.requestHeaders = requestHeaders;
106 this.status = status;
107 this.responseHeaders = responseHeaders;
108 this.resource = resource;
109 this.variants = variants != null ? Collections.unmodifiableSet(new HashSet<>(variants)) : null;
110 this.dateRef = new AtomicReference<>();
111 this.expiresRef = new AtomicReference<>();
112 this.lastModifiedRef = new AtomicReference<>();
113 this.eTagRef = new AtomicReference<>();
114 }
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135 @Deprecated
136 public HttpCacheEntry(
137 final Date requestDate,
138 final Date responseDate,
139 final int status,
140 final Header[] responseHeaders,
141 final Resource resource,
142 final Map<String, String> variantMap) {
143 this(DateUtils.toInstant(requestDate), DateUtils.toInstant(responseDate), status, responseHeaders, resource, variantMap);
144 }
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160 @Deprecated
161 public HttpCacheEntry(
162 final Instant requestDate,
163 final Instant responseDate,
164 final int status,
165 final Header[] responseHeaders,
166 final Resource resource,
167 final Map<String, String> variantMap) {
168 super();
169 Args.notNull(requestDate, "Request date");
170 Args.notNull(responseDate, "Response date");
171 Args.check(status >= HttpStatus.SC_SUCCESS, "Status code");
172 Args.notNull(responseHeaders, "Response headers");
173 this.requestDate = requestDate;
174 this.responseDate = responseDate;
175 this.method = Method.GET.name();
176 this.requestURI = "/";
177 this.requestHeaders = new HeaderGroup();
178 this.status = status;
179 this.responseHeaders = new HeaderGroup();
180 this.responseHeaders.setHeaders(responseHeaders);
181 this.resource = resource;
182 this.variants = variantMap != null ? Collections.unmodifiableSet(new HashSet<>(variantMap.keySet())) : null;
183 this.dateRef = new AtomicReference<>();
184 this.expiresRef = new AtomicReference<>();
185 this.lastModifiedRef = new AtomicReference<>();
186 this.eTagRef = new AtomicReference<>();
187 }
188
189
190
191
192
193
194
195
196
197
198
199 @Deprecated
200 public HttpCacheEntry(final Date requestDate, final Date responseDate, final int status,
201 final Header[] responseHeaders, final Resource resource) {
202 this(requestDate, responseDate, status, responseHeaders, resource, new HashMap<>());
203 }
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222 @Deprecated
223 public HttpCacheEntry(final Instant requestDate, final Instant responseDate, final int status,
224 final Header[] responseHeaders, final Resource resource) {
225 this(requestDate, responseDate, status, responseHeaders, resource, new HashMap<>());
226 }
227
228
229
230
231 public int getStatus() {
232 return status;
233 }
234
235
236
237
238
239
240
241 @Deprecated
242 public Date getRequestDate() {
243 return DateUtils.toDate(requestDate);
244 }
245
246
247
248
249
250
251
252 public Instant getRequestInstant() {
253 return requestDate;
254 }
255
256
257
258
259
260
261 @Deprecated
262 public Date getResponseDate() {
263 return DateUtils.toDate(responseDate);
264 }
265
266
267
268
269
270
271
272 public Instant getResponseInstant() {
273 return responseDate;
274 }
275
276
277
278
279 @Override
280 public Header[] getHeaders() {
281 return responseHeaders.getHeaders();
282 }
283
284
285
286
287
288 @Override
289 public Header getFirstHeader(final String name) {
290 return responseHeaders.getFirstHeader(name);
291 }
292
293
294
295
296 @Override
297 public Header getLastHeader(final String name) {
298 return responseHeaders.getLastHeader(name);
299 }
300
301
302
303
304
305 @Override
306 public Header[] getHeaders(final String name) {
307 return responseHeaders.getHeaders(name);
308 }
309
310
311
312
313 @Override
314 public boolean containsHeader(final String name) {
315 return responseHeaders.containsHeader(name);
316 }
317
318
319
320
321 @Override
322 public int countHeaders(final String name) {
323 return responseHeaders.countHeaders(name);
324 }
325
326
327
328
329 @Override
330 public Header getHeader(final String name) throws ProtocolException {
331 return responseHeaders.getHeader(name);
332 }
333
334
335
336
337 @Override
338 public Iterator<Header> headerIterator() {
339 return responseHeaders.headerIterator();
340 }
341
342
343
344
345 @Override
346 public Iterator<Header> headerIterator(final String name) {
347 return responseHeaders.headerIterator(name);
348 }
349
350
351
352
353 public MessageHeaders responseHeaders() {
354 return responseHeaders;
355 }
356
357
358
359
360
361
362
363 public Date getDate() {
364 return DateUtils.toDate(getInstant());
365 }
366
367 private static final Instant NON_VALUE = Instant.ofEpochSecond(Instant.MIN.getEpochSecond(), 0);
368
369 private Instant getInstant(final AtomicReference<Instant> ref, final String headerName) {
370 Instant instant = ref.get();
371 if (instant == null) {
372 instant = DateUtils.parseStandardDate(this, headerName);
373 if (instant == null) {
374 instant = NON_VALUE;
375 }
376 if (!ref.compareAndSet(null, instant)) {
377 instant = ref.get();
378 }
379 }
380 return instant != null && instant != NON_VALUE ? instant : null;
381 }
382
383
384
385
386 public Instant getInstant() {
387 return getInstant(dateRef, HttpHeaders.DATE);
388 }
389
390
391
392
393 public Instant getExpires() {
394 return getInstant(expiresRef, HttpHeaders.EXPIRES);
395 }
396
397
398
399
400 public Instant getLastModified() {
401 return getInstant(lastModifiedRef, HttpHeaders.LAST_MODIFIED);
402 }
403
404
405
406
407 public ETag getETag() {
408 ETag eTag = eTagRef.get();
409 if (eTag == null) {
410 eTag = ETag.get(this);
411 if (eTag == null) {
412 return null;
413 }
414 if (!eTagRef.compareAndSet(null, eTag)) {
415 eTag = eTagRef.get();
416 }
417 }
418 return eTag;
419 }
420
421
422
423
424 public Resource getResource() {
425 return this.resource;
426 }
427
428
429
430
431
432
433 public boolean hasVariants() {
434 return variants != null;
435 }
436
437
438
439
440
441
442 public Set<String> getVariants() {
443 return variants != null ? variants : Collections.emptySet();
444 }
445
446
447
448
449 @Deprecated
450 public Map<String, String> getVariantMap() {
451 return variants != null ? variants.stream()
452 .collect(Collectors.toMap(e -> e, e -> e + requestURI)) : Collections.emptyMap();
453 }
454
455
456
457
458
459
460
461 public String getRequestMethod() {
462 return method;
463 }
464
465
466
467
468 public String getRequestURI() {
469 return requestURI;
470 }
471
472
473
474
475 public MessageHeaders requestHeaders() {
476 return requestHeaders;
477 }
478
479
480
481
482 public Iterator<Header> requestHeaderIterator() {
483 return requestHeaders.headerIterator();
484 }
485
486
487
488
489 public Iterator<Header> requestHeaderIterator(final String headerName) {
490 return requestHeaders.headerIterator(headerName);
491 }
492
493
494
495
496
497
498
499
500 public static boolean isNewer(final HttpCacheEntry entry, final MessageHeaders message) {
501 if (entry == null || message == null) {
502 return false;
503 }
504 final Instant cacheDate = entry.getInstant();
505 if (cacheDate == null) {
506 return false;
507 }
508 final Instant messageDate = DateUtils.parseStandardDate(message, HttpHeaders.DATE);
509 if (messageDate == null) {
510 return false;
511 }
512 return cacheDate.compareTo(messageDate) > 0;
513 }
514
515
516
517
518
519 @Override
520 public String toString() {
521 return "HttpCacheEntry{" +
522 "requestDate=" + requestDate +
523 ", responseDate=" + responseDate +
524 ", method='" + method + '\'' +
525 ", requestURI='" + requestURI + '\'' +
526 ", requestHeaders=" + requestHeaders +
527 ", status=" + status +
528 ", responseHeaders=" + responseHeaders +
529 ", resource=" + resource +
530 ", variants=" + variants +
531 '}';
532 }
533 }