Skip to content

Commit e622b2f

Browse files
jknackjknack
committed
Consumes annotation + unsupported media type implementation
1 parent 450e7c6 commit e622b2f

File tree

10 files changed

+429
-18
lines changed

10 files changed

+429
-18
lines changed

‎jooby/src/main/java/io/jooby/Route.java‎

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
import java.io.Serializable;
2121
import java.lang.reflect.Type;
2222
import java.util.ArrayList;
23+
import java.util.Arrays;
2324
import java.util.Collection;
2425
import java.util.Collections;
2526
import java.util.List;
@@ -205,6 +206,16 @@ public interface Handler extends Serializable {
205206
}
206207
};
207208

209+
public static final Route.Before SUPPORT_MEDIA_TYPE = ctx -> {
210+
MediaType contentType = ctx.getContentType();
211+
if (contentType == null) {
212+
throw new Err(StatusCode.UNSUPPORTED_MEDIA_TYPE);
213+
}
214+
if (!ctx.getRoute().getConsumes().stream().anyMatch(contentType::matches)) {
215+
throw new Err(StatusCode.UNSUPPORTED_MEDIA_TYPE, contentType.getValue());
216+
}
217+
};
218+
208219
private static final List<MediaType> EMPTY_LIST = Collections.emptyList();
209220

