This repository was archived by the owner on May 11, 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
1029 lines (918 loc) · 24.7 KB
/
Copy pathRoute.java
File metadata and controls
1029 lines (918 loc) · 24.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
/**
* Jooby https://jooby.io
* Apache License Version 2.0 https://jooby.io/LICENSE.txt
* Copyright 2014 Edgar Espina
*/
package io.jooby;
import io.jooby.annotations.Transactional;
import io.jooby.exception.MethodNotAllowedException;
import io.jooby.exception.NotAcceptableException;
import io.jooby.exception.NotFoundException;
import io.jooby.exception.UnsupportedMediaType;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.Serializable;
import java.lang.reflect.Type;
import java.util.Collection;
import java.util.Collections;
import java.util.Optional;
import java.util.Set;
import java.util.HashSet;
import java.util.Map;
import java.util.List;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.TreeMap;
import java.util.concurrent.Executor;
/**
* Route contains information about the HTTP method, path pattern, which content types consumes and
* produces, etc..
*
* Additionally, contains metadata about route return Java type, argument source (query, path, etc..) and
* Java type.
*
* This class contains all the metadata associated to a route. It is like a {@link Class} object
* for routes.
*
* @author edgar
* @since 2.0.0
*/
public class Route {
/**
* Decorates a route handler by running logic before and after route handler. This pattern is
* also known as Filter.
*
* <pre>{@code
* {
* decorator(next -> ctx -> {
* long start = System.currentTimeMillis();
* Object result = next.apply(ctx);
* long end = System.currentTimeMillis();
* System.out.println("Took: " + (end - start));
* return result;
* });
* }
* }</pre>
*
* @author edgar
* @since 2.0.0
*/
public interface Decorator extends Aware {
/**
* Chain the decorator within next handler.
*
* @param next Next handler.
* @return A new handler.
*/
@Nonnull Handler apply(@Nonnull Handler next);
/**
* Chain this decorator with another and produces a new decorator.
*
* @param next Next decorator.
* @return A new decorator.
*/
@Nonnull default Decorator then(@Nonnull Decorator next) {
return h -> apply(next.apply(h));
}
/**
* Chain this decorator with a handler and produces a new handler.
*
* @param next Next handler.
* @return A new handler.
*/
@Nonnull default Handler then(@Nonnull Handler next) {
return ctx -> apply(next).apply(ctx);
}
}
/**
* Decorates a handler and run logic before handler is executed.
*
* @author edgar
* @since 2.0.0
*/
public interface Before {
/**
* Execute application code before next handler.
*
* @param ctx Web context.
* @throws Exception If something goes wrong.
*/
void apply(@Nonnull Context ctx) throws Exception;
/**
* Chain this filter with next one and produces a new before filter.
*
* @param next Next decorator.
* @return A new decorator.
*/
@Nonnull default Before then(@Nonnull Before next) {
return ctx -> {
apply(ctx);
if (!ctx.isResponseStarted()) {
next.apply(ctx);
}
};
}
/**
* Chain this decorator with a handler and produces a new handler.
*
* @param next Next handler.
* @return A new handler.
*/
@Nonnull default Handler then(@Nonnull Handler next) {
return ctx -> {
apply(ctx);
if (!ctx.isResponseStarted()) {
return next.apply(ctx);
}
return ctx;
};
}
}
/**
* Execute application logic after a response has been generated by a route handler.
*
* For functional handler the value is accessible and you are able to modify the response:
*
* <pre>{@code
* {
* after((ctx, result) -> {
* // Modify response
* ctx.setResponseHeader("foo", "bar");
* // do something with value:
* log.info("{} produces {}", ctx, result);
* });
*
* get("/", ctx -> {
* return "Functional value";
* });
* }
* }</pre>
*
* For side-effect handler (direct use of send methods, outputstream, writer, etc.) you are not
* allowed to modify the response or access to the value (value is always <code>null</code>):
*
* <pre>{@code
* {
* after((ctx, result) -> {
* // Always null:
* assertNull(result);
*
* // Response started is set to: true
* assertTrue(ctx.isResponseStarted());
* });
*
* get("/", ctx -> {
* return ctx.send("Side effect");
* });
* }
* }</pre>
*
* @author edgar
* @since 2.0.0
*/
public interface After {
/**
* Chain this filter with next one and produces a new after filter.
*
* @param next Next filter.
* @return A new filter.
*/
@Nonnull default After then(@Nonnull After next) {
return (ctx, result, failure) -> {
next.apply(ctx, result, failure);
apply(ctx, result, failure);
};
}
/**
* Execute application logic on a route response.
*
* @param ctx Web context.
* @param result Response generated by route handler.
* @param failure Uncaught exception generated by route handler.
* @throws Exception If something goes wrong.
*/
void apply(@Nonnull Context ctx, @Nullable Object result, @Nullable Throwable failure)
throws Exception;
}
/**
* Listener interface for events that are run at the completion of a request/response
* cycle (i.e. when the request has been completely read, and the response has been fully
* written).
*
* At this point it is too late to modify the exchange further.
*
* Completion listeners are invoked in reverse order.
*
* @author edgar
*/
public interface Complete {
/**
* Callback method.
*
* @param ctx Read-Only web context.
* @throws Exception If something goes wrong.
*/
void apply(@Nonnull Context ctx) throws Exception;
}
public interface Aware {
/**
* Allows a handler to listen for route metadata.
*
* @param route Route metadata.
*/
default void setRoute(Route route) {
}
}
/**
* Route handler here is where the application logic lives.
*
* @author edgar
* @since 2.0.0
*/
public interface Handler extends Serializable, Aware {
/**
* Execute application code.
*
* @param ctx Web context.
* @return Route response.
* @throws Exception If something goes wrong.
*/
@Nonnull Object apply(@Nonnull Context ctx) throws Exception;
/**
* Chain this after decorator with next and produces a new decorator.
*
* @param next Next decorator.
* @return A new handler.
*/
@Nonnull default Handler then(@Nonnull After next) {
return ctx -> {
Throwable cause = null;
Object value = null;
try {
value = apply(ctx);
} catch (Throwable x) {
cause = x;
}
Object result;
try {
if (ctx.isResponseStarted()) {
result = Context.readOnly(ctx);
next.apply((Context) result, value, cause);
} else {
result = value;
next.apply(ctx, value, cause);
}
} catch (Throwable x) {
result = null;
if (cause == null) {
cause = x;
} else {
cause.addSuppressed(x);
}
}
if (cause == null) {
return result;
} else {
if (ctx.isResponseStarted()) {
return ctx;
} else {
throw SneakyThrows.propagate(cause);
}
}
};
}
}
/**
* Handler for {@link StatusCode#NOT_FOUND} responses.
*/
public static final Handler NOT_FOUND = ctx -> ctx
.sendError(new NotFoundException(ctx.getRequestPath()));
/**
* Handler for {@link StatusCode#METHOD_NOT_ALLOWED} responses.
*/
public static final Handler METHOD_NOT_ALLOWED = ctx -> {
ctx.setResetHeadersOnError(false);
// Allow header was generated by routing algorithm
if (ctx.getMethod().equals(Router.OPTIONS)) {
return ctx.send(StatusCode.OK);
} else {
List<String> allow = Optional.ofNullable(ctx.getResponseHeader("Allow"))
.map(it -> Arrays.asList(it.split(",")))
.orElseGet(Collections::emptyList);
return ctx.sendError(new MethodNotAllowedException(ctx.getMethod(), allow));
}
};
/** Handler for {@link StatusCode#NOT_ACCEPTABLE} responses. */
public static final Route.Before ACCEPT = ctx -> {
List<MediaType> produceTypes = ctx.getRoute().getProduces();
MediaType contentType = ctx.accept(produceTypes);
if (contentType == null) {
throw new NotAcceptableException(ctx.header(Context.ACCEPT).valueOrNull());
}
ctx.setDefaultResponseType(contentType);
};
/** Handler for {@link StatusCode#UNSUPPORTED_MEDIA_TYPE} responses. */
public static final Route.Before SUPPORT_MEDIA_TYPE = ctx -> {
MediaType contentType = ctx.getRequestType();
if (contentType == null) {
throw new UnsupportedMediaType(null);
}
if (!ctx.getRoute().getConsumes().stream().anyMatch(contentType::matches)) {
throw new UnsupportedMediaType(contentType.getValue());
}
};
/**
* Favicon handler as a silent 404 error.
*/
public static final Handler FAVICON = ctx -> ctx.send(StatusCode.NOT_FOUND);
private static final List EMPTY_LIST = Collections.emptyList();
private static final Map EMPTY_MAP = Collections.emptyMap();
private Map<String, MessageDecoder> decoders = EMPTY_MAP;
private final String pattern;
private final String method;
private List<String> pathKeys = EMPTY_LIST;
private Before before;
private Decorator decorator;
private Handler handler;
private After after;
private Handler pipeline;
private MessageEncoder encoder;
private Type returnType;
private Object handle;
private List<MediaType> produces = EMPTY_LIST;
private List<MediaType> consumes = EMPTY_LIST;
private Map<String, Object> attributes = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private Set<String> supportedMethod;
private String executorKey;
private List<String> tags = EMPTY_LIST;
private String summary;
private String description;
/**
* Creates a new route.
*
* @param method HTTP method.
* @param pattern Path pattern.
* @param handler Route handler.
*/
public Route(@Nonnull String method, @Nonnull String pattern, @Nonnull Handler handler) {
this.method = method.toUpperCase();
this.pattern = pattern;
this.handler = handler;
this.handle = handler;
}
/**
* Path pattern.
*
* @return Path pattern.
*/
public @Nonnull String getPattern() {
return pattern;
}
/**
* HTTP method.
*
* @return HTTP method.
*/
public @Nonnull String getMethod() {
return method;
}
/**
* Path keys.
*
* @return Path keys.
*/
public @Nonnull List<String> getPathKeys() {
return pathKeys;
}
/**
* Set path keys.
*
* @param pathKeys Path keys or empty list.
* @return This route.
*/
public @Nonnull Route setPathKeys(@Nonnull List<String> pathKeys) {
this.pathKeys = pathKeys;
return this;
}
/**
* Route handler.
*
* @return Route handler.
*/
public @Nonnull Handler getHandler() {
return handler;
}
/**
* Route pipeline.
*
* @return Route pipeline.
*/
public @Nonnull Handler getPipeline() {
if (pipeline == null) {
pipeline = computePipeline();
}
return pipeline;
}
/**
* Recreate a path pattern using the given variables.
*
* <code>reserve(/{k1}/{k2}, {"k1": ""foo", "k2": "bar"}) => /foo/bar</code>
*
* @param keys Path keys.
* @return Path.
*/
public @Nonnull String reverse(@Nonnull Map<String, Object> keys) {
return Router.reverse(getPattern(), keys);
}
/**
* Recreate a path pattern using the given variables.
*
* <code>reserve(/{k1}/{k2}, "foo", "bar") => /foo/bar</code>
*
* @param values Values.
* @return Path.
*/
public @Nonnull String reverse(Object... values) {
return Router.reverse(getPattern(), values);
}
/**
* Handler instance which might or might not be the same as {@link #getHandler()}.
*
* The handle is required to extract correct metadata.
*
* @return Handle.
*/
public @Nonnull Object getHandle() {
return handle;
}
/**
* Before pipeline or <code>null</code>.
*
* @return Before pipeline or <code>null</code>.
*/
public @Nullable Before getBefore() {
return before;
}
/**
* Set before filter.
*
* @param before Before filter.
* @return This route.
*/
public @Nonnull Route setBefore(@Nullable Before before) {
this.before = before;
return this;
}
/**
* After filter or <code>null</code>.
*
* @return After filter or <code>null</code>.
*/
public @Nullable After getAfter() {
return after;
}
/**
* Set after filter.
*
* @param after After filter.
* @return This route.
*/
public @Nonnull Route setAfter(@Nonnull After after) {
this.after = after;
return this;
}
/**
* Decorator or <code>null</code>.
*
* @return Decorator or <code>null</code>.
*/
public @Nullable Decorator getDecorator() {
return decorator;
}
/**
* Set route decorator.
*
* @param decorator Decorator.
* @return This route.
*/
public @Nonnull Route setDecorator(@Nullable Decorator decorator) {
this.decorator = decorator;
return this;
}
/**
* Set route handle instance, required when handle is different from {@link #getHandler()}.
*
* @param handle Handle instance.
* @return This route.
*/
public @Nonnull Route setHandle(@Nonnull Object handle) {
this.handle = handle;
return this;
}
/**
* Set route pipeline. This method is part of public API but isn't intended to be used by public.
*
* @param pipeline Pipeline.
* @return This routes.
*/
public @Nonnull Route setPipeline(Route.Handler pipeline) {
this.pipeline = pipeline;
return this;
}
/**
* Route encoder.
*
* @return Route encoder.
*/
public @Nonnull MessageEncoder getEncoder() {
return encoder;
}
/**
* Set encoder.
*
* @param encoder MessageEncoder.
* @return This route.
*/
public @Nonnull Route setEncoder(@Nonnull MessageEncoder encoder) {
this.encoder = encoder;
return this;
}
/**
* Return return type.
*
* @return Return type.
*/
public @Nullable Type getReturnType() {
return returnType;
}
/**
* Set route return type.
*
* @param returnType Return type.
* @return This route.
*/
public @Nonnull Route setReturnType(@Nullable Type returnType) {
this.returnType = returnType;
return this;
}
/**
* Response types (format) produces by this route. If set, we expect to find a match in the
* <code>Accept</code> header. If none matches, we send a {@link StatusCode#NOT_ACCEPTABLE}
* response.
*
* @return Immutable list of produce types.
*/
public @Nonnull List<MediaType> getProduces() {
return produces;
}
/**
* Add one or more response types (format) produces by this route.
*
* @param produces Produce types.
* @return This route.
*/
public @Nonnull Route produces(@Nonnull MediaType... produces) {
return setProduces(Arrays.asList(produces));
}
/**
* Add one or more response types (format) produces by this route.
*
* @param produces Produce types.
* @return This route.
*/
public @Nonnull Route setProduces(@Nonnull Collection<MediaType> produces) {
if (produces.size() > 0) {
if (this.produces == EMPTY_LIST) {
this.produces = new ArrayList<>();
}
produces.forEach(this.produces::add);
}
return this;
}
/**
* Request types (format) consumed by this route. If set the <code>Content-Type</code> header
* is checked against these values. If none matches we send a
* {@link StatusCode#UNSUPPORTED_MEDIA_TYPE} exception.
*
* @return Immutable list of consumed types.
*/
public @Nonnull List<MediaType> getConsumes() {
return consumes;
}
/**
* Add one or more request types (format) consumed by this route.
*
* @param consumes Consume types.
* @return This route.
*/
public @Nonnull Route consumes(@Nonnull MediaType... consumes) {
return setConsumes(Arrays.asList(consumes));
}
/**
* Add one or more request types (format) consumed by this route.
*
* @param consumes Consume types.
* @return This route.
*/
public @Nonnull Route setConsumes(@Nonnull Collection<MediaType> consumes) {
if (consumes.size() > 0) {
if (this.consumes == EMPTY_LIST) {
this.consumes = new ArrayList<>();
}
consumes.forEach(this.consumes::add);
}
return this;
}
/**
* Attributes set to this route.
*
* @return Map of attributes set to the route.
*/
public @Nonnull Map<String, Object> getAttributes() {
return attributes;
}
/**
* Retrieve value of this specific Attribute set to this route.
*
* @param name of the attribute to retrieve.
* @param <T> Generic type.
* @return value of the specific attribute.
*/
public @Nullable <T> T attribute(@Nonnull String name) {
return (T) attributes.get(name);
}
/**
* Add one or more attributes applied to this route.
*
* @param attributes .
* @return This route.
*/
public @Nonnull Route setAttributes(@Nonnull Map<String, Object> attributes) {
this.attributes.putAll(attributes);
return this;
}
/**
* Add one or more attributes applied to this route.
*
* @param name attribute name
* @param value attribute value
* @return This route.
*/
public @Nonnull Route attribute(@Nonnull String name, @Nonnull Object value) {
if (this.attributes == EMPTY_MAP) {
this.attributes = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
}
this.attributes.put(name, value);
return this;
}
/**
* MessageDecoder for given media type.
*
* @param contentType Media type.
* @return MessageDecoder.
*/
public @Nonnull MessageDecoder decoder(@Nonnull MediaType contentType) {
return decoders.getOrDefault(contentType.getValue(), MessageDecoder.UNSUPPORTED_MEDIA_TYPE);
}
/**
* Route message decoder.
*
* @return Message decoders.
*/
public @Nonnull Map<String, MessageDecoder> getDecoders() {
return decoders;
}
/**
* Set message decoders. Map key is a mime-type.
*
* @param decoders message decoder.
* @return This route.
*/
public @Nonnull Route setDecoders(@Nonnull Map<String, MessageDecoder> decoders) {
this.decoders = decoders;
return this;
}
/**
* True if route support HTTP OPTIONS.
*
* @return True if route support HTTP OPTIONS.
*/
public boolean isHttpOptions() {
return isHttpMethod(Router.OPTIONS);
}
/**
* True if route support HTTP TRACE.
*
* @return True if route support HTTP TRACE.
*/
public boolean isHttpTrace() {
return isHttpMethod(Router.TRACE);
}
/**
* True if route support HTTP HEAD.
*
* @return True if route support HTTP HEAD.
*/
public boolean isHttpHead() {
return getMethod().equals(Router.GET) && isHttpMethod(Router.HEAD);
}
/**
* Enabled or disabled HTTP Options.
*
* @param enabled Enabled or disabled HTTP Options.
* @return This route.
*/
public @Nonnull Route setHttpOptions(boolean enabled) {
addHttpMethod(enabled, Router.OPTIONS);
return this;
}
/**
* Enabled or disabled HTTP TRACE.
*
* @param enabled Enabled or disabled HTTP TRACE.
* @return This route.
*/
public @Nonnull Route setHttpTrace(boolean enabled) {
addHttpMethod(enabled, Router.TRACE);
return this;
}
/**
* Enabled or disabled HTTP HEAD.
*
* @param enabled Enabled or disabled HTTP HEAD.
* @return This route.
*/
public @Nonnull Route setHttpHead(boolean enabled) {
addHttpMethod(enabled, Router.HEAD);
return this;
}
/**
* Specify the name of the executor where the route is going to run.
* Default is <code>null</code>.
*
* @return Executor key.
*/
public @Nullable String getExecutorKey() {
return executorKey;
}
/**
* Set executor key. The route is going to use the given key to fetch an executor. Possible values
* are:
*
* - <code>null</code>: no specific executor, uses the default Jooby logic to choose one, based
* on the value of {@link ExecutionMode};
* - <code>worker</code>: use the executor provided by the server.
* - <code>arbitrary name</code>: use an named executor which as registered using
* {@link Router#executor(String, Executor)}.
*
* @param executorKey Executor key.
* @return This route.
*/
public @Nonnull Route setExecutorKey(@Nullable String executorKey) {
this.executorKey = executorKey;
return this;
}
/**
* Route tags.
*
* @return Route tags.
*/
public @Nonnull List<String> getTags() {
return tags;
}
/**
* Tag this route. Tags are used for documentation purpose from openAPI generator.
*
* @param tags Tags.
* @return This route.
*/
public @Nonnull Route setTags(@Nonnull List<String> tags) {
if (this.tags == EMPTY_LIST) {
this.tags = new ArrayList<>();
}
this.tags.addAll(tags);
return this;
}
/**
* Add a tag to this route.
*
* Tags are used for documentation purpose from openAPI generator.
*
* @param tag Tag.
* @return This route.
*/
public @Nonnull Route addTag(@Nonnull String tag) {
if (this.tags == EMPTY_LIST) {
this.tags = new ArrayList<>();
}
this.tags.add(tag);
return this;
}
/**
* Tag this route. Tags are used for documentation purpose from openAPI generator.
*
* @param tags Tags.
* @return This route.
*/
public @Nonnull Route tags(@Nonnull String... tags) {
return setTags(Arrays.asList(tags));
}
/**
* Route summary useful for documentation purpose from openAPI generator.
*
* @return Summary.
*/
public @Nullable String getSummary() {
return summary;
}
/**
* Route summary useful for documentation purpose from openAPI generator.
*
* @param summary Summary.
* @return This route.
*/
public @Nonnull Route summary(@Nullable String summary) {
return setSummary(summary);
}
/**
* Route summary useful for documentation purpose from openAPI generator.
*
* @param summary Summary.
* @return This route.
*/
public @Nonnull Route setSummary(@Nullable String summary) {
this.summary = summary;
return this;
}
/**
* Route description useful for documentation purpose from openAPI generator.
*
* @return Route description.
*/
public @Nullable String getDescription() {
return description;
}
/**
* Route description useful for documentation purpose from openAPI generator.
*
* @param description Description.
* @return This route.
*/
public @Nonnull Route setDescription(@Nullable String description) {
this.description = description;
return this;
}
/**
* Route description useful for documentation purpose from openAPI generator.
*
* @param description Description.
* @return This route.
*/
public @Nonnull Route description(@Nullable String description) {
return setDescription(description);
}
/**
* Returns whether this route is marked as transactional, or returns
* {@code defaultValue} if this route has not been marked explicitly.
*
* @param defaultValue the value to return if this route was not explicitly marked
* @return whether this route should be considered as transactional
*/
public boolean isTransactional(boolean defaultValue) {
Object attribute = attribute(Transactional.ATTRIBUTE);
if (attribute == null) {
return defaultValue;
}
if (attribute instanceof Boolean) {
return (Boolean) attribute;
}
throw new RuntimeException("Invalid value for route attribute "
+ Transactional.ATTRIBUTE + ": " + attribute);
}
@Override public String toString() {
return method + " " + pattern;
}