Coverage Report

Coverage Report - org.apache.myfaces.shared_impl.util.MessageUtils

Classes in this File

Line Coverage

Branch Coverage

Complexity

MessageUtils

0/178

0/80

2.938

 /*
  *  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 org.apache.myfaces.shared_impl.util;
 
 import java.text.MessageFormat;
 import java.util.Locale;
 import java.util.MissingResourceException;
 import java.util.ResourceBundle;
 
 import javax.el.ValueExpression;
 import javax.faces.FactoryFinder;
 import javax.faces.application.Application;
 import javax.faces.application.ApplicationFactory;
 import javax.faces.application.FacesMessage;
 import javax.faces.component.UIComponent;
 import javax.faces.context.FacesContext;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 /**
  * Utility class to support multilingual FacesMessages using ResourceBundles.
  * Standard messages are stored at <code>DEFAULT_BUNDLE</code>.<br>
  * The summary of the message is stored at the requested key value. The detail
  * of the message is stored at &lt;messageId&gt;_detail.
  *
  * @see FacesMessage
  * @see java.util.ResourceBundle
  *
  * @author Thomas Spiegl (latest modification by $Author: lu4242 $)
  * @author Manfred Geiler
  * @author Sean Schofield
  * @author Stpehan Strittmatter
  * @version $Revision: 940133 $ $Date: 2010-05-01 20:30:31 -0500 (Sat, 01 May 2010) $
  */
 public final class MessageUtils
 {
     /** Utility class, do not instatiate */
     private MessageUtils()
     {
         // nope
     }
 
     /** Default bundle for messages (<code>javax.faces.Messages</code>) */
     private static final String DEFAULT_BUNDLE = "javax.faces.Messages";
 
     /** Suffix for message details (<code>_detail</code>)*/
     private static final String DETAIL_SUFFIX = "_detail";
     private static Log log = LogFactory.getLog(MessageUtils.class);
 
     /**
      * @param severity serverity of message
      * @param messageId id of message
      * @param arg arument of message
      *
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(FacesMessage.Severity severity,
                                           String messageId,
                                           Object arg)
     {
         return getMessage(severity,
                           messageId,
                           new Object[]{arg},
                           FacesContext.getCurrentInstance());
     }
     
     public static FacesMessage getMessage(String bundleBaseName, 
             FacesMessage.Severity severity,
             String messageId,
             Object arg)
     {
         return getMessage(bundleBaseName,
                           severity,
                           messageId,
                           new Object[]{arg},
                           FacesContext.getCurrentInstance());
     }
 
     /**
      * @param severity serverity of message
      * @param messageId id of message
      * @param args aruments of message
      *
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(FacesMessage.Severity severity,
                                           String messageId,
                                           Object[] args)
     {
         return getMessage(severity,
                           messageId,
                           args,
                           FacesContext.getCurrentInstance());
     }
     
     public static FacesMessage getMessage(String bundleBaseName, 
             FacesMessage.Severity severity,
             String messageId,
             Object[] args)
     {
         return getMessage(bundleBaseName,
                           severity,
                           messageId,
                           args,
                           FacesContext.getCurrentInstance());
     }    
 
     public static FacesMessage getMessage(FacesMessage.Severity severity,
                                           String messageId,
                                           Object[] args,
                                           FacesContext facesContext)
     {
         FacesMessage message = getMessage(facesContext, messageId, args);
         message.setSeverity(severity);
 
         return message;
     }
 
     public static FacesMessage getMessage(String bundleBaseName,
             FacesMessage.Severity severity,
             String messageId,
             Object[] args,
             FacesContext facesContext)
     {
         FacesMessage message = getMessage(bundleBaseName, facesContext, messageId, args);
         message.setSeverity(severity);
         
         return message;
     }
 
     public static void addMessage(FacesMessage.Severity severity,
                                   String messageId,
                                   Object[] args)
     {
         addMessage(severity, messageId, args, null, FacesContext.getCurrentInstance());
     }
 
     public static void addMessage(String bundleBaseName, 
             FacesMessage.Severity severity,
             String messageId,
             Object[] args)
     {
         addMessage(bundleBaseName, severity, messageId, args, null, FacesContext.getCurrentInstance());
     }
 
     public static void addMessage(FacesMessage.Severity severity,
                                   String messageId,
                                   Object[] args,
                                   FacesContext facesContext)
     {
         addMessage(severity, messageId, args, null, facesContext);
     }
 
     public static void addMessage(String bundleBaseName, 
             FacesMessage.Severity severity,
             String messageId,
             Object[] args,
             FacesContext facesContext)
     {
         addMessage(bundleBaseName, severity, messageId, args, null, facesContext);
     }
 
     public static void addMessage(FacesMessage.Severity severity,
                                   String messageId,
                                   Object[] args,
                                   String forClientId)
     {
         addMessage(severity, messageId, args, forClientId, FacesContext.getCurrentInstance());
     }
 
     public static void addMessage(String bundleBaseName,
             FacesMessage.Severity severity,
             String messageId,
             Object[] args,
             String forClientId)
     {
         addMessage(bundleBaseName, severity, messageId, args, forClientId, FacesContext.getCurrentInstance());
     }
 
     public static void addMessage(FacesMessage.Severity severity,
                                   String messageId,
                                   Object[] args,
                                   String forClientId,
                                   FacesContext facesContext)
     {
         if(log.isTraceEnabled()) {
           log.trace("adding message " + messageId + " for clientId " + forClientId);
         }
         facesContext.addMessage(forClientId,
                                 getMessage(severity, messageId, args, facesContext));
     }
 
     public static void addMessage(String bundleBaseName,
             FacesMessage.Severity severity,
             String messageId,
             Object[] args,
             String forClientId,
             FacesContext facesContext)
     {
         if(log.isTraceEnabled()) {
         log.trace("adding message " + messageId + " for clientId " + forClientId);
         }
         facesContext.addMessage(forClientId,
                   getMessage(bundleBaseName, severity, messageId, args, facesContext));
     }
 
     /**
      * Uses <code>MessageFormat</code> and the supplied parameters to fill in the param placeholders in the String.
      *
      * @param locale The <code>Locale</code> to use when performing the substitution.
      * @param msgtext The original parameterized String.
      * @param params The params to fill in the String with.
      * @return The updated String.
      */
     public static String substituteParams(Locale locale, String msgtext, Object params[])
     {
         String localizedStr = null;
         if(params == null || msgtext == null)
             return msgtext;
 
         if(locale != null)
         {
             MessageFormat mf = new MessageFormat(msgtext,locale);            
             localizedStr = mf.format(params);
         }
         return localizedStr;
     }
 
     public static FacesMessage getMessage(String messageId, Object params[])
     {
         Locale locale = getCurrentLocale();
         return getMessage(locale, messageId, params);
     }
 
     public static FacesMessage getMessageFromBundle(String bundleBaseName, String messageId, Object params[])
     {
         Locale locale = null;
         FacesContext context = FacesContext.getCurrentInstance();
         if(context != null && context.getViewRoot() != null)
         {
             locale = context.getViewRoot().getLocale();
             if(locale == null)
                 locale = Locale.getDefault();
         } else
         {
             locale = Locale.getDefault();
         }
         return getMessageFromBundle(bundleBaseName, context , locale, messageId, params);
     }
 
     public static FacesMessage getMessage(Locale locale, String messageId, Object params[])
     {
         String summary = null;
         String detail = null;
         String bundleName = getApplication().getMessageBundle();
         ResourceBundle bundle = null;
 
         if (bundleName != null)
         {
             try
             {
                 bundle = ResourceBundle.getBundle(bundleName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleName));
                 summary = bundle.getString(messageId);
             }
             catch (MissingResourceException e) {
                 // NoOp
             }
         }
 
         if (summary == null)
         {
             try
             {
                 bundle = ResourceBundle.getBundle(DEFAULT_BUNDLE, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(DEFAULT_BUNDLE));
                 if(bundle == null)
                 {
                     throw new NullPointerException();
                 }
                 summary = bundle.getString(messageId);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
         }
 
         if(summary == null)
         {
             summary = messageId;
         }
 
         if (bundle == null)
         {
             throw new NullPointerException(
                 "Unable to locate ResourceBundle: bundle is null");
         }
         if (params != null && locale != null)
         {
             try
             {
                 detail = bundle.getString(messageId + DETAIL_SUFFIX);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
             return new ParametrizableFacesMessage(summary, detail, params, locale);
         }
         else
         {
             summary = substituteParams(locale, summary, params);
             try
             {
                 detail = substituteParams(locale,
                     bundle.getString(messageId + DETAIL_SUFFIX), params);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
             return new FacesMessage(summary, detail);
         }
     }
     
     public static FacesMessage getMessageFromBundle(String bundleBaseName, FacesContext context, Locale locale, String messageId, Object params[])
     {
         String summary = null;
         String detail = null;
         String bundleName = context.getApplication().getMessageBundle();
         ResourceBundle bundle = null;
 
         if (bundleName != null)
         {
             try
             {
                 bundle = ResourceBundle.getBundle(bundleName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleName));
                 summary = bundle.getString(messageId);
             }
             catch (MissingResourceException e) {
                 // NoOp
             }
         }
 
         if (summary == null)
         {
             try
             {
                 bundle = ResourceBundle.getBundle(bundleBaseName, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(bundleBaseName));
                 if(bundle == null)
                 {
                     throw new NullPointerException();
                 }
                 summary = bundle.getString(messageId);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
         }
         
         if (summary == null)
         {
             try
             {
                 bundle = ResourceBundle.getBundle(DEFAULT_BUNDLE, locale, org.apache.myfaces.shared_impl.util.ClassUtils.getCurrentLoader(DEFAULT_BUNDLE));
                 if(bundle == null)
                 {
                     throw new NullPointerException();
                 }
                 summary = bundle.getString(messageId);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
         }
 
         if(summary == null)
         {
             summary = messageId;
         }
 
         if (bundle == null)
         {
             throw new NullPointerException(
                 "Unable to locate ResourceBundle: bundle is null");
         }
         
         if (params != null && locale != null)
         {
             try
             {
                 detail = bundle.getString(messageId + DETAIL_SUFFIX);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
             return new ParametrizableFacesMessage(summary, detail, params, locale);
         }
         else
         {
             summary = substituteParams(locale, summary, params);
             try
             {
                 detail = substituteParams(locale,
                     bundle.getString(messageId + DETAIL_SUFFIX), params);
             }
             catch(MissingResourceException e) {
                 // NoOp
             }
             return new FacesMessage(summary, detail);
         }
     }
 
     /**
      *  Retrieve the message from a specific bundle. It does not look on application message bundle
      * or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead
      * 
      * @param bundleBaseName baseName of ResourceBundle to load localized messages
      * @param messageId id of message
      * @param params parameters to set at localized message
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(String bundleBaseName, String messageId, Object params[])
     {
         return getMessage(bundleBaseName, getCurrentLocale(), messageId, params);
     }
     
     /**
      * 
      * @return  currently applicable Locale for this request.
      */
     public static Locale getCurrentLocale() {
         return getCurrentLocale(FacesContext.getCurrentInstance());
     }
     
     public static Locale getCurrentLocale(FacesContext context) {
         Locale locale;
         if(context != null && context.getViewRoot() != null)
         {
             locale = context.getViewRoot().getLocale();
             if(locale == null)
                 locale = Locale.getDefault();
         }
         else
         {
             locale = Locale.getDefault();
         }
         
         return locale;
     }
 
     /**
      * @param severity severity of message
      * @param bundleBaseName baseName of ResourceBundle to load localized messages
      * @param messageId id of message
      * @param params parameters to set at localized message
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(FacesMessage.Severity severity, String bundleBaseName, String messageId, Object params[])
     {
       FacesMessage msg = getMessage(bundleBaseName, messageId, params);
       msg.setSeverity(severity);
 
       return msg;
     }
 
     /**
      *  Retrieve the message from a specific bundle. It does not look on application message bundle
      * or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead
      * 
      * @param bundleBaseName baseName of ResourceBundle to load localized messages
      * @param locale current locale
      * @param messageId id of message
      * @param params parameters to set at localized message
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(String bundleBaseName, Locale locale, String messageId, Object params[])
     {
       if (bundleBaseName == null)
       {
           throw new NullPointerException(
               "Unable to locate ResourceBundle: bundle is null");
       }
 
       ResourceBundle bundle = ResourceBundle.getBundle(bundleBaseName, locale);
 
       return getMessage(bundle, messageId, params);
     }
     /**
      * @param bundle ResourceBundle to load localized messages
      * @param messageId id of message
      * @param params parameters to set at localized message
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(ResourceBundle bundle, String messageId, Object params[])
     {
 
       String summary = null;
       String detail = null;
 
       try
       {
           summary = bundle.getString(messageId);
       }
       catch (MissingResourceException e) {
         // NoOp
       }
 
 
       if(summary == null)
       {
           summary = messageId;
       }
 
       summary = substituteParams(bundle.getLocale(), summary, params);
 
       try
       {
           detail = substituteParams(bundle.getLocale(),
               bundle.getString(messageId + DETAIL_SUFFIX), params);
       }
       catch(MissingResourceException e) {
         // NoOp
       }
 
       return new FacesMessage(summary, detail);
     }
 
     /**
      *
      * @param context
      * @param messageId
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(FacesContext context, String messageId)
     {
         return getMessage(context, messageId, ((Object []) (null)));
     }
     
     public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId)
     {
         return getMessage(bundleBaseName, context, messageId, ((Object []) (null)));
     }
 
     /**
      *
      * @param context
      * @param messageId
      * @param params
      * @return generated FacesMessage
      */
     public static FacesMessage getMessage(FacesContext context, String messageId, Object params[])
     {
         if(context == null || messageId == null)
             throw new NullPointerException(" context " + context + " messageId " + messageId);
         Locale locale = getCurrentLocale(context);
         if(null == locale)
             throw new NullPointerException(" locale " + locale);
         FacesMessage message = getMessage(locale, messageId, params);
         if(message != null)
         {
             return message;
         } else
         {
             // TODO /FIX:  Note that this has fallback behavior to default Locale for message,
             // but similar behavior above does not.  The methods should probably behave
             locale = Locale.getDefault();
             return getMessage(locale, messageId, params);
         }
     }
     
     public static FacesMessage getMessage(String bundleBaseName, FacesContext context, String messageId, Object params[])
     {
         if(context == null || messageId == null)
             throw new NullPointerException(" context " + context + " messageId " + messageId);
         Locale locale = getCurrentLocale(context);
         if(null == locale)
             throw new NullPointerException(" locale " + locale);
         FacesMessage message = getMessageFromBundle(bundleBaseName, context, locale, messageId, params);
         if(message != null)
         {
             return message;
         } else
         {
             // TODO /FIX:  Note that this has fallback behavior to default Locale for message,
             // but similar behavior above does not.  The methods should probably behave
             locale = Locale.getDefault();
             return getMessageFromBundle(bundleBaseName, context, locale, messageId, params);
         }
     }
     
     public static Object getLabel(FacesContext facesContext, UIComponent component) {
         Object label = component.getAttributes().get("label");
         if(label != null)
             return label;
         
         ValueExpression expression = component.getValueExpression("label");
         if(expression != null)
             return expression;
         
         //If no label is not specified, use clientId
         return component.getClientId( facesContext );
     }
 
     private static Application getApplication()
     {
         FacesContext context = FacesContext.getCurrentInstance();
         if(context != null)
         {
             return context.getApplication();
         } else
         {
             ApplicationFactory afactory = (ApplicationFactory)FactoryFinder.getFactory("javax.faces.application.ApplicationFactory");
             return afactory.getApplication();
         }
     }
 }

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 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		* Utility class to support multilingual FacesMessages using ResourceBundles.
39		* Standard messages are stored at <code>DEFAULT_BUNDLE</code>.<br>
40		* The summary of the message is stored at the requested key value. The detail
41		* of the message is stored at <messageId>_detail.
42		*
43		* @see FacesMessage
44		* @see java.util.ResourceBundle
45		*
46		* @author Thomas Spiegl (latest modification by $Author: lu4242 $)
47		* @author Manfred Geiler
48		* @author Sean Schofield
49		* @author Stpehan Strittmatter
50		* @version $Revision: 940133 $ $Date: 2010-05-01 20:30:31 -0500 (Sat, 01 May 2010) $
51		*/
52		public final class MessageUtils
53		{
54		/** Utility class, do not instatiate */
55		private MessageUtils()
56	0	{
57		// nope
58	0	}
59
60		/** Default bundle for messages (<code>javax.faces.Messages</code>) */
61		private static final String DEFAULT_BUNDLE = "javax.faces.Messages";
62
63		/** Suffix for message details (<code>_detail</code>)*/
64		private static final String DETAIL_SUFFIX = "_detail";
65	0	private static Log log = LogFactory.getLog(MessageUtils.class);
66
67		/**
68		* @param severity serverity of message
69		* @param messageId id of message
70		* @param arg arument of message
71		*
72		* @return generated FacesMessage
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		* @param severity serverity of message
98		* @param messageId id of message
99		* @param args aruments of message
100		*
101		* @return generated FacesMessage
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		* Uses <code>MessageFormat</code> and the supplied parameters to fill in the param placeholders in the String.
226		*
227		* @param locale The <code>Locale</code> to use when performing the substitution.
228		* @param msgtext The original parameterized String.
229		* @param params The params to fill in the String with.
230		* @return The updated String.
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
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		// NoOp
422	0	}
423	0	return new FacesMessage(summary, detail);
424		}
425		}
426
427		/**
428		* Retrieve the message from a specific bundle. It does not look on application message bundle
429		* or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead
430		*
431		* @param bundleBaseName baseName of ResourceBundle to load localized messages
432		* @param messageId id of message
433		* @param params parameters to set at localized message
434		* @return generated FacesMessage
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		* @return currently applicable Locale for this request.
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		* @param severity severity of message
467		* @param bundleBaseName baseName of ResourceBundle to load localized messages
468		* @param messageId id of message
469		* @param params parameters to set at localized message
470		* @return generated FacesMessage
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		* Retrieve the message from a specific bundle. It does not look on application message bundle
482		* or default message bundle. If it is required to look on those bundles use getMessageFromBundle instead
483		*
484		* @param bundleBaseName baseName of ResourceBundle to load localized messages
485		* @param locale current locale
486		* @param messageId id of message
487		* @param params parameters to set at localized message
488		* @return generated FacesMessage
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		* @param bundle ResourceBundle to load localized messages
504		* @param messageId id of message
505		* @param params parameters to set at localized message
506		* @return generated FacesMessage
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		// NoOp
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		// NoOp
537	0	}
538
539	0	return new FacesMessage(summary, detail);
540		}
541
542		/**
543		*
544		* @param context
545		* @param messageId
546		* @return generated FacesMessage
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		* @param context
561		* @param messageId
562		* @param params
563		* @return generated FacesMessage
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		// TODO /FIX: Note that this has fallback behavior to default Locale for message,
579		// but similar behavior above does not. The methods should probably behave
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		// TODO /FIX: Note that this has fallback behavior to default Locale for message,
599		// but similar behavior above does not. The methods should probably behave
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		//If no label is not specified, use clientId
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		}