210221
private final Map<String, Parser> parsers;
@@ -231,6 +242,8 @@ public interface Handler extends Serializable {
231242

232243
private List<MediaType> produces = EMPTY_LIST;
233244

245+
private List<MediaType> consumes = EMPTY_LIST;
246+
234247
/**
235248
* Creates a new route.
236249
*
@@ -410,23 +423,35 @@ public Route setHandle(@Nonnull Object handle) {
410423
return this;
411424
}
412425

413-
public List<MediaType> getProduces() {
426+
public @Nonnull List<MediaType> getProduces() {
414427
return produces;
415428
}
416429

417-
public Route setProduces(MediaType... produces) {
430+
public @Nonnull Route produces(@Nonnull MediaType... produces) {
431+
return setProduces(Arrays.asList(produces));
432+
}
433+
434+
public @Nonnull Route setProduces(@Nonnull Collection<MediaType> produces) {
418435
if (this.produces == EMPTY_LIST) {
419436
this.produces = new ArrayList<>();
420437
}
421-
Stream.of(produces).forEach(this.produces::add);
438+
produces.forEach(this.produces::add);
422439
return this;
423440
}
424441

425-
public Route setProduces(Collection<MediaType> produces) {
426-
if (this.produces == EMPTY_LIST) {
427-
this.produces = new ArrayList<>();
442+
public @Nonnull List<MediaType> getConsumes() {
443+
return consumes;
444+
}
445+
446+
public @Nonnull Route consumes(@Nonnull MediaType... consumes) {
447+
return setConsumes(Arrays.asList(consumes));
448+
}
449+
450+
public @Nonnull Route setConsumes(@Nonnull Collection<MediaType> consumes) {
451+
if (this.consumes == EMPTY_LIST) {
452+
this.consumes = new ArrayList<>();
428453
}
429-
produces.forEach(this.produces::add);
454+
consumes.forEach(this.consumes::add);
430455
return this;
431456
}
432457

‎jooby/src/main/java/io/jooby/annotations/Consumes.java‎

Lines changed: 240 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,240 @@
1+
/**
2+
* Apache License
3+
* Version 2.0, January 2004
4+
* http://www.apache.org/licenses/
5+
*
6+
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
*
8+
* 1. Definitions.
9+
*
10+
* "License" shall mean the terms and conditions for use, reproduction,
11+
* and distribution as defined by Sections 1 through 9 of this document.
12+
*
13+
* "Licensor" shall mean the copyright owner or entity authorized by
14+
* the copyright owner that is granting the License.
15+
*
16+
* "Legal Entity" shall mean the union of the acting entity and all
17+
* other entities that control, are controlled by, or are under common
18+
* control with that entity. For the purposes of this definition,
19+
* "control" means (i) the power, direct or indirect, to cause the
20+
* direction or management of such entity, whether by contract or
21+
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
* outstanding shares, or (iii) beneficial ownership of such entity.
23+
*
24+
* "You" (or "Your") shall mean an individual or Legal Entity
25+
* exercising permissions granted by this License.
26+
*
27+
* "Source" form shall mean the preferred form for making modifications,
28+
* including but not limited to software source code, documentation
29+
* source, and configuration files.
30+
*
31+
* "Object" form shall mean any form resulting from mechanical
32+
* transformation or translation of a Source form, including but
33+
* not limited to compiled object code, generated documentation,
34+
* and conversions to other media types.
35+
*
36+
* "Work" shall mean the work of authorship, whether in Source or
37+
* Object form, made available under the License, as indicated by a
38+
* copyright notice that is included in or attached to the work
39+
* (an example is provided in the Appendix below).
40+
*
41+
* "Derivative Works" shall mean any work, whether in Source or Object
42+
* form, that is based on (or derived from) the Work and for which the
43+
* editorial revisions, annotations, elaborations, or other modifications
44+
* represent, as a whole, an original work of authorship. For the purposes
45+
* of this License, Derivative Works shall not include works that remain
46+
* separable from, or merely link (or bind by name) to the interfaces of,
47+
* the Work and Derivative Works thereof.
48+
*
49+
* "Contribution" shall mean any work of authorship, including
50+
* the original version of the Work and any modifications or additions
51+
* to that Work or Derivative Works thereof, that is intentionally
52+
* submitted to Licensor for inclusion in the Work by the copyright owner
53+
* or by an individual or Legal Entity authorized to submit on behalf of
54+
* the copyright owner. For the purposes of this definition, "submitted"
55+
* means any form of electronic, verbal, or written communication sent
56+
* to the Licensor or its representatives, including but not limited to
57+
* communication on electronic mailing lists, source code control systems,
58+
* and issue tracking systems that are managed by, or on behalf of, the
59+
* Licensor for the purpose of discussing and improving the Work, but
60+
* excluding communication that is conspicuously marked or otherwise
61+
* designated in writing by the copyright owner as "Not a Contribution."
62+
*
63+
* "Contributor" shall mean Licensor and any individual or Legal Entity
64+
* on behalf of whom a Contribution has been received by Licensor and
65+
* subsequently incorporated within the Work.
66+
*
67+
* 2. Grant of Copyright License. Subject to the terms and conditions of
68+
* this License, each Contributor hereby grants to You a perpetual,
69+
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
* copyright license to reproduce, prepare Derivative Works of,
71+
* publicly display, publicly perform, sublicense, and distribute the
72+
* Work and such Derivative Works in Source or Object form.
73+
*
74+
* 3. Grant of Patent License. Subject to the terms and conditions of
75+
* this License, each Contributor hereby grants to You a perpetual,
76+
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
* (except as stated in this section) patent license to make, have made,
78+
* use, offer to sell, sell, import, and otherwise transfer the Work,
79+
* where such license applies only to those patent claims licensable
80+
* by such Contributor that are necessarily infringed by their
81+
* Contribution(s) alone or by combination of their Contribution(s)
82+
* with the Work to which such Contribution(s) was submitted. If You
83+
* institute patent litigation against any entity (including a
84+
* cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
* or a Contribution incorporated within the Work constitutes direct
86+
* or contributory patent infringement, then any patent licenses
87+
* granted to You under this License for that Work shall terminate
88+
* as of the date such litigation is filed.
89+
*
90+
* 4. Redistribution. You may reproduce and distribute copies of the
91+
* Work or Derivative Works thereof in any medium, with or without
92+
* modifications, and in Source or Object form, provided that You
93+
* meet the following conditions:
94+
*
95+
* (a) You must give any other recipients of the Work or
96+
* Derivative Works a copy of this License; and
97+
*
98+
* (b) You must cause any modified files to carry prominent notices
99+
* stating that You changed the files; and
100+
*
101+
* (c) You must retain, in the Source form of any Derivative Works
102+
* that You distribute, all copyright, patent, trademark, and
103+
* attribution notices from the Source form of the Work,
104+
* excluding those notices that do not pertain to any part of
105+
* the Derivative Works; and
106+
*
107+
* (d) If the Work includes a "NOTICE" text file as part of its
108+
* distribution, then any Derivative Works that You distribute must
109+
* include a readable copy of the attribution notices contained
110+
* within such NOTICE file, excluding those notices that do not
111+
* pertain to any part of the Derivative Works, in at least one
112+
* of the following places: within a NOTICE text file distributed
113+
* as part of the Derivative Works; within the Source form or
114+
* documentation, if provided along with the Derivative Works; or,
115+
* within a display generated by the Derivative Works, if and
116+
* wherever such third-party notices normally appear. The contents
117+
* of the NOTICE file are for informational purposes only and
118+
* do not modify the License. You may add Your own attribution
119+
* notices within Derivative Works that You distribute, alongside
120+
* or as an addendum to the NOTICE text from the Work, provided
121+
* that such additional attribution notices cannot be construed
122+
* as modifying the License.
123+
*
124+
* You may add Your own copyright statement to Your modifications and
125+
* may provide additional or different license terms and conditions
126+
* for use, reproduction, or distribution of Your modifications, or
127+
* for any such Derivative Works as a whole, provided Your use,
128+
* reproduction, and distribution of the Work otherwise complies with
129+
* the conditions stated in this License.
130+
*
131+
* 5. Submission of Contributions. Unless You explicitly state otherwise,
132+
* any Contribution intentionally submitted for inclusion in the Work
133+
* by You to the Licensor shall be under the terms and conditions of
134+
* this License, without any additional terms or conditions.
135+
* Notwithstanding the above, nothing herein shall supersede or modify
136+
* the terms of any separate license agreement you may have executed
137+
* with Licensor regarding such Contributions.
138+
*
139+
* 6. Trademarks. This License does not grant permission to use the trade
140+
* names, trademarks, service marks, or product names of the Licensor,
141+
* except as required for reasonable and customary use in describing the
142+
* origin of the Work and reproducing the content of the NOTICE file.
143+
*
144+
* 7. Disclaimer of Warranty. Unless required by applicable law or
145+
* agreed to in writing, Licensor provides the Work (and each
146+
* Contributor provides its Contributions) on an "AS IS" BASIS,
147+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
* implied, including, without limitation, any warranties or conditions
149+
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
* PARTICULAR PURPOSE. You are solely responsible for determining the
151+
* appropriateness of using or redistributing the Work and assume any
152+
* risks associated with Your exercise of permissions under this License.
153+
*
154+
* 8. Limitation of Liability. In no event and under no legal theory,
155+
* whether in tort (including negligence), contract, or otherwise,
156+
* unless required by applicable law (such as deliberate and grossly
157+
* negligent acts) or agreed to in writing, shall any Contributor be
158+
* liable to You for damages, including any direct, indirect, special,
159+
* incidental, or consequential damages of any character arising as a
160+
* result of this License or out of the use or inability to use the
161+
* Work (including but not limited to damages for loss of goodwill,
162+
* work stoppage, computer failure or malfunction, or any and all
163+
* other commercial damages or losses), even if such Contributor
164+
* has been advised of the possibility of such damages.
165+
*
166+
* 9. Accepting Warranty or Additional Liability. While redistributing
167+
* the Work or Derivative Works thereof, You may choose to offer,
168+
* and charge a fee for, acceptance of support, warranty, indemnity,
169+
* or other liability obligations and/or rights consistent with this
170+
* License. However, in accepting such obligations, You may act only
171+
* on Your own behalf and on Your sole responsibility, not on behalf
172+
* of any other Contributor, and only if You agree to indemnify,
173+
* defend, and hold each Contributor harmless for any liability
174+
* incurred by, or claims asserted against, such Contributor by reason
175+
* of your accepting any such warranty or additional liability.
176+
*
177+
* END OF TERMS AND CONDITIONS
178+
*
179+
* APPENDIX: How to apply the Apache License to your work.
180+
*
181+
* To apply the Apache License to your work, attach the following
182+
* boilerplate notice, with the fields enclosed by brackets "{}"
183+
* replaced with your own identifying information. (Don't include
184+
* the brackets!) The text should be enclosed in the appropriate
185+
* comment syntax for the file format. We also recommend that a
186+
* file or class name and description of purpose be included on the
187+
* same "printed page" as the copyright notice for easier
188+
* identification within third-party archives.
189+
*
190+
* Copyright 2014 Edgar Espina
191+
*
192+
* Licensed under the Apache License, Version 2.0 (the "License");
193+
* you may not use this file except in compliance with the License.
194+
* You may obtain a copy of the License at
195+
*
196+
* http://www.apache.org/licenses/LICENSE-2.0
197+
*
198+
* Unless required by applicable law or agreed to in writing, software
199+
* distributed under the License is distributed on an "AS IS" BASIS,
200+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
* See the License for the specific language governing permissions and
202+
* limitations under the License.
203+
*/
204+
package io.jooby.annotations;
205+
206+
import java.lang.annotation.Documented;
207+
import java.lang.annotation.ElementType;
208+
import java.lang.annotation.Inherited;
209+
import java.lang.annotation.Retention;
210+
import java.lang.annotation.RetentionPolicy;
211+
import java.lang.annotation.Target;
212+
213+
/**
214+
* Defines what media types a route can consume.
215+
*
216+
* Check the <code>Content-Type</code> header against this value or send a
217+
* "415 Unsupported Media Type" response.
218+
*
219+
* <pre>
220+
* class Resources {
221+
*
222+
* &#64;Consume("application/json")
223+
* public void method(&#64;Body MyBody body) {
224+
* }
225+
* }
226+
* </pre>
227+
*
228+
* @author edgar
229+
* @since 2.0.0
230+
*/
231+
@Inherited
232+
@Target({ElementType.TYPE, ElementType.METHOD })
233+
@Retention(RetentionPolicy.RUNTIME)
234+
@Documented
235+
public @interface Consumes {
236+
/**
237+
* @return Media types the route can consume.
238+
*/
239+
String[] value();
240+
}

‎jooby/src/main/java/io/jooby/annotations/Produces.java‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
/**
2+
* Licensed under the Apache License, Version 2.0 (the "License");
3+
* you may not use this file except in compliance with the License.
4+
* You may obtain a copy of the License at
5+
*
6+
* http://www.apache.org/licenses/LICENSE-2.0
7+
*
8+
* Unless required by applicable law or agreed to in writing, software
9+
* distributed under the License is distributed on an "AS IS" BASIS,
10+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
* See the License for the specific language governing permissions and
12+
* limitations under the License.
13+
*
14+
* Copyright 2014 Edgar Espina
15+
*/
116
package io.jooby.annotations;
217

318
import java.lang.annotation.Documented;
@@ -22,7 +37,7 @@
2237
* }
2338
* </pre>
2439
* @author edgar
25-
* @since 0.1.0
40+
* @since 2.0.0
2641
*/
2742
@Inherited
2843
@Target({ElementType.TYPE, ElementType.METHOD})

