This repository was archived by the owner on Mar 3, 2026. It is now read-only.
forked from jooby-project/jooby
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRoute.java
More file actions
2885 lines (2620 loc) · 79.7 KB
/
Route.java
File metadata and controls
2885 lines (2620 loc) · 79.7 KB
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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright 2014 Edgar Espina
*
* 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 org.jooby;
import com.google.common.base.CaseFormat;
import static com.google.common.base.Preconditions.checkArgument;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.primitives.Primitives;
import com.google.inject.Key;
import com.google.inject.TypeLiteral;
import static java.util.Objects.requireNonNull;
import org.jooby.funzy.Throwing;
import org.jooby.handlers.AssetHandler;
import org.jooby.internal.RouteImpl;
import org.jooby.internal.RouteMatcher;
import org.jooby.internal.RoutePattern;
import org.jooby.internal.RouteSourceImpl;
import org.jooby.internal.SourceProvider;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.lang.reflect.Array;
import java.lang.reflect.Method;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.stream.Collectors;
/**
* Routes are a key concept in Jooby. Routes are executed in the same order they are defined.
*
* <h1>handlers</h1>
* <p>
* There are few type of handlers: {@link Route.Handler}, {@link Route.OneArgHandler}
* {@link Route.ZeroArgHandler} and {@link Route.Filter}. They behave very similar, except that a
* {@link Route.Filter} can decide if the next route handler can be executed or not. For example:
* </p>
*
* <pre>
* get("/filter", (req, rsp, chain) {@literal ->} {
* if (someCondition) {
* chain.next(req, rsp);
* } else {
* // respond, throw err, etc...
* }
* });
* </pre>
*
* While a {@link Route.Handler} always execute the next handler:
*
* <pre>
* get("/path", (req, rsp) {@literal ->} {
* rsp.send("handler");
* });
*
* // filter version
* get("/path", (req, rsp, chain) {@literal ->} {
* rsp.send("handler");
* chain.next(req, rsp);
* });
* </pre>
*
* The {@link Route.OneArgHandler} and {@link Route.ZeroArgHandler} offers a functional version of
* generating a response:
*
* <pre>{@code
* {
* get("/path", req -> "handler");
*
* get("/path", () -> "handler");
* }
* }</pre>
*
* There is no need to call {@link Response#send(Object)}.
*
* <h1>path patterns</h1>
* <p>
* Jooby supports Ant-style path patterns:
* </p>
* <p>
* Some examples:
* </p>
* <ul>
* <li>{@code com/t?st.html} - matches {@code com/test.html} but also {@code com/tast.jsp} or
* {@code com/txst.html}</li>
* <li>{@code com/*.html} - matches all {@code .html} files in the {@code com} directory</li>
* <li><code>com/{@literal **}/test.html</code> - matches all {@code test.html} files underneath the
* {@code com} path</li>
* <li>{@code **}/{@code *} - matches any path at any level.</li>
* <li>{@code *} - matches any path at any level, shorthand for {@code **}/{@code *}.</li>
* </ul>
*
* <h2>variables</h2>
* <p>
* Jooby supports path parameters too:
* </p>
* <p>
* Some examples:
* </p>
* <ul>
* <li><code> /user/{id}</code> - /user/* and give you access to the <code>id</code> var.</li>
* <li><code> /user/:id</code> - /user/* and give you access to the <code>id</code> var.</li>
* <li><code> /user/{id:\\d+}</code> - /user/[digits] and give you access to the numeric
* <code>id</code> var.</li>
* </ul>
*
* <h1>routes semantic</h1>
* <p>
* Routes are executed in the order they are defined, for example:
* </p>
*
* <pre>
* get("/", (req, rsp) {@literal ->} {
* log.info("first"); // start here and go to second
* });
*
* get("/", (req, rsp) {@literal ->} {
* log.info("second"); // execute after first and go to final
* });
*
* get("/", (req, rsp) {@literal ->} {
* rsp.send("final"); // done!
* });
* </pre>
*
* Please note first and second routes are converted to a filter, so previous example is the same
* as:
*
* <pre>
* get("/", (req, rsp, chain) {@literal ->} {
* log.info("first"); // start here and go to second
* chain.next(req, rsp);
* });
*
* get("/", (req, rsp, chain) {@literal ->} {
* log.info("second"); // execute after first and go to final
* chain.next(req, rsp);
* });
*
* get("/", (req, rsp) {@literal ->} {
* rsp.send("final"); // done!
* });
* </pre>
*
* <h2>script route</h2>
* <p>
* A script route can be defined using Lambda expressions, like:
* </p>
*
* <pre>
* get("/", (request, response) {@literal ->} {
* response.send("Hello Jooby");
* });
* </pre>
*
* Due to the use of lambdas a route is a singleton and you should NOT use global variables.
* For example this is a bad practice:
*
* <pre>
* List{@literal <}String{@literal >} names = new ArrayList{@literal <>}(); // names produces side effects
* get("/", (req, rsp) {@literal ->} {
* names.add(req.param("name").value();
* // response will be different between calls.
* rsp.send(names);
* });
* </pre>
*
* <h2>mvc Route</h2>
* <p>
* A Mvc Route use annotations to define routes:
* </p>
*
* <pre>
* {
* use(MyRoute.class);
* }
* </pre>
*
* MyRoute.java:
* <pre>
* {@literal @}Path("/")
* public class MyRoute {
*
* {@literal @}GET
* public String hello() {
* return "Hello Jooby";
* }
* }
* </pre>
* <p>
* Programming model is quite similar to JAX-RS/Jersey with some minor differences and/or
* simplifications.
* </p>
*
* <p>
* To learn more about Mvc Routes, please check {@link org.jooby.mvc.Path},
* {@link org.jooby.mvc.Produces} {@link org.jooby.mvc.Consumes}.
* </p>
*
* @author edgar
* @since 0.1.0
*/
public interface Route {
/**
* Provides useful information about where the route was defined.
*
* See {@link Definition#source()} and {@link Route#source()}.
*
* @author edgar
* @since 1.0.0.CR4
*/
interface Source {
/**
* There is no source information.
*/
Source BUILTIN = new Source() {
@Override
public int line() {
return -1;
}
@Override
public Optional<String> declaringClass() {
return Optional.empty();
}
@Override
public String toString() {
return "~builtin";
}
};
/**
* @return Line number where the route was defined or <code>-1</code> when not available.
*/
int line();
/**
* @return Class where the route
*/
@Nonnull
Optional<String> declaringClass();
}
/**
* Converts a route output to something else, see {@link Router#map(Mapper)}.
*
* <pre>{@code
* {
* // we got bar.. not foo
* get("/foo", () -> "foo")
* .map(value -> "bar");
*
* // we got foo.. not bar
* get("/bar", () -> "bar")
* .map(value -> "foo");
* }
* }</pre>
*
* If you want to apply a single map to several routes:
*
* <pre>{@code
* {
* with(() -> {
* get("/foo", () -> "foo");
*
* get("/bar", () -> "bar");
*
* }).map(v -> "foo or bar");
* }
* }</pre>
*
* You can apply a {@link Mapper} to specific return type:
*
* <pre>{@code
* {
* with(() -> {
* get("/str", () -> "str");
*
* get("/int", () -> 1);
*
* }).map(String v -> "{" + v + "}");
* }
* }</pre>
*
* A call to <code>/str</code> produces <code>{str}</code>, while <code>/int</code> just
* <code>1</code>.
*
* <strong>NOTE</strong>: You can apply the map operator to routes that produces an output.
*
* For example, the map operator will be silently ignored here:
*
* <pre>{@code
* {
* get("/", (req, rsp) -> {
* rsp.send(...);
* }).map(v -> ..);
* }
* }</pre>
*
* @author edgar
* @param <T> Type to map.
*/
interface Mapper<T> {
/**
* Produces a new mapper by combining the two mapper into one.
*
* @param it The first mapper to apply.
* @param next The second mapper to apply.
* @return A new mapper.
*/
@SuppressWarnings({"rawtypes", "unchecked"})
@Nonnull
static Mapper<Object> chain(final Mapper it, final Mapper next) {
return create(it.name() + ">" + next.name(), v -> next.map(it.map(v)));
}
/**
* Creates a new named mapper (just syntax suggar for creating a new mapper).
*
* @param name Mapper's name.
* @param fn Map function.
* @param <T> Value type.
* @return A new mapper.
*/
@Nonnull
static <T> Mapper<T> create(final String name, final Throwing.Function<T, Object> fn) {
return new Route.Mapper<T>() {
@Override
public String name() {
return name;
}
@Override
public Object map(final T value) throws Throwable {
return fn.apply(value);
}
@Override
public String toString() {
return name();
}
};
}
/**
* @return Mapper's name.
*/
@Nonnull
default String name() {
String name = Optional.ofNullable(Strings.emptyToNull(getClass().getSimpleName()))
.orElseGet(() -> {
String classname = getClass().getName();
return classname.substring(classname.lastIndexOf('.') + 1);
});
return CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_HYPHEN, name);
}
/**
* Map the type to something else.
*
* @param value Value to map.
* @return Mapped value.
* @throws Throwable If mapping fails.
*/
@Nonnull
Object map(T value) throws Throwable;
}
/**
* Common route properties, like static and global metadata via attributes, path exclusion,
* produces and consumes types.
*
* @author edgar
* @since 1.0.0.CR
* @param <T> Attribute subtype.
*/
interface Props<T extends Props<T>> {
/**
* Set route attribute. Only primitives, string, class, enum or array of previous types are
* allowed as attributes values.
*
* @param name Attribute's name.
* @param value Attribute's value.
* @return This instance.
*/
@Nonnull
T attr(String name, Object value);
/**
* Tell jooby what renderer should use to render the output.
*
* @param name A renderer's name.
* @return This instance.
*/
@Nonnull
T renderer(final String name);
/**
* Explicit renderer to use or <code>null</code>.
*
* @return Explicit renderer to use or <code>null</code>.
*/
@Nullable
String renderer();
/**
* Set the route name. Route's name, helpful for debugging but also to implement dynamic and
* advanced routing. See {@link Route.Chain#next(String, Request, Response)}
*
*
* @param name A route's name.
* @return This instance.
*/
@Nonnull
T name(final String name);
/**
* Set the media types the route can consume.
*
* @param consumes The media types to test for.
* @return This instance.
*/
@Nonnull
default T consumes(final MediaType... consumes) {
return consumes(Arrays.asList(consumes));
}
/**
* Set the media types the route can consume.
*
* @param consumes The media types to test for.
* @return This instance.
*/
@Nonnull
default T consumes(final String... consumes) {
return consumes(MediaType.valueOf(consumes));
}
/**
* Set the media types the route can consume.
*
* @param consumes The media types to test for.
* @return This instance.
*/
@Nonnull
T consumes(final List<MediaType> consumes);
/**
* Set the media types the route can produces.
*
* @param produces The media types to test for.
* @return This instance.
*/
@Nonnull
default T produces(final MediaType... produces) {
return produces(Arrays.asList(produces));
}
/**
* Set the media types the route can produces.
*
* @param produces The media types to test for.
* @return This instance.
*/
@Nonnull
default T produces(final String... produces) {
return produces(MediaType.valueOf(produces));
}
/**
* Set the media types the route can produces.
*
* @param produces The media types to test for.
* @return This instance.
*/
@Nonnull
T produces(final List<MediaType> produces);
/**
* Excludes one or more path pattern from this route, useful for filter:
*
* <pre>
* {
* use("*", req {@literal ->} {
* ...
* }).excludes("/logout");
* }
* </pre>
*
* @param excludes A path pattern.
* @return This instance.
*/
@Nonnull
default T excludes(final String... excludes) {
return excludes(Arrays.asList(excludes));
}
/**
* Excludes one or more path pattern from this route, useful for filter:
*
* <pre>
* {
* use("*", req {@literal ->} {
* ...
* }).excludes("/logout");
* }
* </pre>
*
* @param excludes A path pattern.
* @return This instance.
*/
@Nonnull
T excludes(final List<String> excludes);
@Nonnull
T map(Mapper<?> mapper);
}
/**
* Group one ore more routes under a base path, see {@link Router#use(String)}.
*
* @author edgar
* @deprecated Replaced by {@link Router#path(String, Runnable)}.
*/
@Deprecated class Group implements Props<Group> {
/** List of definitions. */
private List<Route.Definition> routes = new ArrayList<>();
private String rootPattern;
private String prefix;
private String renderer;
public Group(final String pattern, final String prefix) {
requireNonNull(pattern, "Pattern is required.");
this.rootPattern = pattern;
this.prefix = prefix;
}
public Group(final String pattern) {
this(pattern, null);
}
@Override
public String renderer() {
return renderer;
}
@Override
public Group renderer(final String name) {
this.renderer = name;
return this;
}
public List<Route.Definition> routes() {
return routes;
}
// ********************************************************************************************
// ALL
// ********************************************************************************************
@Nonnull
public Group all(final String pattern, final Route.Filter filter) {
newRoute("*", pattern, filter);
return this;
}
@Nonnull
public Group all(final String pattern, final Route.Handler handler) {
newRoute("*", pattern, handler);
return this;
}
@Nonnull
public Group all(final String pattern, final Route.OneArgHandler handler) {
newRoute("*", pattern, handler);
return this;
}
@Nonnull
public Group all(final String pattern, final Route.ZeroArgHandler handler) {
newRoute("*", pattern, handler);
return this;
}
@Nonnull
public Group all(final Route.Filter filter) {
newRoute("*", "", filter);
return this;
}
@Nonnull
public Group all(final Route.Handler handler) {
newRoute("*", "", handler);
return this;
}
@Nonnull
public Group all(final Route.OneArgHandler handler) {
newRoute("*", "", handler);
return this;
}
@Nonnull
public Group all(final Route.ZeroArgHandler handler) {
newRoute("*", "", handler);
return this;
}
// ********************************************************************************************
// GET
// ********************************************************************************************
@Nonnull
public Group get(final String pattern, final Route.Filter filter) {
newRoute(GET, pattern, filter);
return this;
}
@Nonnull
public Group get(final String pattern, final Route.Handler handler) {
newRoute(GET, pattern, handler);
return this;
}
@Nonnull
public Group get(final String pattern, final Route.OneArgHandler handler) {
newRoute(GET, pattern, handler);
return this;
}
@Nonnull
public Group get(final String pattern, final Route.ZeroArgHandler handler) {
newRoute(GET, pattern, handler);
return this;
}
@Nonnull
public Group get(final Route.Filter filter) {
newRoute(GET, "", filter);
return this;
}
@Nonnull
public Group get(final Route.Handler handler) {
newRoute(GET, "", handler);
return this;
}
@Nonnull
public Group get(final Route.OneArgHandler handler) {
newRoute(GET, "", handler);
return this;
}
@Nonnull
public Group get(final Route.ZeroArgHandler handler) {
newRoute(GET, "", handler);
return this;
}
// ********************************************************************************************
// POST
// ********************************************************************************************
@Nonnull
public Group post(final String pattern, final Route.Filter filter) {
newRoute(POST, pattern, filter);
return this;
}
@Nonnull
public Group post(final String pattern, final Route.Handler handler) {
newRoute(POST, pattern, handler);
return this;
}
@Nonnull
public Group post(final String pattern, final Route.OneArgHandler handler) {
newRoute(POST, pattern, handler);
return this;
}
@Nonnull
public Group post(final String pattern, final Route.ZeroArgHandler handler) {
newRoute(POST, pattern, handler);
return this;
}
@Nonnull
public Group post(final Route.Filter filter) {
newRoute(POST, "", filter);
return this;
}
@Nonnull
public Group post(final Route.Handler handler) {
newRoute(POST, "", handler);
return this;
}
@Nonnull
public Group post(final Route.OneArgHandler handler) {
newRoute(POST, "", handler);
return this;
}
@Nonnull
public Group post(final Route.ZeroArgHandler handler) {
newRoute(POST, "", handler);
return this;
}
// ********************************************************************************************
// PUT
// ********************************************************************************************
@Nonnull
public Group put(final String pattern, final Route.Filter filter) {
newRoute(PUT, pattern, filter);
return this;
}
@Nonnull
public Group put(final String pattern, final Route.Handler handler) {
newRoute(PUT, pattern, handler);
return this;
}
@Nonnull
public Group put(final String pattern, final Route.OneArgHandler handler) {
newRoute(PUT, pattern, handler);
return this;
}
@Nonnull
public Group put(final String pattern, final Route.ZeroArgHandler handler) {
newRoute(PUT, pattern, handler);
return this;
}
@Nonnull
public Group put(final Route.Filter filter) {
newRoute(PUT, "", filter);
return this;
}
@Nonnull
public Group put(final Route.Handler handler) {
newRoute(PUT, "", handler);
return this;
}
@Nonnull
public Group put(final Route.OneArgHandler handler) {
newRoute(PUT, "", handler);
return this;
}
@Nonnull
public Group put(final Route.ZeroArgHandler handler) {
newRoute(PUT, "", handler);
return this;
}
// ********************************************************************************************
// DELETE
// ********************************************************************************************
@Nonnull
public Group delete(final String pattern, final Route.Filter filter) {
newRoute(DELETE, pattern, filter);
return this;
}
@Nonnull
public Group delete(final String pattern, final Route.Handler handler) {
newRoute(DELETE, pattern, handler);
return this;
}
@Nonnull
public Group delete(final String pattern, final Route.OneArgHandler handler) {
newRoute(DELETE, pattern, handler);
return this;
}