forked from spring-projects/spring-framework
/
MockMvcRequestBuilders.java
302 lines (269 loc) · 10.5 KB
/
MockMvcRequestBuilders.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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
/*
* Copyright 2002-2022 the original author or authors.
*
* 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
*
* https://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 org.springframework.test.web.servlet.request;
import java.net.URI;
import javax.servlet.DispatcherType;
import org.springframework.http.HttpMethod;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.test.web.servlet.MvcResult;
import org.springframework.test.web.servlet.RequestBuilder;
/**
* Static factory methods for {@link RequestBuilder RequestBuilders}.
*
* <h3>Integration with the Spring TestContext Framework</h3>
* <p>Methods in this class will reuse a
* {@link org.springframework.mock.web.MockServletContext MockServletContext}
* that was created by the Spring TestContext Framework.
*
* <h3>Eclipse Users</h3>
* <p>Consider adding this class as a Java editor favorite. To navigate to
* this setting, open the Preferences and type "favorites".
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @author Greg Turnquist
* @author Sebastien Deleuze
* @author Sam Brannen
* @author Kamill Sokol
* @since 3.2
*/
public abstract class MockMvcRequestBuilders {
/**
* Create a {@link MockHttpServletRequestBuilder} for a GET request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder get(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.GET, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a GET request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder get(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.GET, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a POST request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder post(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.POST, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a POST request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder post(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.POST, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a PUT request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder put(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.PUT, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a PUT request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder put(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.PUT, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a PATCH request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder patch(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a PATCH request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder patch(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.PATCH, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a DELETE request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder delete(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a DELETE request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder delete(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.DELETE, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for an OPTIONS request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder options(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for an OPTIONS request.
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder options(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.OPTIONS, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a HEAD request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
* @since 4.1
*/
public static MockHttpServletRequestBuilder head(String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a HEAD request.
* @param uri the URL
* @since 4.1
*/
public static MockHttpServletRequestBuilder head(URI uri) {
return new MockHttpServletRequestBuilder(HttpMethod.HEAD, uri);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a request with the given HTTP method.
* @param method the HTTP method (GET, POST, etc)
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
*/
public static MockHttpServletRequestBuilder request(HttpMethod method, String urlTemplate, Object... uriVars) {
return new MockHttpServletRequestBuilder(method, urlTemplate, uriVars);
}
/**
* Create a {@link MockHttpServletRequestBuilder} for a request with the given HTTP method.
* @param httpMethod the HTTP method (GET, POST, etc)
* @param uri the URL
* @since 4.0.3
*/
public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, URI uri) {
return new MockHttpServletRequestBuilder(httpMethod, uri);
}
/**
* Alternative factory method that allows for custom HTTP verbs (e.g. WebDAV).
* @param httpMethod the HTTP method
* @param uri the URL
* @since 4.3
*/
public static MockHttpServletRequestBuilder request(String httpMethod, URI uri) {
return new MockHttpServletRequestBuilder(httpMethod, uri);
}
/**
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
* @since 5.0
*/
public static MockMultipartHttpServletRequestBuilder multipart(String urlTemplate, Object... uriVars) {
return new MockMultipartHttpServletRequestBuilder(urlTemplate, uriVars);
}
/**
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* @param httpMethod the HTTP method to use
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
* @since 5.3.22
*/
public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod, String urlTemplate, Object... uriVars) {
return new MockMultipartHttpServletRequestBuilder(httpMethod, urlTemplate, uriVars);
}
/**
* Variant of {@link #multipart(String, Object...)} with a {@link URI}.
* @param uri the URL
* @since 5.0
*/
public static MockMultipartHttpServletRequestBuilder multipart(URI uri) {
return new MockMultipartHttpServletRequestBuilder(uri);
}
/**
* Variant of {@link #multipart(String, Object...)} with a {@link URI} and
* an {@link HttpMethod}.
* @param httpMethod the HTTP method to use
* @param uri the URL
* @since 5.3.21
*/
public static MockMultipartHttpServletRequestBuilder multipart(HttpMethod httpMethod, URI uri) {
return new MockMultipartHttpServletRequestBuilder(httpMethod, uri);
}
/**
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param uriVars zero or more URI variables
* @deprecated in favor of {@link #multipart(String, Object...)}
*/
@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... uriVars) {
return new MockMultipartHttpServletRequestBuilder(urlTemplate, uriVars);
}
/**
* Create a {@link MockMultipartHttpServletRequestBuilder} for a multipart request.
* @param uri the URL
* @since 4.0.3
* @deprecated in favor of {@link #multipart(URI)}
*/
@Deprecated
public static MockMultipartHttpServletRequestBuilder fileUpload(URI uri) {
return new MockMultipartHttpServletRequestBuilder(uri);
}
/**
* Create a {@link RequestBuilder} for an async dispatch from the
* {@link MvcResult} of the request that started async processing.
* <p>Usage involves performing a request that starts async processing first:
* <pre class="code">
* MvcResult mvcResult = this.mockMvc.perform(get("/1"))
* .andExpect(request().asyncStarted())
* .andReturn();
* </pre>
* <p>And then performing the async dispatch re-using the {@code MvcResult}:
* <pre class="code">
* this.mockMvc.perform(asyncDispatch(mvcResult))
* .andExpect(status().isOk())
* .andExpect(content().contentType(MediaType.APPLICATION_JSON))
* .andExpect(content().string("{\"name\":\"Joe\",\"someDouble\":0.0,\"someBoolean\":false}"));
* </pre>
* @param mvcResult the result from the request that started async processing
*/
public static RequestBuilder asyncDispatch(MvcResult mvcResult) {
// There must be an async result before dispatching
mvcResult.getAsyncResult();
return servletContext -> {
MockHttpServletRequest request = mvcResult.getRequest();
request.setDispatcherType(DispatcherType.ASYNC);
request.setAsyncStarted(false);
return request;
};
}
}