1 | |
|
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
package org.apache.myfaces.shared_impl.util; |
20 | |
|
21 | |
import java.text.MessageFormat; |
22 | |
import java.util.Locale; |
23 | |
import java.util.MissingResourceException; |
24 | |
import java.util.ResourceBundle; |
25 | |
|
26 | |
import javax.el.ValueExpression; |
27 | |
import javax.faces.FactoryFinder; |
28 | |
import javax.faces.application.Application; |
29 | |
import javax.faces.application.ApplicationFactory; |
30 | |
import javax.faces.application.FacesMessage; |
31 | |
import javax.faces.component.UIComponent; |
32 | |
import javax.faces.context.FacesContext; |
33 | |
|
34 | |
import org.apache.commons.logging.Log; |
35 | |
import org.apache.commons.logging.LogFactory; |
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
|
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
|
48 | |
|
49 | |
|
50 | |
|
51 | |
|
52 | |
public final class MessageUtils |
53 | |
{ |
54 | |
|
55 | |
private MessageUtils() |
56 | 0 | { |
57 | |
|
58 | 0 | } |
59 | |
|
60 | |
|
61 | |
private static final String DEFAULT_BUNDLE = "javax.faces.Messages"; |
62 | |
|
63 | |
|
64 | |
private static final String DETAIL_SUFFIX = "_detail"; |
65 | 0 | private static Log log = LogFactory.getLog(MessageUtils.class); |
66 | |
|
67 | |
|
68 | |
|
69 | |
|
70 | |
|
71 | |
|
72 | |
|
73 | |
|
74 | |
public static FacesMessage getMessage(FacesMessage.Severity severity, |
75 | |
String messageId, |
76 | |
Object arg) |
77 | |
{ |
78 | 0 | return getMessage(severity, |
79 | |
messageId, |
80 | |
new Object[]{arg}, |
81 | |
FacesContext.getCurrentInstance()); |
82 | |
} |
83 | |
|
84 | |
public static FacesMessage getMessage(String bundleBaseName, |
85 | |
FacesMessage.Severity severity, |
86 | |
String messageId, |
87 | |
Object arg) |
88 | |
{ |
89 | 0 | return getMessage(bundleBaseName, |
90 | |
severity, |
91 | |
messageId, |
92 | |
new Object[]{arg}, |
93 | |
FacesContext.getCurrentInstance()); |
94 | |
} |
95 | |
|
96 | |
|
97 | |
|
98 | |
|
99 | |
|
100 | |
|
101 | |
|
102 | |
|
103 | |
public static FacesMessage getMessage(FacesMessage.Severity severity, |
104 | |
String messageId, |
105 | |
Object[] args) |
106 | |
{ |
107 | 0 | return getMessage(severity, |
108 | |
messageId, |
109 | |
args, |
110 | |
FacesContext.getCurrentInstance()); |
111 | |
} |
112 | |
|
113 | |
public static FacesMessage getMessage(String bundleBaseName, |
114 | |
FacesMessage.Severity severity, |
115 | |
String messageId, |
116 | |
Object[] args) |
117 | |
{ |
118 | 0 | return getMessage(bundleBaseName, |
119 | |
severity, |
120 | |
messageId, |
121 | |
args, |
122 | |
FacesContext.getCurrentInstance()); |
123 | |
} |
124 | |
|
125 | |
public static FacesMessage getMessage(FacesMessage.Severity severity, |
126 | |
String messageId, |
127 | |
Object[] args, |
128 | |
FacesContext facesContext) |
129 | |
{ |
130 | 0 | FacesMessage message = getMessage(facesContext, messageId, args); |
131 | 0 | message.setSeverity(severity); |
132 | |
|
133 | 0 | return message; |
134 | |
} |
135 | |
|
136 | |
public static FacesMessage getMessage(String bundleBaseName, |
137 | |
FacesMessage.Severity severity, |
138 | |
String messageId, |
139 | |
Object[] args, |
140 | |
FacesContext facesContext) |
141 | |
{ |
142 | 0 | FacesMessage message = getMessage(bundleBaseName, facesContext, messageId, args); |
143 | 0 | message.setSeverity(severity); |
144 | |
|
145 | 0 | return message; |
146 | |
} |
147 | |
|
148 | |
public static void addMessage(FacesMessage.Severity severity, |
149 | |
String messageId, |
150 | |
Object[] args) |
151 | |
{ |
152 | 0 | addMessage(severity, messageId, args, null, FacesContext.getCurrentInstance()); |
153 | 0 | } |
154 | |
|
155 | |
public static void addMessage(String bundleBaseName, |
156 | |
FacesMessage.Severity severity, |
157 | |
String messageId, |
158 | |
Object[] args) |
159 | |
{ |
160 | 0 | addMessage(bundleBaseName, severity, messageId, args, null, FacesContext.getCurrentInstance()); |
161 | 0 | } |
162 | |
|
163 | |
public static void addMessage(FacesMessage.Severity severity, |
164 | |
String messageId, |
165 | |
Object[] args, |
166 | |
FacesContext facesContext) |
167 | |
{ |
168 | 0 | addMessage(severity, messageId, args, null, facesContext); |
169 | 0 | } |
170 | |
|
171 | |
public static void addMessage(String bundleBaseName, |
172 | |
FacesMessage.Severity severity, |
173 | |
String messageId, |
174 | |
Object[] args, |
175 | |
FacesContext facesContext) |
176 | |
{ |
177 | 0 | addMessage(bundleBaseName, severity, messageId, args, null, facesContext); |
178 | 0 | } |
179 | |
|
180 | |
public static void addMessage(FacesMessage.Severity severity, |
181 | |
String messageId, |
182 | |
Object[] args, |
183 | |
String forClientId) |
184 | |
{ |
185 | 0 | addMessage(severity, messageId, args, forClientId, FacesContext.getCurrentInstance()); |
186 | 0 | } |
187 | |
|
188 | |
public static void addMessage(String bundleBaseName, |
189 | |
FacesMessage.Severity severity, |
190 | |
String messageId, |
191 | |
Object[] args, |
192 | |
String forClientId) |
193 | |
{ |
194 | 0 | addMessage(bundleBaseName, severity, messageId, args, forClientId, FacesContext.getCurrentInstance()); |
195 | 0 | } |
196 | |
|
197 | |
public static void addMessage(FacesMessage.Severity severity, |
198 | |
String messageId, |
199 | |
Object[] args, |
200 | |
String forClientId, |
201 | |
FacesContext facesContext) |
202 | |
{ |
203 | 0 | if(log.isTraceEnabled()) { |
204 | 0 | log.trace("adding message " + messageId + " for clientId " + forClientId); |
205 | |
} |
206 | 0 | facesContext.addMessage(forClientId, |
207 | |
getMessage(severity, messageId, args, facesContext)); |
208 | 0 | } |
209 | |
|
210 | |
public static void addMessage(String bundleBaseName, |
211 | |
FacesMessage.Severity severity, |
212 | |
String messageId, |
213 | |
Object[] args, |
214 | |
String forClientId, |
215 | |
FacesContext facesContext) |
216 | |
{ |
217 | 0 | if(log.isTraceEnabled()) { |
218 | 0 | log.trace("adding message " + messageId + " for clientId " + forClientId); |
219 | |
} |
220 | 0 | facesContext.addMessage(forClientId, |
221 | |
getMessage(bundleBaseName, severity, messageId, args, facesContext)); |
222 | 0 | } |
223 | |
|
224 | |
|
225 | |
|
226 | |
|
227 | |
|
228 | |
|
229 | |
|
230 | |
|
231 | |
|
232 | |
public static String substituteParams(Locale locale, String msgtext, Object params[]) |
233 | |
{ |
234 | 0 | String localizedStr = null; |
235 | 0 | if(params == null || msgtext == null) |
236 | 0 | return msgtext; |
237 | |
|
238 | 0 | if(locale != null) |
239 | |
{ |
240 | 0 | MessageFormat mf = new MessageFormat(msgtext,locale); |
241 | 0 | localizedStr = mf.format(params); |
242 | |
} |
243 | 0 | return localizedStr; |
244 | |
} |
245 | |
|
246 | |
public static FacesMessage getMessage(String messageId, Object params[]) |
247 | |
{ |
248 | 0 | Locale locale = getCurrentLocale(); |
249 | 0 | return getMessage(locale, messageId, params); |
250 | |
} |
251 | |
|
252 | |
public static FacesMessage getMessageFromBundle(String bundleBaseName, String messageId, Object params[]) |
253 | |
{ |
254 | 0 | Locale locale = null; |
255 | 0 | FacesContext context = FacesContext.getCurrentInstance(); |
256 | 0 | if(context != null && context.getViewRoot() != null) |
257 | |
{ |
258 | 0 | locale = context.getViewRoot().getLocale(); |
259 | 0 | if(locale == null) |
260 | 0 | locale = Locale.getDefault(); |
261 | |
} else |
262 | |
{ |
263 | 0 | locale = Locale.getDefault(); |
264 | |
} |
265 | 0 | return getMessageFromBundle(bundleBaseName, context , locale, messageId, params); |
266 | |
} |
267 | |
|
268 | |
public static FacesMessage getMessage(Locale locale, String messageId, Object params[]) |
269 | |
{ |
270 | 0 | String summary = null; |
271 | 0 | String detail = null; |
272 | 0 | String bundleName = getApplication().getMessageBundle(); |
273 | 0 | ResourceBundle bundle = null; |
274 | |
|
275 | 0 | if (bundleName != null) |
276 | |
{ |
277 | |
try |
278 | |
{ |
279 | 0 | bundle = ResourceBundle.getBundle(bundleName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleName)); |
280 | 0 | summary = bundle.getString(messageId); |
281 | |
} |
282 | 0 | catch (MissingResourceException e) { |
283 | |
|
284 | 0 | } |
285 | |
} |
286 | |
|
287 | 0 | if (summary == null) |
288 | |
{ |
289 | |
try |
290 | |
{ |
291 | 0 | bundle = ResourceBundle.getBundle(DEFAULT_BUNDLE, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(DEFAULT_BUNDLE)); |
292 | 0 | if(bundle == null) |
293 | |
{ |
294 | 0 | throw new NullPointerException(); |
295 | |
} |
296 | 0 | summary = bundle.getString(messageId); |
297 | |
} |
298 | 0 | catch(MissingResourceException e) { |
299 | |
|
300 | 0 | } |
301 | |
} |
302 | |
|
303 | 0 | if(summary == null) |
304 | |
{ |
305 | 0 | summary = messageId; |
306 | |
} |
307 | |
|
308 | 0 | if (bundle == null) |
309 | |
{ |
310 | 0 | throw new NullPointerException( |
311 | |
"Unable to locate ResourceBundle: bundle is null"); |
312 | |
} |
313 | 0 | if (params != null && locale != null) |
314 | |
{ |
315 | |
try |
316 | |
{ |
317 | 0 | detail = bundle.getString(messageId + DETAIL_SUFFIX); |
318 | |
} |
319 | 0 | catch(MissingResourceException e) { |
320 | |
|
321 | 0 | } |
322 | 0 | return new ParametrizableFacesMessage(summary, detail, params, locale); |
323 | |
} |
324 | |
else |
325 | |
{ |
326 | 0 | summary = substituteParams(locale, summary, params); |
327 | |
try |
328 | |
{ |
329 | 0 | detail = substituteParams(locale, |
330 | |
bundle.getString(messageId + DETAIL_SUFFIX), params); |
331 | |
} |
332 | 0 | catch(MissingResourceException e) { |
333 | |
|
334 | 0 | } |
335 | 0 | return new FacesMessage(summary, detail); |
336 | |
} |
337 | |
} |
338 | |
|
339 | |
public static FacesMessage getMessageFromBundle(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object params[]) |
340 | |
{ |
341 | 0 | String summary = null; |
342 | 0 | String detail = null; |
343 | 0 | String bundleName = context.getApplication().getMessageBundle(); |
344 | 0 | ResourceBundle bundle = null; |
345 | |
|
346 | 0 | if (bundleName != null) |
347 | |
{ |
348 | |
try |
349 | |
{ |
350 | 0 | bundle = ResourceBundle.getBundle(bundleName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleName)); |
351 | 0 | summary = bundle.getString(messageId); |
352 | |
} |
353 | 0 | catch (MissingResourceException e) { |
354 | |
|
355 | 0 | } |
356 | |
} |
357 | |
|
358 | 0 | if (summary == null) |
359 | |
{ |
360 | |
try |
361 | |
{ |
362 | 0 | bundle = ResourceBundle.getBundle(bundleBaseName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleBaseName)); |
363 | 0 | if(bundle == null) |
364 | |
{ |
365 | 0 | throw new NullPointerException(); |
366 | |
} |
367 | 0 | summary = bundle.getString(messageId); |
368 | |
} |
369 | 0 | catch(MissingResourceException e) { |
370 | |
|
371 | 0 | } |
372 | |
} |
373 | |
|
374 | 0 | if (summary == null) |
375 | |
{ |
376 | |
try |
377 | |
{ |
378 | 0 | bundle = ResourceBundle.getBundle(DEFAULT_BUNDLE, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(DEFAULT_BUNDLE)); |
379 | 0 | if(bundle == null) |
380 | |
{ |
381 | 0 | throw new NullPointerException(); |
382 | |
} |
383 | 0 | summary = bundle.getString(messageId); |
384 | |
} |
385 | 0 | catch(MissingResourceException e) { |
386 | |
|
387 | 0 | } |
388 | |
} |
389 | |
|
390 | 0 | if(summary == null) |
391 | |
{ |
392 | 0 | summary = messageId; |
393 | |
} |
394 | |
|
395 | 0 | if (bundle == null) |
396 | |
{ |
397 | 0 | throw new NullPointerException( |
398 | |
"Unable to locate ResourceBundle: bundle is null"); |
399 | |
} |
400 | |
|
401 | 0 | if (params != null && locale != null) |
402 | |
{ |
403 | |
try |
404 | |
{ |
405 | 0 | detail = bundle.getString(messageId + DETAIL_SUFFIX); |
406 | |
} |
407 | 0 | catch(MissingResourceException e) { |
408 | |
|
409 | 0 | } |
410 | 0 | return new ParametrizableFacesMessage(summary, detail, params, locale); |
411 | |
} |
412 | |
else |
413 | |
{ |
414 | 0 | summary = substituteParams(locale, summary, params); |
415 | |
try |
416 | |
{ |
417 | 0 | detail = substituteParams(locale, |
418 | |
bundle.getString(messageId + DETAIL_SUFFIX), params); |
419 | |
} |
420 | 0 | catch(MissingResourceException e) { |
421 | |
|
422 | 0 | } |
423 | 0 | return new FacesMessage(summary, detail); |
424 | |
} |
425 | |
} |
426 | |
|
427 | |
|
428 | |
|
429 | |
|
430 | |
|
431 | |
|
432 | |
|
433 | |
|
434 | |
|
435 | |
|
436 | |
public static FacesMessage getMessage(String bundleBaseName, String messageId, Object params[]) |
437 | |
{ |
438 | 0 | return getMessage(bundleBaseName, getCurrentLocale(), messageId, params); |
439 | |
} |
440 | |
|
441 | |
|
442 | |
|
443 | |
|
444 | |
|
445 | |
public static Locale getCurrentLocale() { |
446 | 0 | return getCurrentLocale(FacesContext.getCurrentInstance()); |
447 | |
} |
448 | |
|
449 | |
public static Locale getCurrentLocale(FacesContext context) { |
450 | |
Locale locale; |
451 | 0 | if(context != null && context.getViewRoot() != null) |
452 | |
{ |
453 | 0 | locale = context.getViewRoot().getLocale(); |
454 | 0 | if(locale == null) |
455 | 0 | locale = Locale.getDefault(); |
456 | |
} |
457 | |
else |
458 | |
{ |
459 | 0 | locale = Locale.getDefault(); |
460 | |
} |
461 | |
|
462 | 0 | return locale; |
463 | |
} |
464 | |
|
465 | |
|
466 | |
|
467 | |
|
468 | |
|
469 | |
|
470 | |
|
471 | |
|
472 | |
public static FacesMessage getMessage(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object params[]) |
473 | |
{ |
474 | 0 | FacesMessage msg = getMessage(bundleBaseName, messageId, params); |
475 | 0 | msg.setSeverity(severity); |
476 | |
|
477 | 0 | return msg; |
478 | |
} |
479 | |
|
480 | |
|
481 | |
|
482 | |
|
483 | |
|
484 | |
|
485 | |
|
486 | |
|
487 | |
|
488 | |
|
489 | |
|
490 | |
public static FacesMessage getMessage(String bundleBaseName, Locale locale, String messageId, Object params[]) |
491 | |
{ |
492 | 0 | if (bundleBaseName == null) |
493 | |
{ |
494 | 0 | throw new NullPointerException( |
495 | |
"Unable to locate ResourceBundle: bundle is null"); |
496 | |
} |
497 | |
|
498 | 0 | ResourceBundle bundle = ResourceBundle.getBundle(bundleBaseName, locale); |
499 | |
|
500 | 0 | return getMessage(bundle, messageId, params); |
501 | |
} |
502 | |
|
503 | |
|
504 | |
|
505 | |
|
506 | |
|
507 | |
|
508 | |
public static FacesMessage getMessage(ResourceBundle bundle, String messageId, Object params[]) |
509 | |
{ |
510 | |
|
511 | 0 | String summary = null; |
512 | 0 | String detail = null; |
513 | |
|
514 | |
try |
515 | |
{ |
516 | 0 | summary = bundle.getString(messageId); |
517 | |
} |
518 | 0 | catch (MissingResourceException e) { |
519 | |
|
520 | 0 | } |
521 | |
|
522 | |
|
523 | 0 | if(summary == null) |
524 | |
{ |
525 | 0 | summary = messageId; |
526 | |
} |
527 | |
|
528 | 0 | summary = substituteParams(bundle.getLocale(), summary, params); |
529 | |
|
530 | |
try |
531 | |
{ |
532 | 0 | detail = substituteParams(bundle.getLocale(), |
533 | |
bundle.getString(messageId + DETAIL_SUFFIX), params); |
534 | |
} |
535 | 0 | catch(MissingResourceException e) { |
536 | |
|
537 | 0 | } |
538 | |
|
539 | 0 | return new FacesMessage(summary, detail); |
540 | |
} |
541 | |
|
542 | |
|
543 | |
|
544 | |
|
545 | |
|
546 | |
|
547 | |
|
548 | |
public static FacesMessage getMessage(FacesContext context, String messageId) |
549 | |
{ |
550 | 0 | return getMessage(context, messageId, ((Object []) (null))); |
551 | |
} |
552 | |
|
553 | |
public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId) |
554 | |
{ |
555 | 0 | return getMessage(bundleBaseName, context, messageId, ((Object []) (null))); |
556 | |
} |
557 | |
|
558 | |
|
559 | |
|
560 | |
|
561 | |
|
562 | |
|
563 | |
|
564 | |
|
565 | |
public static FacesMessage getMessage(FacesContext context, String messageId, Object params[]) |
566 | |
{ |
567 | 0 | if(context == null || messageId == null) |
568 | 0 | throw new NullPointerException(" context " + context + " messageId " + messageId); |
569 | 0 | Locale locale = getCurrentLocale(context); |
570 | 0 | if(null == locale) |
571 | 0 | throw new NullPointerException(" locale " + locale); |
572 | 0 | FacesMessage message = getMessage(locale, messageId, params); |
573 | 0 | if(message != null) |
574 | |
{ |
575 | 0 | return message; |
576 | |
} else |
577 | |
{ |
578 | |
|
579 | |
|
580 | 0 | locale = Locale.getDefault(); |
581 | 0 | return getMessage(locale, messageId, params); |
582 | |
} |
583 | |
} |
584 | |
|
585 | |
public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId, Object params[]) |
586 | |
{ |
587 | 0 | if(context == null || messageId == null) |
588 | 0 | throw new NullPointerException(" context " + context + " messageId " + messageId); |
589 | 0 | Locale locale = getCurrentLocale(context); |
590 | 0 | if(null == locale) |
591 | 0 | throw new NullPointerException(" locale " + locale); |
592 | 0 | FacesMessage message = getMessageFromBundle(bundleBaseName, context, locale, messageId, params); |
593 | 0 | if(message != null) |
594 | |
{ |
595 | 0 | return message; |
596 | |
} else |
597 | |
{ |
598 | |
|
599 | |
|
600 | 0 | locale = Locale.getDefault(); |
601 | 0 | return getMessageFromBundle(bundleBaseName, context, locale, messageId, params); |
602 | |
} |
603 | |
} |
604 | |
|
605 | |
public static Object getLabel(FacesContext facesContext, UIComponent component) { |
606 | 0 | Object label = component.getAttributes().get("label"); |
607 | 0 | if(label != null) |
608 | 0 | return label; |
609 | |
|
610 | 0 | ValueExpression expression = component.getValueExpression("label"); |
611 | 0 | if(expression != null) |
612 | 0 | return expression; |
613 | |
|
614 | |
|
615 | 0 | return component.getClientId( facesContext ); |
616 | |
} |
617 | |
|
618 | |
private static Application getApplication() |
619 | |
{ |
620 | 0 | FacesContext context = FacesContext.getCurrentInstance(); |
621 | 0 | if(context != null) |
622 | |
{ |
623 | 0 | return context.getApplication(); |
624 | |
} else |
625 | |
{ |
626 | 0 | ApplicationFactory afactory = (ApplicationFactory)FactoryFinder.getFactory("javax.faces.application.ApplicationFactory"); |
627 | 0 | return afactory.getApplication(); |
628 | |
} |
629 | |
} |
630 | |
} |