‎jooby/src/main/java/io/jooby/internal/RouterImpl.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,9 @@ private Route defineRoute(@Nonnull String method, @Nonnull String pattern,
393393
if (route.getProduces().size() > 0) {
394394
before = before == null ? Route.ACCEPT : Route.ACCEPT.then(before);
395395
}
396+
if (route.getConsumes().size() > 0) {
397+
before = before == null ? Route.SUPPORT_MEDIA_TYPE : Route.SUPPORT_MEDIA_TYPE.then(before);
398+
}
396399
Route.Handler pipeline = route.getHandler();
397400

398401
if (before != null) {
@@ -549,6 +552,11 @@ private void mvc(String prefix, Class type, Provider provider) {
549552
if (produces.size() > 0) {
550553
route.setProduces(produces);
551554
}
555+
556+
Set<MediaType> consumes = mvcAnnotations.consumes(method.getMethod());
557+
if (consumes.size() > 0) {
558+
route.setConsumes(consumes);
559+
}
552560
});
553561
}
554562

‎jooby/src/main/java/io/jooby/internal/mvc/DefaultMvcAnnotation.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,12 @@ public class DefaultMvcAnnotation implements MvcAnnotation {
8686
: Stream.of(produces.value()).map(MediaType::valueOf)
8787
.collect(Collectors.toCollection(LinkedHashSet::new));
8888
}
89+
90+
@Override public Set<MediaType> consumes(Method method) {
91+
Consumes consumes = method.getAnnotation(Consumes.class);
92+
return consumes == null
93+
? Collections.emptySet()
94+
: Stream.of(consumes.value()).map(MediaType::valueOf)
95+
.collect(Collectors.toCollection(LinkedHashSet::new));
96+
}
8997
}

‎jooby/src/main/java/io/jooby/internal/mvc/JaxrsAnnotation.java‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,12 @@ public class JaxrsAnnotation implements MvcAnnotation {
8686
: Stream.of(produces.value()).map(MediaType::valueOf)
8787
.collect(Collectors.toCollection(LinkedHashSet::new));
8888
}
89+
90+
@Override public Set<MediaType> consumes(Method method) {
91+
Consumes consumes = method.getAnnotation(Consumes.class);
92+
return consumes == null
93+
? Collections.emptySet()
94+
: Stream.of(consumes.value()).map(MediaType::valueOf)
95+
.collect(Collectors.toCollection(LinkedHashSet::new));
96+
}
8997
}

0 commit comments

Comments
 (0)