| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| Wire |
|
| 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; | |
| 31 | ||
| 32 | import com.jcabi.aspects.Immutable; | |
| 33 | import java.io.IOException; | |
| 34 | import java.io.InputStream; | |
| 35 | import java.util.Collection; | |
| 36 | import java.util.Map; | |
| 37 | ||
| 38 | /** | |
| 39 | * Wire. | |
| 40 | * | |
| 41 | * <p>An instance of this interface can be used in | |
| 42 | * {@link Request#through(Class,Object...)} to decorate | |
| 43 | * an existing {@code wire}, for example: | |
| 44 | * | |
| 45 | * <pre> String html = new JdkRequest("http://google.com") | |
| 46 | * .through(VerboseWire.class) | |
| 47 | * .through(RetryWire.class) | |
| 48 | * .header("Accept", "text/html") | |
| 49 | * .fetch() | |
| 50 | * .body();</pre> | |
| 51 | * | |
| 52 | * <p>Every {@code Wire} decorator passed to {@code through()} method | |
| 53 | * wraps a previously existing one. | |
| 54 | * | |
| 55 | * @author Yegor Bugayenko (yegor@tpc2.com) | |
| 56 | * @version $Id: 8d212fafb248565d6098faec993b230fc8e8ad5c $ | |
| 57 | * @since 0.9 | |
| 58 | */ | |
| 59 | @Immutable | |
| 60 | public interface Wire { | |
| 61 | ||
| 62 | /** | |
| 63 | * Send request and return response. | |
| 64 | * @param req Request | |
| 65 | * @param home URI to fetch | |
| 66 | * @param method HTTP method | |
| 67 | * @param headers Headers | |
| 68 | * @param content HTTP body | |
| 69 | * @param connect The connect timeout | |
| 70 | * @param read The read timeout | |
| 71 | * @return Response obtained | |
| 72 | * @throws IOException if fails | |
| 73 | * @checkstyle ParameterNumber (6 lines) | |
| 74 | */ | |
| 75 | Response send(Request req, String home, String method, | |
| 76 | Collection<Map.Entry<String, String>> headers, InputStream content, | |
| 77 | int connect, int read) | |
| 78 | throws IOException; | |
| 79 | ||
| 80 | } |