Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ETagCachingWire |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright (c) 2011-2017, jcabi.com | |
3 | * All rights reserved. | |
4 | * | |
5 | * Redistribution and use in source and binary forms, with or without | |
6 | * modification, are permitted provided that the following conditions | |
7 | * are met: 1) Redistributions of source code must retain the above | |
8 | * copyright notice, this list of conditions and the following | |
9 | * disclaimer. 2) Redistributions in binary form must reproduce the above | |
10 | * copyright notice, this list of conditions and the following | |
11 | * disclaimer in the documentation and/or other materials provided | |
12 | * with the distribution. 3) Neither the name of the jcabi.com nor | |
13 | * the names of its contributors may be used to endorse or promote | |
14 | * products derived from this software without specific prior written | |
15 | * permission. | |
16 | * | |
17 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
18 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT | |
19 | * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
20 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | |
21 | * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
22 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
23 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
24 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
25 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
26 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
27 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
28 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
29 | */ | |
30 | package com.jcabi.http.wire; | |
31 | ||
32 | import com.jcabi.aspects.Immutable; | |
33 | import com.jcabi.http.Wire; | |
34 | import javax.ws.rs.core.HttpHeaders; | |
35 | import lombok.ToString; | |
36 | ||
37 | /** | |
38 | * Wire that caches requests with ETags. | |
39 | * | |
40 | * <p>This decorator can be used when you want to avoid duplicate | |
41 | * requests to load-sensitive resources and server supports ETags, for example: | |
42 | * | |
43 | * <pre>{@code | |
44 | * String html = new JdkRequest("http://goggle.com") | |
45 | * .through(ETagCachingWire.class) | |
46 | * .fetch() | |
47 | * .body(); | |
48 | * }</pre> | |
49 | * | |
50 | * <p>Client will automatically detect if server uses ETags and start adding | |
51 | * corresponding If-None-Match to outgoing requests | |
52 | * | |
53 | * <p>Client will take response from the cache if it is present | |
54 | * or will query resource for that. | |
55 | * | |
56 | * <p>The class is immutable and thread-safe. | |
57 | * | |
58 | * @author Ievgen Degtiarenko (ievgen.degtiarenko@gmail.com) | |
59 | * @version $Id: 98e70a6c196270af93b66afe3efb2f4560080f53 $ | |
60 | * @since 2.0 | |
61 | */ | |
62 | 0 | @ToString |
63 | @Immutable | |
64 | public final class ETagCachingWire extends AbstractHeaderBasedCachingWire { | |
65 | ||
66 | /** | |
67 | * Public ctor. | |
68 | * @param wire Original wire | |
69 | */ | |
70 | public ETagCachingWire(final Wire wire) { | |
71 | 2 | super(HttpHeaders.ETAG, HttpHeaders.IF_NONE_MATCH, wire); |
72 | 2 | } |
73 | } |