-
Notifications
You must be signed in to change notification settings - Fork 502
/
AbstractConfigurableTemplateResolver.java
executable file
·1095 lines (939 loc) · 37.1 KB
/
AbstractConfigurableTemplateResolver.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
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
/*
* =============================================================================
*
* Copyright (c) 2011-2018, The THYMELEAF team (http://www.thymeleaf.org)
*
* 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.thymeleaf.templateresolver;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import org.thymeleaf.IEngineConfiguration;
import org.thymeleaf.cache.AlwaysValidCacheEntryValidity;
import org.thymeleaf.cache.ICacheEntryValidity;
import org.thymeleaf.cache.NonCacheableCacheEntryValidity;
import org.thymeleaf.cache.TTLCacheEntryValidity;
import org.thymeleaf.templatemode.TemplateMode;
import org.thymeleaf.templateresource.ITemplateResource;
import org.thymeleaf.util.ContentTypeUtils;
import org.thymeleaf.util.PatternSpec;
import org.thymeleaf.util.StringUtils;
import org.thymeleaf.util.Validate;
/**
* <p>
* Abstract implementation of {@link ITemplateResolver} extending {@link AbstractTemplateResolver}
* and providing a large set of methods for configuring resource name (from template name), template mode,
* cache validity and character encoding.
* </p>
* <p>
* Unless overriden, this class will always apply the following validity to
* template resolutions:
* </p>
* <ul>
* <li>If not cacheable: {@link NonCacheableCacheEntryValidity}.</li>
* <li>If cacheable and TTL not set: {@link AlwaysValidCacheEntryValidity}.</li>
* <li>If cacheable and TTL set: {@link TTLCacheEntryValidity}.</li>
* </ul>
*
* @author Daniel Fernández
*
* @since 3.0.0
*
*/
public abstract class AbstractConfigurableTemplateResolver extends AbstractTemplateResolver {
/**
* <p>
* Default template mode: {@link TemplateMode#HTML}
* </p>
*/
public static final TemplateMode DEFAULT_TEMPLATE_MODE = TemplateMode.HTML;
/**
* <p>
* Default value for the <i>cacheable</i> flag: {@value}.
* </p>
*/
public static final boolean DEFAULT_CACHEABLE = true;
/**
* <p>
* Default value for the cache TTL: null. This means the parsed template will live in
* cache until removed by LRU (because of being the oldest entry).
* </p>
*/
public static final Long DEFAULT_CACHE_TTL_MS = null;
private String prefix = null;
private String suffix = null;
private boolean forceSuffix = false;
private String characterEncoding = null;
private TemplateMode templateMode = DEFAULT_TEMPLATE_MODE;
private boolean forceTemplateMode = false;
private boolean cacheable = DEFAULT_CACHEABLE;
private Long cacheTTLMs = DEFAULT_CACHE_TTL_MS;
private final HashMap<String,String> templateAliases = new HashMap<String, String>(8);
private final PatternSpec xmlTemplateModePatternSpec = new PatternSpec();
private final PatternSpec htmlTemplateModePatternSpec = new PatternSpec();
private final PatternSpec textTemplateModePatternSpec = new PatternSpec();
private final PatternSpec javaScriptTemplateModePatternSpec = new PatternSpec();
private final PatternSpec cssTemplateModePatternSpec = new PatternSpec();
private final PatternSpec rawTemplateModePatternSpec = new PatternSpec();
private final PatternSpec cacheablePatternSpec = new PatternSpec();
private final PatternSpec nonCacheablePatternSpec = new PatternSpec();
public AbstractConfigurableTemplateResolver() {
super();
}
/**
* <p>
* Returns the (optional) prefix to be added to all template names in order
* to convert <i>template names</i> into <i>resource names</i>.
* </p>
*
* @return the prefix.
*/
public final String getPrefix() {
return this.prefix;
}
/**
* <p>
* Sets a new (optional) prefix to be added to all template names in order
* to convert <i>template names</i> into <i>resource names</i>.
* </p>
*
* @param prefix the prefix to be set.
*/
public final void setPrefix(final String prefix) {
this.prefix = prefix;
}
/**
* <p>
* Returns the (optional) suffix to be added to all template names in order
* to convert <i>template names</i> into <i>resource names</i>.
* </p>
* <p>
* Note that this suffix may not be applied to the template name if the template name
* already ends in a known file name suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}. If this behaviour needs to be overridden so
* that suffix is always applied, the {@link #setForceSuffix(boolean)} will need to be set.
* </p>
*
* @return the suffix.
*/
public final String getSuffix() {
return this.suffix;
}
/**
* <p>
* Sets a new (optional) suffix to be added to all template names in order
* to convert <i>template names</i> into <i>resource names</i>.
* </p>
* <p>
* Note that this suffix may not be applied to the template name if the template name
* already ends in a known file name suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}. If this behaviour needs to be overridden so
* that suffix is always applied, the {@link #setForceSuffix(boolean)} will need to be set.
* </p>
*
* @param suffix the suffix to be set.
*/
public final void setSuffix(final String suffix) {
this.suffix = suffix;
}
/**
* <p>
* Returns whether the application of the suffix should be forced on the template
* name.
* </p>
* <p>
* When forced, suffix will be appended to the template name even if the template
* name ends in a known suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}.
* </p>
* <p>Default value is <b>{@code false}</b></p>.
*
* @return whether the suffix will be forced or not.
* @since 3.0.6
*/
public final boolean getForceSuffix() {
return this.forceSuffix;
}
/**
* <p>
* Sets whether the application of the suffix should be forced on the template
* name.
* </p>
* <p>
* When forced, suffix will be appended to the template name even if the template
* name ends in a known suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}.
* </p>
* <p>Default value is <b>{@code false}</b></p>.
*
* @param forceSuffix whether the suffix should be forced or not.
* @since 3.0.6
*/
public final void setForceSuffix(final boolean forceSuffix) {
this.forceSuffix = forceSuffix;
}
/**
* <p>
* Returns the character encoding to be used for reading template resources
* resolved by this template resolver.
* </p>
*
* @return the character encoding.
*/
public final String getCharacterEncoding() {
return this.characterEncoding;
}
/**
* <p>
* Sets a new character encoding for reading template resources.
* </p>
*
* @param characterEncoding the character encoding to be used.
*/
public final void setCharacterEncoding(final String characterEncoding) {
this.characterEncoding = characterEncoding;
}
/**
* <p>
* Returns the template mode to be applied to templates resolved by
* this template resolver.
* </p>
* <p>
* If <i>template mode patterns</i> (see {@link #setHtmlTemplateModePatterns(Set)},
* {@link #setXmlTemplateModePatterns(Set)}, etc.) are also set, they have higher
* priority than the template mode set here (this would act as a <i>default</i>).
* </p>
* <p>
* Note that this template mode also may not be applied if the template resource name
* ends in a known file name suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}. If this behaviour needs to be overridden so
* that template name is always applied, the {@link #setForceTemplateMode(boolean)} will need to be set.
* </p>
*
* @return the template mode to be used.
*/
public final TemplateMode getTemplateMode() {
return this.templateMode;
}
/**
* <p>
* Sets the template mode to be applied to templates resolved by this resolver.
* </p>
* <p>
* If <i>template mode patterns</i> (see {@link #setHtmlTemplateModePatterns(Set)},
* {@link #setXmlTemplateModePatterns(Set)}, etc.) are also set, they have higher
* priority than the template mode set here (this would act as a <i>default</i>).
* </p>
* <p>
* Note that this template mode also may not be applied if the template resource name
* ends in a known file name suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}. If this behaviour needs to be overridden so
* that template name is always applied, the {@link #setForceTemplateMode(boolean)} will need to be set.
* </p>
*
* @param templateMode the template mode.
*/
public final void setTemplateMode(final TemplateMode templateMode) {
Validate.notNull(templateMode, "Cannot set a null template mode value");
this.templateMode = templateMode;
}
/**
* <p>
* Sets the template mode to be applied to templates resolved by this resolver.
* </p>
* <p>
* Allowed templates modes are defined by the {@link TemplateMode} class.
* </p>
* <p>
* If <i>template mode patterns</i> (see {@link #setHtmlTemplateModePatterns(Set)},
* {@link #setXmlTemplateModePatterns(Set)}, etc.) are also set, they have higher
* priority than the template mode set here (this would act as a <i>default</i>).
* </p>
* <p>
* Note that this template mode also may not be applied if the template resource name
* ends in a known file name suffix: {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}. If this behaviour needs to be overridden so
* that template name is always applied, the {@link #setForceTemplateMode(boolean)} will need to be set.
* </p>
*
* @param templateMode the template mode.
*/
public final void setTemplateMode(final String templateMode) {
// Setter overload actually goes against the JavaBeans spec, but having this one is good for legacy
// compatibility reasons. Besides, given the getter returns TemplateMode, intelligent frameworks like
// Spring will recognized the property as TemplateMode-typed and simply ignore this setter.
Validate.notNull(templateMode, "Cannot set a null template mode value");
this.templateMode = TemplateMode.parse(templateMode);
}
/**
* <p>
* Returns whether the configured template mode should be forced instead of attempting
* a <em>smart</em> template mode resolution based on template resource name.
* </p>
* <p>
* When forced, the configured template mode ({@link #setTemplateMode(TemplateMode)} will
* be applied even if the template resource name ends in a known suffix:
* {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}.
* </p>
* <p>Default value is <b>{@code false}</b></p>.
*
* @return whether the suffix will be forced or not.
* @since 3.0.6
*/
public final boolean getForceTemplateMode() {
return this.forceTemplateMode;
}
/**
* <p>
* Sets whether the configured template mode should be forced instead of attempting
* a <em>smart</em> template mode resolution based on template resource name.
* </p>
* <p>
* When forced, the configured template mode ({@link #setTemplateMode(TemplateMode)} will
* be applied even if the template resource name ends in a known suffix:
* {@code .html}, {@code .htm}, {@code .xhtml},
* {@code .xml}, {@code .js}, {@code .json},
* {@code .css}, {@code .rss}, {@code .atom}, {@code .txt}.
* </p>
* <p>Default value is <b>{@code false}</b></p>.
*
* @param forceTemplateMode whether the configured template mode should be forced or not.
* @since 3.0.6
*/
public final void setForceTemplateMode(final boolean forceTemplateMode) {
this.forceTemplateMode = forceTemplateMode;
}
/**
* <p>
* Returns whether templates resolved by this resolver have to be considered
* cacheable or not.
* </p>
* <p>
* If <i>cacheable patterns</i> (see {@link #setCacheablePatterns(Set)})
* are also set, they have higher priority than the value set here (this
* would act as a <i>default</i>).
* </p>
*
* @return whether templates resolved are cacheable or not.
*/
public final boolean isCacheable() {
return this.cacheable;
}
/**
* <p>
* Sets a new value for the <i>cacheable</i> flag.
* </p>
* <p>
* If <i>cacheable patterns</i> (see {@link #setCacheablePatterns(Set)})
* are also set, they have higher priority than the value set here (this
* would act as a <i>default</i>).
* </p>
*
* @param cacheable whether resolved patterns should be considered cacheable or not.
*/
public final void setCacheable(final boolean cacheable) {
this.cacheable = cacheable;
}
/**
* <p>
* Returns the TTL (Time To Live) in cache of templates resolved by this
* resolver.
* </p>
* <p>
* If a template is resolved as <i>cacheable</i> but cache TTL is null,
* this means the template will live in cache until evicted by LRU
* (Least Recently Used) algorithm for being the oldest entry in cache.
* </p>
*
* @return the cache TTL for resolved templates.
*/
public final Long getCacheTTLMs() {
return this.cacheTTLMs;
}
/**
* <p>
* Sets a new value for the cache TTL for resolved templates.
* </p>
* <p>
* If a template is resolved as <i>cacheable</i> but cache TTL is null,
* this means the template will live in cache until evicted by LRU
* (Least Recently Used) algorithm for being the oldest entry in cache.
* </p>
*
* @param cacheTTLMs the new cache TTL, or null for using natural LRU eviction.
*/
public final void setCacheTTLMs(final Long cacheTTLMs) {
this.cacheTTLMs = cacheTTLMs;
}
/**
* <p>
* Returns the currently configured template aliases.
* </p>
* <p>
* Template aliases allow the use of several (and probably shorter)
* names for templates.
* </p>
* <p>
* Aliases are applied to template names <b>before</b> prefix/suffix.
* </p>
*
* @return the map of template aliases.
*/
public final Map<String, String> getTemplateAliases() {
return Collections.unmodifiableMap(this.templateAliases);
}
/**
* <p>
* Sets all the new template aliases to be used.
* </p>
* <p>
* Template aliases allow the use of several (and probably shorter)
* names for templates.
* </p>
* <p>
* Aliases are applied to template names <b>before</b> prefix/suffix.
* </p>
*
* @param templateAliases the new template aliases.
*/
public final void setTemplateAliases(final Map<String,String> templateAliases) {
if (templateAliases != null) {
this.templateAliases.putAll(templateAliases);
}
}
/**
* <p>
* Adds a new template alias to the currently configured ones.
* </p>
*
* @param alias the new alias name
* @param templateName the name of the template the alias will be applied to
*/
public final void addTemplateAlias(final String alias, final String templateName) {
Validate.notNull(alias, "Alias cannot be null");
Validate.notNull(templateName, "Template name cannot be null");
this.templateAliases.put(alias, templateName);
}
/**
* <p>
* Removes all currently configured template aliases.
* </p>
*/
public final void clearTemplateAliases() {
this.templateAliases.clear();
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#XML}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
*/
public final PatternSpec getXmlTemplateModePatternSpec() {
return this.xmlTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#XML}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getXmlTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
*/
public final Set<String> getXmlTemplateModePatterns() {
return this.xmlTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#XML}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getXmlTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newXmlTemplateModePatterns the new patterns
*/
public final void setXmlTemplateModePatterns(final Set<String> newXmlTemplateModePatterns) {
this.xmlTemplateModePatternSpec.setPatterns(newXmlTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#HTML}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final PatternSpec getHtmlTemplateModePatternSpec() {
return this.htmlTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#HTML}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getHtmlTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final Set<String> getHtmlTemplateModePatterns() {
return this.htmlTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#HTML}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getHtmlTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newHtmlTemplateModePatterns the new patterns
* @since 3.0.0
*/
public final void setHtmlTemplateModePatterns(final Set<String> newHtmlTemplateModePatterns) {
this.htmlTemplateModePatternSpec.setPatterns(newHtmlTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#JAVASCRIPT}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final PatternSpec getJavaScriptTemplateModePatternSpec() {
return this.javaScriptTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#JAVASCRIPT}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getJavaScriptTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final Set<String> getJavaScriptTemplateModePatterns() {
return this.javaScriptTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#JAVASCRIPT}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getJavaScriptTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newJavaScriptTemplateModePatterns the new patterns
* @since 3.0.0
*/
public final void setJavaScriptTemplateModePatterns(final Set<String> newJavaScriptTemplateModePatterns) {
this.javaScriptTemplateModePatternSpec.setPatterns(newJavaScriptTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#CSS}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final PatternSpec getCSSTemplateModePatternSpec() {
return this.cssTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#CSS}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getCSSTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final Set<String> getCSSTemplateModePatterns() {
return this.cssTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#CSS}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getCSSTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newCSSTemplateModePatterns the new patterns
* @since 3.0.0
*/
public final void setCSSTemplateModePatterns(final Set<String> newCSSTemplateModePatterns) {
this.cssTemplateModePatternSpec.setPatterns(newCSSTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#RAW}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final PatternSpec getRawTemplateModePatternSpec() {
return this.rawTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#RAW}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getRawTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final Set<String> getRawTemplateModePatterns() {
return this.rawTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#RAW}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getRawTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newRawTemplateModePatterns the new patterns
* @since 3.0.0
*/
public final void setRawTemplateModePatterns(final Set<String> newRawTemplateModePatterns) {
this.rawTemplateModePatternSpec.setPatterns(newRawTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing the {@link TemplateMode#TEXT}
* template mode to resolved templates.
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final PatternSpec getTextTemplateModePatternSpec() {
return this.textTemplateModePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> specified for establishing the {@link TemplateMode#TEXT}
* template mode to resolved templates.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getTextTemplateModePatternSpec()}.getPatterns()
* </p>
*
* @return the pattern spec
* @since 3.0.0
*/
public final Set<String> getTextTemplateModePatterns() {
return this.textTemplateModePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing the {@link TemplateMode#TEXT}
* template mode as Strings.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getTextTemplateModePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param newTextTemplateModePatterns the new patterns
* @since 3.0.0
*/
public final void setTextTemplateModePatterns(final Set<String> newTextTemplateModePatterns) {
this.textTemplateModePatternSpec.setPatterns(newTextTemplateModePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing which
* templates have to be considered <i>cacheable</i>.
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
*
* @return the pattern spec
*/
public final PatternSpec getCacheablePatternSpec() {
return this.cacheablePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> (as String) specified for establishing which
* templates have to be considered <i>cacheable</i>.
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getCacheablePatternSpec()}.getPatterns()
* </p>
*
* @return the patterns
*/
public final Set<String> getCacheablePatterns() {
return this.cacheablePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing which
* templates have to be considered <i>cacheable</i>
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getCacheablePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param cacheablePatterns the new patterns
*/
public final void setCacheablePatterns(final Set<String> cacheablePatterns) {
this.cacheablePatternSpec.setPatterns(cacheablePatterns);
}
/**
* <p>
* Returns the <i>pattern spec</i> specified for establishing which
* templates have to be considered <i>non cacheable</i>.
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
*
* @return the pattern spec
*/
public final PatternSpec getNonCacheablePatternSpec() {
return this.nonCacheablePatternSpec;
}
/**
* <p>
* Returns the <i>patterns</i> (as String) specified for establishing which
* templates have to be considered <i>non cacheable</i>.
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getNonCacheablePatternSpec()}.getPatterns()
* </p>
*
* @return the patterns
*/
public final Set<String> getNonCacheablePatterns() {
return this.nonCacheablePatternSpec.getPatterns();
}
/**
* <p>
* Sets the new <i>patterns</i> to be applied for establishing which
* templates have to be considered <i>non cacheable</i>
* </p>
* <p>
* These patterns have higher precedence than the <i>cacheable</i>
* flag (see {@link #setCacheable(boolean)}). Such flag can be considered
* a <i>default value</i> after <i>cacheable patterns</i> and
* <i>non-cacheable patterns</i> have been applied.
* </p>
* <p>
* This is a convenience method equivalent to {@link #getNonCacheablePatternSpec()}.setPatterns(Set<String>)
* </p>
*
* @param nonCacheablePatterns the new patterns
*/
public final void setNonCacheablePatterns(final Set<String> nonCacheablePatterns) {
this.nonCacheablePatternSpec.setPatterns(nonCacheablePatterns);
}
/**
* <p>
* Computes the resource name that will be used for resolving, from the template name and other
* parameters configured at this <em>configurable</em> resolver.
* </p>
* <p>
* This method can be overridden by subclasses that need to modify the standard way in which the
* name of the template resource is computed by default before passing it to the real resource
* resolution mechanism (in method {@link #computeTemplateResource(IEngineConfiguration, String, String, String, String, Map)}
* </p>
* <p>
* By default, the resource name will be created by first applying the <em>template aliases</em>, and then
* adding <em>prefix</em> and <em>suffix</em> to the specified <em>template</em> (template name).
* </p>
*
* @param configuration the engine configuration in use.
* @param ownerTemplate the owner template, if the resource being computed is a fragment. Might be null.
* @param template the template (normally the template name, except for String templates).
* @param prefix the prefix to be applied.
* @param suffix the suffix to be applied.
* @param forceSuffix whether the suffix should be forced or not.
* @param templateAliases the template aliases map.
* @param templateResolutionAttributes the template resolution attributes, if any. Might be null.
* @return the resource name that should be used for resolving
* @since 3.0.6
*/
protected String computeResourceName(
final IEngineConfiguration configuration, final String ownerTemplate, final String template,
final String prefix, final String suffix, final boolean forceSuffix,
final Map<String, String> templateAliases, final Map<String, Object> templateResolutionAttributes) {
Validate.notNull(template, "Template name cannot be null");
String unaliasedName = templateAliases.get(template);
if (unaliasedName == null) {
unaliasedName = template;
}
final boolean hasPrefix = !StringUtils.isEmptyOrWhitespace(prefix);
final boolean hasSuffix = !StringUtils.isEmptyOrWhitespace(suffix);
final boolean shouldApplySuffix =
hasSuffix && (forceSuffix || !ContentTypeUtils.hasRecognizedFileExtension(unaliasedName));
if (!hasPrefix && !shouldApplySuffix){
return unaliasedName;
}
if (!hasPrefix) { // shouldApplySuffix
return unaliasedName + suffix;
}
if (!shouldApplySuffix) { // hasPrefix
return prefix + unaliasedName;
}
// hasPrefix && shouldApplySuffix
return prefix + unaliasedName + suffix;
}
@Override
protected TemplateMode computeTemplateMode(
final IEngineConfiguration configuration, final String ownerTemplate,
final String template, final Map<String, Object> templateResolutionAttributes) {
if (this.xmlTemplateModePatternSpec.matches(template)) {