Coverage Report

Coverage Report - javax.faces.component.html._MessageUtils

Classes in this File

0/52

0/30

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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 javax.faces.component.html;
 
 import javax.el.ValueExpression;
 import javax.faces.application.FacesMessage;
 import javax.faces.context.FacesContext;
 
 import java.util.Locale;
 import java.util.MissingResourceException;
 import java.util.ResourceBundle;
 import javax.faces.component.UIComponent;
 
 class _MessageUtils
 {
     private static final String DETAIL_SUFFIX = "_detail";
 
     static void addErrorMessage(FacesContext facesContext,
                                 UIComponent component,
                                 String messageId)
     {
         facesContext.addMessage(component.getClientId(facesContext),
                                 getMessage(facesContext,
                                            facesContext.getViewRoot().getLocale(),
                                            FacesMessage.SEVERITY_ERROR,
                                            messageId,
                                            null));
     }
 
     static void addErrorMessage(FacesContext facesContext,
                                 UIComponent component,
                                 String messageId, Object[] args)
     {
         facesContext.addMessage(component.getClientId(facesContext),
                                 getMessage(facesContext,
                                            facesContext.getViewRoot().getLocale(),
                                            FacesMessage.SEVERITY_ERROR,
                                            messageId,
                                            args));
     }
 
     static void addErrorMessage(FacesContext facesContext,
             UIComponent component, Throwable cause)
     {
         facesContext.addMessage(component.getClientId(facesContext),
                 new FacesMessage(FacesMessage.SEVERITY_ERROR, cause
                         .getLocalizedMessage(), cause.getLocalizedMessage()));
     }
 
     
     static FacesMessage getMessage(FacesContext facesContext,
                                    Locale locale,
                                    FacesMessage.Severity severity,
                                    String messageId,
                                    Object args[])
     {
         ResourceBundle appBundle;
         ResourceBundle defBundle;
         String summary;
         String detail;
 
         appBundle = getApplicationBundle(facesContext, locale);
         summary = getBundleString(appBundle, messageId);
         if (summary != null)
         {
             detail = getBundleString(appBundle, messageId + DETAIL_SUFFIX);
         }
         else
         {
             defBundle = getDefaultBundle(facesContext, locale);
             summary = getBundleString(defBundle, messageId);
             if (summary != null)
             {
                 detail = getBundleString(defBundle, messageId + DETAIL_SUFFIX);
             }
             else
             {
                 //Try to find detail alone
                 detail = getBundleString(appBundle, messageId + DETAIL_SUFFIX);
                 if (detail != null)
                 {
                     summary = null;
                 }
                 else
                 {
                     detail = getBundleString(defBundle, messageId + DETAIL_SUFFIX);
                     if (detail != null)
                     {
                         summary = null;
                     }
                     else
                     {
                         //Neither detail nor summary found
                         facesContext.getExternalContext().log("No message with id " + messageId
                                                               + " found in any bundle");
                         return new FacesMessage(severity, messageId, null);
                     }
                 }
             }
         }
 
         if (args != null && args.length > 0)
         {
             return new _ParametrizableFacesMessage(severity, summary, detail, args, locale);
         }
         else
         {
             return new FacesMessage(severity, summary, detail);
         }
     }
 
     private static String getBundleString(ResourceBundle bundle, String key)
     {
         try
         {
             return bundle == null ? null : bundle.getString(key);
         }
         catch (MissingResourceException e)
         {
             return null;
         }
     }
 
 
     private static ResourceBundle getApplicationBundle(FacesContext facesContext, Locale locale)
     {
         String bundleName = facesContext.getApplication().getMessageBundle();
         return bundleName != null ? getBundle(facesContext, locale, bundleName) : null;
     }
 
     private static ResourceBundle getDefaultBundle(FacesContext facesContext,
                                                    Locale locale)
     {
         return getBundle(facesContext, locale, FacesMessage.FACES_MESSAGES);
     }
 
     private static ResourceBundle getBundle(FacesContext facesContext,
                                             Locale locale,
                                             String bundleName)
     {
         try
         {
             //First we try the JSF implementation class loader
             return ResourceBundle.getBundle(bundleName,
                                             locale,
                                             facesContext.getClass().getClassLoader());
         }
         catch (MissingResourceException ignore1)
         {
             try
             {
                 //Next we try the JSF API class loader
                 return ResourceBundle.getBundle(bundleName,
                                                 locale,
                                                 _MessageUtils.class.getClassLoader());
             }
             catch (MissingResourceException ignore2)
             {
                 try
                 {
                     //Last resort is the context class loader
                     return ResourceBundle.getBundle(bundleName,
                                                     locale,
                                                     _ClassUtils.getContextClassLoader());
                 }
                 catch (MissingResourceException damned)
                 {
                     facesContext.getExternalContext().log("resource bundle " + bundleName + " could not be found");
                     return null;
                 }
             }
         }
     }
     
     static Object getLabel(FacesContext facesContext, UIComponent component)
     {
         Object label = component.getAttributes().get("label");
         ValueExpression expression = null;
         if (label != null && 
             label instanceof String && ((String)label).length() == 0 )
         {
             // Note component.getAttributes().get("label") internally try to 
             // evaluate the EL expression for the label, but in some cases, 
             // when PSS is disabled and f:loadBundle is used, when the view is 
             // restored the bundle is not set to the EL expression returns an 
             // empty String. It is not possible to check if there is a 
             // hardcoded label, but we can check if there is
             // an EL expression set, so the best in this case is use that, and if
             // there is an EL expression set, use it, otherwise use the hardcoded
             // value. See MYFACES-3591 for details.
             expression = component.getValueExpression("label");
             if (expression != null)
             {
                 // Set the label to null and use the EL expression instead.
                 label = null;
             }
         }
             
         if(label != null)
         {
             return label;
         }
         
         expression = (expression == null) ? component.getValueExpression("label") : expression;
         if(expression != null)
         {
             return expression;
         }
         
         //If no label is not specified, use clientId
         return component.getClientId( facesContext );
     }
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one
3		* or more contributor license agreements. See the NOTICE file
4		* distributed with this work for additional information
5		* regarding copyright ownership. The ASF licenses this file
6		* to you under the Apache License, Version 2.0 (the
7		* "License"); you may not use this file except in compliance
8		* with the License. You may obtain a copy of the License at
9		*
10		* http://www.apache.org/licenses/LICENSE-2.0
11		*
12		* Unless required by applicable law or agreed to in writing,
13		* software distributed under the License is distributed on an
14		* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15		* KIND, either express or implied. See the License for the
16		* specific language governing permissions and limitations
17		* under the License.
18		*/
19		package javax.faces.component.html;
20
21		import javax.el.ValueExpression;
22		import javax.faces.application.FacesMessage;
23		import javax.faces.context.FacesContext;
24
25		import java.util.Locale;
26		import java.util.MissingResourceException;
27		import java.util.ResourceBundle;
28		import javax.faces.component.UIComponent;
29
30	0	class _MessageUtils
31		{
32		private static final String DETAIL_SUFFIX = "_detail";
33
34		static void addErrorMessage(FacesContext facesContext,
35		UIComponent component,
36		String messageId)
37		{
38	0	facesContext.addMessage(component.getClientId(facesContext),
39		getMessage(facesContext,
40		facesContext.getViewRoot().getLocale(),
41		FacesMessage.SEVERITY_ERROR,
42		messageId,
43		null));
44	0	}
45
46		static void addErrorMessage(FacesContext facesContext,
47		UIComponent component,
48		String messageId, Object[] args)
49		{
50	0	facesContext.addMessage(component.getClientId(facesContext),
51		getMessage(facesContext,
52		facesContext.getViewRoot().getLocale(),
53		FacesMessage.SEVERITY_ERROR,
54		messageId,
55		args));
56	0	}
57
58		static void addErrorMessage(FacesContext facesContext,
59		UIComponent component, Throwable cause)
60		{
61	0	facesContext.addMessage(component.getClientId(facesContext),
62		new FacesMessage(FacesMessage.SEVERITY_ERROR, cause
63		.getLocalizedMessage(), cause.getLocalizedMessage()));
64	0	}
65
66
67		static FacesMessage getMessage(FacesContext facesContext,
68		Locale locale,
69		FacesMessage.Severity severity,
70		String messageId,
71		Object args[])
72		{
73		ResourceBundle appBundle;
74		ResourceBundle defBundle;
75		String summary;
76		String detail;
77
78	0	appBundle = getApplicationBundle(facesContext, locale);
79	0	summary = getBundleString(appBundle, messageId);
80	0	if (summary != null)
81		{
82	0	detail = getBundleString(appBundle, messageId + DETAIL_SUFFIX);
83		}
84		else
85		{
86	0	defBundle = getDefaultBundle(facesContext, locale);
87	0	summary = getBundleString(defBundle, messageId);
88	0	if (summary != null)
89		{
90	0	detail = getBundleString(defBundle, messageId + DETAIL_SUFFIX);
91		}
92		else
93		{
94		//Try to find detail alone
95	0	detail = getBundleString(appBundle, messageId + DETAIL_SUFFIX);
96	0	if (detail != null)
97		{
98	0	summary = null;
99		}
100		else
101		{
102	0	detail = getBundleString(defBundle, messageId + DETAIL_SUFFIX);
103	0	if (detail != null)
104		{
105	0	summary = null;
106		}
107		else
108		{
109		//Neither detail nor summary found
110	0	facesContext.getExternalContext().log("No message with id " + messageId
111		+ " found in any bundle");
112	0	return new FacesMessage(severity, messageId, null);
113		}
114		}
115		}
116		}
117
118	0	if (args != null && args.length > 0)
119		{
120	0	return new _ParametrizableFacesMessage(severity, summary, detail, args, locale);
121		}
122		else
123		{
124	0	return new FacesMessage(severity, summary, detail);
125		}
126		}
127
128		private static String getBundleString(ResourceBundle bundle, String key)
129		{
130		try
131		{
132	0	return bundle == null ? null : bundle.getString(key);
133		}
134	0	catch (MissingResourceException e)
135		{
136	0	return null;
137		}
138		}
139
140
141		private static ResourceBundle getApplicationBundle(FacesContext facesContext, Locale locale)
142		{
143	0	String bundleName = facesContext.getApplication().getMessageBundle();
144	0	return bundleName != null ? getBundle(facesContext, locale, bundleName) : null;
145		}
146
147		private static ResourceBundle getDefaultBundle(FacesContext facesContext,
148		Locale locale)
149		{
150	0	return getBundle(facesContext, locale, FacesMessage.FACES_MESSAGES);
151		}
152
153		private static ResourceBundle getBundle(FacesContext facesContext,
154		Locale locale,
155		String bundleName)
156		{
157		try
158		{
159		//First we try the JSF implementation class loader
160	0	return ResourceBundle.getBundle(bundleName,
161		locale,
162		facesContext.getClass().getClassLoader());
163		}
164	0	catch (MissingResourceException ignore1)
165		{
166		try
167		{
168		//Next we try the JSF API class loader
169	0	return ResourceBundle.getBundle(bundleName,
170		locale,
171		_MessageUtils.class.getClassLoader());
172		}
173	0	catch (MissingResourceException ignore2)
174		{
175		try
176		{
177		//Last resort is the context class loader
178	0	return ResourceBundle.getBundle(bundleName,
179		locale,
180		_ClassUtils.getContextClassLoader());
181		}
182	0	catch (MissingResourceException damned)
183		{
184	0	facesContext.getExternalContext().log("resource bundle " + bundleName + " could not be found");
185	0	return null;
186		}
187		}
188		}
189		}
190
191		static Object getLabel(FacesContext facesContext, UIComponent component)
192		{
193	0	Object label = component.getAttributes().get("label");
194	0	ValueExpression expression = null;
195	0	if (label != null &&
196		label instanceof String && ((String)label).length() == 0 )
197		{
198		// Note component.getAttributes().get("label") internally try to
199		// evaluate the EL expression for the label, but in some cases,
200		// when PSS is disabled and f:loadBundle is used, when the view is
201		// restored the bundle is not set to the EL expression returns an
202		// empty String. It is not possible to check if there is a
203		// hardcoded label, but we can check if there is
204		// an EL expression set, so the best in this case is use that, and if
205		// there is an EL expression set, use it, otherwise use the hardcoded
206		// value. See MYFACES-3591 for details.
207	0	expression = component.getValueExpression("label");
208	0	if (expression != null)
209		{
210		// Set the label to null and use the EL expression instead.
211	0	label = null;
212		}
213		}
214
215	0	if(label != null)
216		{
217	0	return label;
218		}
219
220	0	expression = (expression == null) ? component.getValueExpression("label") : expression;
221	0	if(expression != null)
222		{
223	0	return expression;
224		}
225
226		//If no label is not specified, use clientId
227	0	return component.getClientId( facesContext );
228		}
229		}