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 java.io.IOException;
33 import java.io.InputStream;
34 import java.util.Collection;
35 import java.util.Map.Entry;
36
37 /**
38 * Utility wire used for injecting a mock object into a {@link Request}
39 * implementation.
40 * <p>
41 * NOTE: This is not threadsafe and access to it should be synchronized.
42 *
43 * @since 1.17.1
44 * @checkstyle ParameterNumberCheck (50 lines)
45 */
46 public class MockWire implements Wire {
47
48 /**
49 * The actual mock object we delegate the <code>Wire.send</code> call to.
50 */
51 private static Wire mockDelegate;
52
53 /**
54 * Creates a new mock wire instance.
55 * <p>
56 * The given target wire is ignored and <code>Wire.send</code> is delegated
57 * to the static mock delegate.
58 *
59 * @param wire The original wire which is ignored
60 */
61 @SuppressWarnings("PMD.UnusedFormalParameter")
62 public MockWire(final Wire wire) {
63 // Instantiated by a Request implementation, wire is ignored
64 }
65
66 @Override
67 public final Response send(final Request req, final String home,
68 final String method, final Collection<Entry<String, String>> headers,
69 final InputStream content, final int connect, final int read)
70 throws IOException {
71 return mockDelegate.send(
72 req,
73 home,
74 method,
75 headers,
76 content,
77 connect,
78 read
79 );
80 }
81
82 /**
83 * Sets the mock the <code>Request.send</code> method is delegated to.
84 *
85 * @param mock The mock to assert variables passed by the request
86 * implementation
87 */
88 @SuppressWarnings("PMD.DefaultPackage")
89 static void setMockDelegate(final Wire mock) {
90 MockWire.mockDelegate = mock;
91 }
92
93 }