/
FacesLocal.java
1641 lines (1395 loc) · 49.7 KB
/
FacesLocal.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 2017 OmniFaces
*
* 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.omnifaces.util;
import static java.util.Arrays.asList;
import static java.util.Collections.unmodifiableList;
import static java.util.logging.Level.FINE;
import static javax.servlet.http.HttpServletResponse.SC_MOVED_PERMANENTLY;
import static org.omnifaces.util.Reflection.instance;
import static org.omnifaces.util.Reflection.toClassOrNull;
import static org.omnifaces.util.Servlets.formatContentDispositionHeader;
import static org.omnifaces.util.Servlets.prepareRedirectURL;
import static org.omnifaces.util.Servlets.toQueryString;
import static org.omnifaces.util.Utils.coalesce;
import static org.omnifaces.util.Utils.encodeURL;
import static org.omnifaces.util.Utils.isAnyEmpty;
import static org.omnifaces.util.Utils.isEmpty;
import static org.omnifaces.util.Utils.isOneOf;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Array;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.logging.Logger;
import javax.el.ELContext;
import javax.el.ELResolver;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.FactoryFinder;
import javax.faces.application.Application;
import javax.faces.application.ProjectStage;
import javax.faces.application.ViewHandler;
import javax.faces.component.UIViewParameter;
import javax.faces.component.UIViewRoot;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.faces.context.Flash;
import javax.faces.context.PartialViewContext;
import javax.faces.convert.Converter;
import javax.faces.event.PhaseId;
import javax.faces.lifecycle.Lifecycle;
import javax.faces.render.RenderKit;
import javax.faces.render.RenderKitFactory;
import javax.faces.validator.Validator;
import javax.faces.view.ViewDeclarationLanguage;
import javax.faces.view.ViewMetadata;
import javax.faces.view.facelets.FaceletContext;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.servlet.http.Part;
import org.omnifaces.component.ParamHolder;
import org.omnifaces.config.FacesConfigXml;
/**
* <p>
* Collection of utility methods for the JSF API that are mainly shortcuts for obtaining stuff from the provided
* {@link FacesContext} argument. In effect, it 'flattens' the hierarchy of nested objects.
* <p>
* The difference with {@link Faces} is that no one method of {@link FacesLocal} obtains the {@link FacesContext} from
* the current thread by {@link FacesContext#getCurrentInstance()}. This job is up to the caller. This is more efficient
* in situations where multiple utility methods needs to be called at the same time. Invoking
* {@link FacesContext#getCurrentInstance()} is at its own an extremely cheap operation, however as it's to be obtained
* as a {@link ThreadLocal} variable, it's during the call still blocking all other running threads for some nanoseconds
* or so.
* <p>
* Note that methods which are <strong>directly</strong> available on {@link FacesContext} instance itself, such as
* {@link FacesContext#getExternalContext()}, {@link FacesContext#getViewRoot()},
* {@link FacesContext#isValidationFailed()}, etc are not delegated by the this utility class, because it would design
* technically not make any sense to delegate a single-depth method call like follows:
* <pre>
* ExternalContext externalContext = FacesLocal.getExternalContext(facesContext);
* </pre>
* <p>
* instead of just calling it directly like follows:
* <pre>
* ExternalContext externalContext = facesContext.getExternalContext();
* </pre>
*
* <h3>Usage</h3>
* <p>
* Some examples (for the full list, check the API documentation):
* <pre>
* FacesContext context = Faces.getContext();
* User user = FacesLocal.getSessionAttribute(context, "user");
* Item item = FacesLocal.evaluateExpressionGet(context, "#{item}");
* String cookieValue = FacesLocal.getRequestCookie(context, "cookieName");
* List<Locale> supportedLocales = FacesLocal.getSupportedLocales(context);
* FacesLocal.invalidateSession(context);
* FacesLocal.redirect(context, "login.xhtml");
* </pre>
*
* @author Arjan Tijms
* @author Bauke Scholtz
* @since 1.6
* @see Servlets
*/
public final class FacesLocal {
// Constants ------------------------------------------------------------------------------------------------------
private static final Logger logger = Logger.getLogger(FacesLocal.class.getName());
private static final String DEFAULT_MIME_TYPE = "application/octet-stream";
private static final int DEFAULT_SENDFILE_BUFFER_SIZE = 10240;
private static final String ERROR_NO_VIEW = "There is no view.";
private static final String[] FACELET_CONTEXT_KEYS = {
FaceletContext.FACELET_CONTEXT_KEY, // Compiletime constant, may fail when compiled against EE6 and run on EE7.
"com.sun.faces.facelets.FACELET_CONTEXT", // JSF 2.0/2.1.
"javax.faces.FACELET_CONTEXT" // JSF 2.2.
};
// Constructors ---------------------------------------------------------------------------------------------------
private FacesLocal() {
// Hide constructor.
}
// JSF general ----------------------------------------------------------------------------------------------------
/**
* @see Faces#getServerInfo()
*/
public static String getServerInfo(FacesContext context) {
return getServletContext(context).getServerInfo();
}
/**
* @see Faces#getProjectStage()
*/
public static ProjectStage getProjectStage(FacesContext context) {
return context.getApplication().getProjectStage();
}
/**
* @see Faces#isDevelopment()
*/
public static boolean isDevelopment(FacesContext context) {
return getProjectStage(context) == ProjectStage.Development;
}
/**
* @see Faces#isSystemTest()
*/
public static boolean isSystemTest(FacesContext context) {
return getProjectStage(context) == ProjectStage.SystemTest;
}
/**
* @see Faces#isProduction()
*/
public static boolean isProduction(FacesContext context) {
return getProjectStage(context) == ProjectStage.Production;
}
/**
* @see Faces#getMapping()
*/
public static String getMapping(FacesContext context) {
ExternalContext externalContext = context.getExternalContext();
if (externalContext.getRequestPathInfo() == null) {
String path = externalContext.getRequestServletPath();
return path.substring(path.lastIndexOf('.'));
}
else {
return externalContext.getRequestServletPath();
}
}
/**
* @see Faces#isPrefixMapping()
*/
public static boolean isPrefixMapping(FacesContext context) {
return Faces.isPrefixMapping(getMapping(context));
}
/**
* @see Faces#evaluateExpressionGet(String)
*/
@SuppressWarnings("unchecked")
public static <T> T evaluateExpressionGet(FacesContext context, String expression) {
if (isEmpty(expression)) {
return null;
}
return (T) context.getApplication().evaluateExpressionGet(context, expression, Object.class);
}
/**
* @see Faces#evaluateExpressionSet(String, Object)
*/
public static void evaluateExpressionSet(FacesContext context, String expression, Object value) {
ELContext elContext = context.getELContext();
ValueExpression valueExpression = context.getApplication().getExpressionFactory()
.createValueExpression(elContext, expression, Object.class);
valueExpression.setValue(elContext, value);
}
/**
* @see Faces#resolveExpressionGet(Object, String)
*/
@SuppressWarnings("unchecked")
public static <T> T resolveExpressionGet(FacesContext context, Object base, String property) {
ELResolver elResolver = context.getApplication().getELResolver();
return (T) elResolver.getValue(context.getELContext(), base, property);
}
/**
* @see Faces#resolveExpressionSet(Object, String, Object)
*/
public static void resolveExpressionSet(FacesContext context, Object base, String property, Object value) {
ELResolver elResolver = context.getApplication().getELResolver();
elResolver.setValue(context.getELContext(), base, property, value);
}
/**
* @see Faces#getContextAttribute(String)
*/
@SuppressWarnings("unchecked")
public static <T> T getContextAttribute(FacesContext context, String name) {
return (T) context.getAttributes().get(name);
}
/**
* @see Faces#setContextAttribute(String, Object)
*/
public static void setContextAttribute(FacesContext context, String name, Object value) {
context.getAttributes().put(name, value);
}
/**
* @see Faces#createConverter(Object)
*/
public static Converter createConverter(FacesContext context, Object identifier) {
if (identifier instanceof String) {
return createConverter(context, (String) identifier);
}
else if (identifier instanceof Class) {
return createConverter(context, (Class<?>) identifier);
}
else if (identifier instanceof Converter) {
return (Converter) identifier;
}
else {
return null;
}
}
/**
* @see Faces#createConverter(String)
*/
public static Converter createConverter(FacesContext context, String identifier) {
Converter converter = context.getApplication().createConverter(identifier);
if (converter == null) {
converter = createConverter(context, toClassOrNull(identifier));
}
return converter;
}
/**
* @see Faces#createConverter(Class)
*/
public static Converter createConverter(FacesContext context, Class<?> identifier) {
if (Converter.class.isAssignableFrom(identifier)) {
return (Converter) instance(identifier);
}
else {
return context.getApplication().createConverter(identifier);
}
}
/**
* @see Faces#createValidator(Object)
*/
public static Validator createValidator(FacesContext context, Object identifier) {
if (identifier instanceof String) {
return createValidator(context, (String) identifier);
}
else if (identifier instanceof Class) {
return createValidator(context, (Class<?>) identifier);
}
else if (identifier instanceof Validator) {
return (Validator) identifier;
}
else {
return null;
}
}
/**
* @see Faces#createValidator(String)
*/
public static Validator createValidator(FacesContext context, String identifier) {
Validator validator = context.getApplication().createValidator(identifier);
if (validator == null) {
validator = createValidator(context, toClassOrNull(identifier));
}
return validator;
}
/**
* @see Faces#createValidator(Class)
*/
@SuppressWarnings("all")
public static Validator createValidator(FacesContext context, Class<?> identifier) {
if (Validator.class.isAssignableFrom(identifier)) {
return (Validator) instance(identifier);
}
else {
return null;
}
}
/**
* @see Faces#getLifecycle()
*/
public static Lifecycle getLifecycle(FacesContext context) {
return Servlets.getFacesLifecycle(getServletContext(context));
}
// JSF views ------------------------------------------------------------------------------------------------------
/**
* @see Faces#setViewRoot(String)
*/
public static void setViewRoot(FacesContext context, String viewId) {
context.setViewRoot(context.getApplication().getViewHandler().createView(context, viewId));
}
/**
* @see Faces#getViewId()
*/
public static String getViewId(FacesContext context) {
UIViewRoot viewRoot = context.getViewRoot();
return (viewRoot != null) ? viewRoot.getViewId() : null;
}
/**
* @see Faces#getViewIdWithParameters()
*/
public static String getViewIdWithParameters(FacesContext context) {
String viewId = coalesce(getViewId(context), "");
String viewParameters = toQueryString(getViewParameterMap(context));
return (viewParameters == null) ? viewId : (viewId + "?" + viewParameters);
}
/**
* @see Faces#getViewName()
*/
public static String getViewName(FacesContext context) {
String viewId = getViewId(context);
return (viewId != null) ? viewId.substring(viewId.lastIndexOf('/') + 1).split("\\.")[0] : null;
}
/**
* @see Faces#getViewDeclarationLanguage()
*/
public static ViewDeclarationLanguage getViewDeclarationLanguage(FacesContext context) {
return context.getApplication().getViewHandler().getViewDeclarationLanguage(context, context.getViewRoot().getViewId());
}
/**
* @see Faces#getRenderKit()
*/
public static RenderKit getRenderKit(FacesContext context) {
UIViewRoot view = context.getViewRoot();
String renderKitId = (view != null) ? view.getRenderKitId() : context.getApplication().getViewHandler().calculateRenderKitId(context);
return ((RenderKitFactory) FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY)).getRenderKit(context, renderKitId);
}
/**
* @see Faces#normalizeViewId(String)
*/
public static String normalizeViewId(FacesContext context, String path) {
String mapping = getMapping(context);
if (Faces.isPrefixMapping(mapping)) {
if (path.startsWith(mapping)) {
return path.substring(mapping.length());
}
}
else if (path.endsWith(mapping)) {
return path.substring(0, path.lastIndexOf('.')) + Utils.coalesce(
getInitParameter(context, ViewHandler.FACELETS_SUFFIX_PARAM_NAME), ViewHandler.DEFAULT_FACELETS_SUFFIX);
}
return path;
}
/**
* @see Faces#getViewParameters()
*/
public static Collection<UIViewParameter> getViewParameters(FacesContext context) {
UIViewRoot viewRoot = context.getViewRoot();
return (viewRoot != null) ? ViewMetadata.getViewParameters(viewRoot) : Collections.<UIViewParameter>emptyList();
}
/**
* @see Faces#getViewParameterMap()
*/
public static Map<String, List<String>> getViewParameterMap(FacesContext context) {
Collection<UIViewParameter> viewParameters = getViewParameters(context);
if (viewParameters.isEmpty()) {
return new LinkedHashMap<>(0);
}
Map<String, List<String>> parameterMap = new LinkedHashMap<>(viewParameters.size());
for (UIViewParameter viewParameter : viewParameters) {
String value = viewParameter.getStringValue(context);
if (value != null) {
// <f:viewParam> doesn't support multiple values anyway, so having multiple <f:viewParam> on the
// same request parameter shouldn't end up in repeated parameters in action URL.
parameterMap.put(viewParameter.getName(), asList(value));
}
}
return parameterMap;
}
/**
* @see Faces#getMetadataAttributes(String)
*/
public static Map<String, Object> getMetadataAttributes(FacesContext context, String viewId) {
ViewHandler viewHandler = context.getApplication().getViewHandler();
ViewDeclarationLanguage vdl = viewHandler.getViewDeclarationLanguage(context, viewId);
ViewMetadata metadata = vdl.getViewMetadata(context, viewId);
return (metadata != null)
? metadata.createMetadataView(context).getAttributes()
: Collections.<String, Object>emptyMap();
}
/**
* @see Faces#getMetadataAttributes()
*/
public static Map<String, Object> getMetadataAttributes(FacesContext context) {
return context.getViewRoot().getAttributes();
}
/**
* @see Faces#getMetadataAttribute(String, String)
*/
@SuppressWarnings("unchecked")
public static <T> T getMetadataAttribute(FacesContext context, String viewId, String name) {
return (T) getMetadataAttributes(context, viewId).get(name);
}
/**
* @see Faces#getMetadataAttribute(String)
*/
@SuppressWarnings("unchecked")
public static <T> T getMetadataAttribute(FacesContext context, String name) {
return (T) getMetadataAttributes(context).get(name);
}
/**
* @see Faces#getLocale()
*/
public static Locale getLocale(FacesContext context) {
Locale locale = null;
UIViewRoot viewRoot = context.getViewRoot();
// Prefer the locale set in the view.
if (viewRoot != null) {
locale = viewRoot.getLocale();
}
// Then the client preferred locale.
if (locale == null) {
Locale clientLocale = context.getExternalContext().getRequestLocale();
if (getSupportedLocales(context).contains(clientLocale)) {
locale = clientLocale;
}
}
// Then the JSF default locale.
if (locale == null) {
locale = context.getApplication().getDefaultLocale();
}
// Finally the system default locale.
if (locale == null) {
locale = Locale.getDefault();
}
return locale;
}
/**
* @see Faces#getDefaultLocale()
*/
public static Locale getDefaultLocale(FacesContext context) {
return context.getApplication().getDefaultLocale();
}
/**
* @see Faces#getSupportedLocales()
*/
public static List<Locale> getSupportedLocales(FacesContext context) {
Application application = context.getApplication();
List<Locale> supportedLocales = new ArrayList<>();
Locale defaultLocale = application.getDefaultLocale();
if (defaultLocale != null) {
supportedLocales.add(defaultLocale);
}
for (Iterator<Locale> iter = application.getSupportedLocales(); iter.hasNext();) {
Locale supportedLocale = iter.next();
if (!supportedLocale.equals(defaultLocale)) {
supportedLocales.add(supportedLocale);
}
}
return supportedLocales;
}
/**
* @see Faces#setLocale(Locale)
*/
public static void setLocale(FacesContext context, Locale locale) {
UIViewRoot viewRoot = context.getViewRoot();
if (viewRoot == null) {
throw new IllegalStateException(ERROR_NO_VIEW);
}
viewRoot.setLocale(locale);
}
/**
* @see Faces#getMessageBundle()
*/
public static ResourceBundle getMessageBundle(FacesContext context) {
String messageBundle = context.getApplication().getMessageBundle();
if (messageBundle == null) {
return null;
}
return ResourceBundle.getBundle(messageBundle, getLocale(context));
}
/**
* @see Faces#getResourceBundle(String)
*/
public static ResourceBundle getResourceBundle(FacesContext context, String var) {
return context.getApplication().getResourceBundle(context, var);
}
/**
* @see Faces#getResourceBundles()
*/
public static Map<String, ResourceBundle> getResourceBundles(FacesContext context) {
Map<String, String> resourceBundles = FacesConfigXml.INSTANCE.getResourceBundles();
Map<String, ResourceBundle> map = new HashMap<>(resourceBundles.size());
for (String var : resourceBundles.keySet()) {
map.put(var, getResourceBundle(context, var));
}
return map;
}
/**
* @see Faces#getBundleString(String)
*/
public static String getBundleString(FacesContext context, String key) {
for (ResourceBundle bundle : getResourceBundles(context).values()) {
try {
return bundle.getString(key);
}
catch (MissingResourceException ignore) {
logger.log(FINE, "Ignoring thrown exception; there is a fallback anyway.", ignore);
continue;
}
}
return "???" + key + "???";
}
/**
* @see Faces#navigate(String)
*/
public static void navigate(FacesContext context, String outcome) {
context.getApplication().getNavigationHandler().handleNavigation(context, null, outcome);
}
/**
* @see Faces#getBookmarkableURL(Map, boolean)
*/
public static String getBookmarkableURL
(FacesContext context, Map<String, List<String>> params, boolean includeViewParams)
{
String viewId = getViewId(context);
if (viewId == null) {
throw new IllegalStateException(ERROR_NO_VIEW);
}
return getBookmarkableURL(context, viewId, params, includeViewParams);
}
/**
* @see Faces#getBookmarkableURL(String, Map, boolean)
*/
public static String getBookmarkableURL
(FacesContext context, String viewId, Map<String, List<String>> params, boolean includeViewParams)
{
Map<String, List<String>> map = new HashMap<>();
if (params != null) {
for (Entry<String, List<String>> param : params.entrySet()) {
for (String value : param.getValue()) {
addParamToMapIfNecessary(map, param.getKey(), value);
}
}
}
return context.getApplication().getViewHandler().getBookmarkableURL(context, viewId, map, includeViewParams);
}
/**
* @see Faces#getBookmarkableURL(Collection, boolean)
*/
public static String getBookmarkableURL
(FacesContext context, Collection<? extends ParamHolder> params, boolean includeViewParams)
{
String viewId = getViewId(context);
if (viewId == null) {
throw new IllegalStateException(ERROR_NO_VIEW);
}
return getBookmarkableURL(context, viewId, params, includeViewParams);
}
/**
* @see Faces#getBookmarkableURL(String, Collection, boolean)
*/
public static String getBookmarkableURL
(FacesContext context, String viewId, Collection<? extends ParamHolder> params, boolean includeViewParams)
{
Map<String, List<String>> map = new HashMap<>();
if (params != null) {
for (ParamHolder param : params) {
addParamToMapIfNecessary(map, param.getName(), param.getValue());
}
}
return context.getApplication().getViewHandler().getBookmarkableURL(context, viewId, map, includeViewParams);
}
private static void addParamToMapIfNecessary(Map<String, List<String>> map, String name, Object value) {
if (isAnyEmpty(name, value)) {
return;
}
List<String> values = map.get(name);
if (values == null) {
values = new ArrayList<>(1);
map.put(name, values);
}
values.add(value.toString());
}
// Facelets -------------------------------------------------------------------------------------------------------
/**
* @see Faces#getFaceletContext()
*/
public static FaceletContext getFaceletContext(FacesContext context) {
Map<Object, Object> contextAttributes = context.getAttributes();
for (String key : FACELET_CONTEXT_KEYS) {
FaceletContext faceletContext = (FaceletContext) contextAttributes.get(key);
if (faceletContext != null) {
return faceletContext;
}
}
throw new IllegalStateException(ERROR_NO_VIEW);
}
/**
* @see Faces#getFaceletAttribute(String)
*/
@SuppressWarnings("unchecked")
public static <T> T getFaceletAttribute(FacesContext context, String name) {
return (T) getFaceletContext(context).getAttribute(name);
}
/**
* @see Faces#setFaceletAttribute(String, Object)
*/
public static void setFaceletAttribute(FacesContext context, String name, Object value) {
getFaceletContext(context).setAttribute(name, value);
}
// HTTP request ---------------------------------------------------------------------------------------------------
/**
* @see Faces#getRequest()
*/
public static HttpServletRequest getRequest(FacesContext context) {
return (HttpServletRequest) context.getExternalContext().getRequest();
}
/**
* @see Faces#isAjaxRequest()
*/
public static boolean isAjaxRequest(FacesContext context) {
return context.getPartialViewContext().isAjaxRequest();
}
/**
* @see Faces#isAjaxRequestWithPartialRendering()
*/
public static boolean isAjaxRequestWithPartialRendering(FacesContext context) {
PartialViewContext pvc = context.getPartialViewContext();
return pvc.isAjaxRequest() && !pvc.isRenderAll();
}
/**
* @see Faces#isPostback()
*/
public static boolean isPostback(FacesContext context) {
return "POST".equalsIgnoreCase(getRequest(context).getMethod()) && context.isPostback();
}
/**
* @see Faces#getRequestParameterMap()
*/
public static Map<String, String> getRequestParameterMap(FacesContext context) {
return context.getExternalContext().getRequestParameterMap();
}
/**
* @see Faces#getRequestParameter(String)
*/
public static String getRequestParameter(FacesContext context, String name) {
return getRequestParameterMap(context).get(name);
}
/**
* @see Faces#getRequestParameter(String, Class)
*/
@SuppressWarnings("unchecked")
public static <T> T getRequestParameter(FacesContext context, String name, Class<T> type) {
String value = getRequestParameter(context, name);
if (value == null) {
return null;
}
Converter converter = createConverter(context, type);
if (converter == null) {
return (T) value;
}
return (T) converter.getAsObject(context, context.getViewRoot(), value);
}
/**
* @see Faces#getRequestParameterValuesMap()
*/
public static Map<String, String[]> getRequestParameterValuesMap(FacesContext context) {
return context.getExternalContext().getRequestParameterValuesMap();
}
/**
* @see Faces#getRequestParameterValues(String)
*/
public static String[] getRequestParameterValues(FacesContext context, String name) {
return getRequestParameterValuesMap(context).get(name);
}
/**
* @see Faces#getRequestParameterValues(String, Class)
*/
@SuppressWarnings("unchecked")
public static <T> T[] getRequestParameterValues(FacesContext context, String name, Class<T> type) {
String[] values = getRequestParameterValues(context, name);
if (values == null) {
return null;
}
Converter converter = createConverter(context, type);
if (converter == null) {
return (T[]) values;
}
Object convertedValues = Array.newInstance(type, values.length);
for (int i = 0; i < values.length; i++) {
Array.set(convertedValues, i, converter.getAsObject(context, context.getViewRoot(), values[i]));
}
return (T[]) convertedValues;
}
/**
* @see Faces#getRequestParts()
*/
public static Collection<Part> getRequestParts(FacesContext context) {
try {
return getRequest(context).getParts();
}
catch (IOException | ServletException e) {
throw new FacesException(e);
}
}
/**
* @see Faces#getRequestPart(String)
*/
public static Part getRequestPart(FacesContext context, String name) {
try {
return getRequest(context).getPart(name);
}
catch (ServletException | IOException e) {
throw new FacesException(e);
}
}
/**
* @see Faces#getRequestParts(String)
*/
public static Collection<Part> getRequestParts(FacesContext context, String name) {
try {
List<Part> parts = new ArrayList<>();
for (Part part : getRequest(context).getParts()) {
if (name.equals(part.getName())) {
parts.add(part);
}
}
return unmodifiableList(parts);
}
catch (ServletException | IOException e) {
throw new FacesException(e);
}
}
/**
* @see Faces#getRequestHeaderMap()
*/
public static Map<String, String> getRequestHeaderMap(FacesContext context) {
return context.getExternalContext().getRequestHeaderMap();
}
/**
* @see Faces#getRequestHeader(String)
*/
public static String getRequestHeader(FacesContext context, String name) {
return getRequestHeaderMap(context).get(name);
}
/**
* @see Faces#getRequestHeaderValuesMap()
*/
public static Map<String, String[]> getRequestHeaderValuesMap(FacesContext context) {
return context.getExternalContext().getRequestHeaderValuesMap();
}
/**
* @see Faces#getRequestHeaderValues(String)
*/
public static String[] getRequestHeaderValues(FacesContext context, String name) {
return getRequestHeaderValuesMap(context).get(name);
}
/**
* @see Faces#getRequestContextPath()
*/
public static String getRequestContextPath(FacesContext context) {
return context.getExternalContext().getRequestContextPath();
}
/**
* @see Faces#getRequestServletPath()
*/
public static String getRequestServletPath(FacesContext context) {
return context.getExternalContext().getRequestServletPath();
}
/**
* @see Faces#getRequestPathInfo()
*/
public static String getRequestPathInfo(FacesContext context) {
return Servlets.getRequestPathInfo(getRequest(context));
}
/**
* @see Faces#getRequestHostname()
*/
public static String getRequestHostname(FacesContext context) {
return Servlets.getRequestHostname(getRequest(context));
}
/**
* @see Faces#getRequestBaseURL()
*/
public static String getRequestBaseURL(FacesContext context) {
return Servlets.getRequestBaseURL(getRequest(context));
}
/**
* @see Faces#getRequestDomainURL()
*/
public static String getRequestDomainURL(FacesContext context) {
return Servlets.getRequestDomainURL(getRequest(context));
}
/**
* @see Faces#getRequestURL()
*/
public static String getRequestURL(FacesContext context) {
return Servlets.getRequestURL(getRequest(context));
}
/**
* @see Faces#getRequestURI()
*/
public static String getRequestURI(FacesContext context) {
return Servlets.getRequestURI(getRequest(context));
}
/**
* @see Faces#getRequestQueryString()
*/
public static String getRequestQueryString(FacesContext context) {
return Servlets.getRequestQueryString(getRequest(context));
}
/**
* @see Faces#getRequestQueryStringMap()
*/
public static Map<String, List<String>> getRequestQueryStringMap(FacesContext context) {
return Servlets.getRequestQueryStringMap(getRequest(context));
}
/**
* @see Faces#getRequestURLWithQueryString()
*/
public static String getRequestURLWithQueryString(FacesContext context) {
return Servlets.getRequestURLWithQueryString(getRequest(context));
}