-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
MockServer.java
115 lines (100 loc) · 3.4 KB
/
MockServer.java
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/**
* Copyright (C) 2015 Red Hat, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.fabric8.mockwebserver;
import io.fabric8.mockwebserver.dsl.MockServerExpectation;
import io.fabric8.mockwebserver.http.RecordedRequest;
import io.vertx.core.net.SelfSignedCertificate;
import java.net.Proxy;
import java.util.concurrent.TimeUnit;
public interface MockServer {
/**
* This method is called right before start. Override it to add extra initialization.
*/
default void onStart() {
}
/**
* This method is called right after shutdown. Override it to add extra cleanup.
*/
default void onShutdown() {
}
/**
* The port for the Mock Web Server.
*
* @return the MockWebServer port.
*/
int getPort();
/**
* The host name for the Mock Web Server.
*
* @return the MockWebServer host name;
*/
String getHostName();
/**
* Returns a {@link Proxy} for the Mock Web Server with the current HostName and Port.
*
* @return a Proxy for the MockWebServer.
*/
Proxy toProxyAddress();
/**
* Returns the {@link SelfSignedCertificate} for the Mock Web Server.
*
* @return the SelfSignedCertificate for the MockWebServer.
*/
SelfSignedCertificate getSelfSignedCertificate();
/**
* Returns a String URL for connecting to this server.
*
* @param path the request path, such as "/".
*/
String url(String path);
/**
* Returns a {@link MockServerExpectation} to set the expectations.
*
* @return the MockServerExpectation builder.
*/
MockServerExpectation expect();
/**
* Returns the number of HTTP requests received thus far by this server. This may exceed the
* number of HTTP connections when connection reuse is in practice.
*/
int getRequestCount();
/**
* Awaits the next HTTP request, removes it, and returns it. Callers should use this to verify the
* request was sent as intended. This method will block until the request is available, possibly
* forever.
*
* @return the head of the request queue
*/
RecordedRequest takeRequest() throws InterruptedException;
/**
* Awaits the next HTTP request (waiting up to the specified wait time if necessary), removes it,
* and returns it. Callers should use this to verify the request was sent as intended within the
* given time.
*
* @param timeout how long to wait before giving up, in units of {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the {@code timeout} parameter
* @return the head of the request queue
*/
RecordedRequest takeRequest(long timeout, TimeUnit unit) throws InterruptedException;
/**
* Returns the last (most recent) HTTP request processed by the {@link MockWebServer}.
*
* n.b. This method clears the request queue.
*
* @return the most recent RecordedRequest or null if none was processed.
*/
RecordedRequest getLastRequest() throws InterruptedException;
}