1 /*
2 * Copyright (c) 2011-2022, 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 * @since 0.9
56 */
57 @Immutable
58 //@checkstyle ParameterNumber (16 lines)
59 public interface Wire {
60
61 /**
62 * Send request and return response.
63 * @param req Request
64 * @param home URI to fetch
65 * @param method HTTP method
66 * @param headers Headers
67 * @param content HTTP body
68 * @param connect The connect timeout
69 * @param read The read timeout
70 * @return Response obtained
71 * @throws IOException if fails
72 */
73 Response send(Request req, String home, String method,
74 Collection<Map.Entry<String, String>> headers, InputStream content,
75 int connect, int read)
76 throws IOException;
77
78 }