Coverage Report

Coverage Report - org.apache.myfaces.el.unified.resolver.ResourceBundleResolver

Classes in this File

Line Coverage

Branch Coverage

Complexity

ResourceBundleResolver

0/76

0/44

4.727

 /*
  * 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.el.unified.resolver;
 
 import java.beans.FeatureDescriptor;
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.Map;
 import java.util.ResourceBundle;
 import javax.el.ELContext;
 import javax.el.ELException;
 import javax.el.ELResolver;
 import javax.el.PropertyNotFoundException;
 import javax.el.PropertyNotWritableException;
 import javax.faces.application.Application;
 import javax.faces.context.FacesContext;
 
 import org.apache.myfaces.config.RuntimeConfig;
 
 /**
  * See JSF 1.2 spec section 5.6.1.4
  * 
  * @author Stan Silvert
  */
 public final class ResourceBundleResolver extends ELResolver
 {
 
     /**
      * RuntimeConfig is instantiated once per servlet and never changes--we can safely cache it
      */
     private RuntimeConfig runtimeConfig;
 
     /** Creates a new instance of ResourceBundleResolver */
     public ResourceBundleResolver()
     {
     }
 
     @Override
     public void setValue(final ELContext context, final Object base, final Object property, final Object value)
         throws NullPointerException, PropertyNotFoundException, PropertyNotWritableException, ELException
     {
         // JSF 2.0 spec section 5.6.1.4
         // "... If base is null and property is a String equal to the value of the
         // <var> element of one of the <resource-bundle>'s in the application 
         // configuration resources throw javax.el.PropertyNotWriteable, since
         // ResourceBundles are read-only. ..."
         // Since something is done only when base is null, it is better to check 
         // for not null and return.
         if (base != null)
         {
             return;
         }
 
         if ((base == null) && (property == null))
         {
             throw new PropertyNotFoundException();
         }
 
         if (!(property instanceof String))
         {
             return;
         }
 
         // base is null and property is a String value, check for resource bundle.
         final ResourceBundle bundle = getResourceBundle(context, (String)property);
 
         if (bundle != null)
         {
             throw new PropertyNotWritableException("ResourceBundles are read-only");
         }
     }
 
     @Override
     public boolean isReadOnly(final ELContext context, final Object base, final Object property)
         throws NullPointerException, PropertyNotFoundException, ELException
     {
 
         if (base != null)
         {
             return false;
         }
         if (property == null)
         {
             throw new PropertyNotFoundException();
         }
         if (!(property instanceof String))
         {
             return false;
         }
 
         final ResourceBundle bundle = getResourceBundle(context, (String)property);
 
         if (bundle != null)
         {
             context.setPropertyResolved(true);
             return true;
         }
 
         return false;
     }
 
     @Override
     public Object getValue(final ELContext context, final Object base, final Object property)
         throws NullPointerException, PropertyNotFoundException, ELException
     {
 
         if (base != null)
         {
             return null;
         }
         if (property == null)
         {
             throw new PropertyNotFoundException();
         }
         if (!(property instanceof String))
         {
             return null;
         }
 
         final ResourceBundle bundle = getResourceBundle(context, (String)property);
 
         if (bundle != null)
         {
             context.setPropertyResolved(true);
             return bundle;
         }
 
         return null;
     }
 
     @Override
     public Class<?> getType(final ELContext context, final Object base, final Object property)
         throws NullPointerException, PropertyNotFoundException, ELException
     {
 
         if (base != null)
         {
             return null;
         }
         if (property == null)
         {
             throw new PropertyNotFoundException();
         }
         if (!(property instanceof String))
         {
             return null;
         }
 
         final ResourceBundle bundle = getResourceBundle(context, (String)property);
 
         if (bundle != null)
         {
             context.setPropertyResolved(true);
             return ResourceBundle.class;
         }
 
         return null;
     }
 
     @Override
     public Iterator<FeatureDescriptor> getFeatureDescriptors(final ELContext context, final Object base)
     {
 
         if (base != null)
         {
             return null;
         }
 
         final ArrayList<FeatureDescriptor> descriptors = new ArrayList<FeatureDescriptor>();
 
         final Map<String, org.apache.myfaces.config.element.ResourceBundle> resourceBundles =
                 runtimeConfig(context).getResourceBundles();
 
         for (org.apache.myfaces.config.element.ResourceBundle resourceBundle : resourceBundles.values())
         {
             descriptors.add(makeDescriptor(resourceBundle));
         }
 
         return descriptors.iterator();
     }
 
     @Override
     public Class<?> getCommonPropertyType(final ELContext context, final Object base)
     {
 
         if (base != null)
         {
             return null;
         }
 
         return String.class;
     }
 
     // get the FacesContext from the ELContext
     private static FacesContext facesContext(final ELContext context)
     {
         return (FacesContext)context.getContext(FacesContext.class);
     }
 
     private static ResourceBundle getResourceBundle(final ELContext context, final String property)
     {
         final FacesContext facesContext = facesContext(context);
         if (facesContext != null)
         {
             final Application application = facesContext.getApplication();
             return application.getResourceBundle(facesContext, property);
         }
 
         return null;
     }
 
     protected RuntimeConfig runtimeConfig(ELContext context)
     {
         final FacesContext facesContext = facesContext(context);
 
         // application-level singleton - we can safely cache this
         if (this.runtimeConfig == null)
         {
             this.runtimeConfig = RuntimeConfig.getCurrentInstance(facesContext.getExternalContext());
         }
 
         return runtimeConfig;
     }
 
     private static FeatureDescriptor makeDescriptor(
                                                     org.apache.myfaces.config.element.ResourceBundle bundle)
     {
         final FeatureDescriptor fd = new FeatureDescriptor();
         fd.setValue(ELResolver.RESOLVABLE_AT_DESIGN_TIME, Boolean.TRUE);
         fd.setName(bundle.getVar());
         fd.setDisplayName(bundle.getDisplayName());
         fd.setValue(ELResolver.TYPE, ResourceBundle.class);
         fd.setShortDescription("");
         fd.setExpert(false);
         fd.setHidden(false);
         fd.setPreferred(true);
         return fd;
     }
 }

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.el.unified.resolver;
20
21		import java.beans.FeatureDescriptor;
22		import java.util.ArrayList;
23		import java.util.Iterator;
24		import java.util.Map;
25		import java.util.ResourceBundle;
26		import javax.el.ELContext;
27		import javax.el.ELException;
28		import javax.el.ELResolver;
29		import javax.el.PropertyNotFoundException;
30		import javax.el.PropertyNotWritableException;
31		import javax.faces.application.Application;
32		import javax.faces.context.FacesContext;
33
34		import org.apache.myfaces.config.RuntimeConfig;
35
36		/**
37		* See JSF 1.2 spec section 5.6.1.4
38		*
39		* @author Stan Silvert
40		*/
41		public final class ResourceBundleResolver extends ELResolver
42		{
43
44		/**
45		* RuntimeConfig is instantiated once per servlet and never changes--we can safely cache it
46		*/
47		private RuntimeConfig runtimeConfig;
48
49		/** Creates a new instance of ResourceBundleResolver */
50		public ResourceBundleResolver()
51	0	{
52	0	}
53
54		@Override
55		public void setValue(final ELContext context, final Object base, final Object property, final Object value)
56		throws NullPointerException, PropertyNotFoundException, PropertyNotWritableException, ELException
57		{
58		// JSF 2.0 spec section 5.6.1.4
59		// "... If base is null and property is a String equal to the value of the
60		// <var> element of one of the <resource-bundle>'s in the application
61		// configuration resources throw javax.el.PropertyNotWriteable, since
62		// ResourceBundles are read-only. ..."
63		// Since something is done only when base is null, it is better to check
64		// for not null and return.
65	0	if (base != null)
66		{
67	0	return;
68		}
69
70	0	if ((base == null) && (property == null))
71		{
72	0	throw new PropertyNotFoundException();
73		}
74
75	0	if (!(property instanceof String))
76		{
77	0	return;
78		}
79
80		// base is null and property is a String value, check for resource bundle.
81	0	final ResourceBundle bundle = getResourceBundle(context, (String)property);
82
83	0	if (bundle != null)
84		{
85	0	throw new PropertyNotWritableException("ResourceBundles are read-only");
86		}
87	0	}
88
89		@Override
90		public boolean isReadOnly(final ELContext context, final Object base, final Object property)
91		throws NullPointerException, PropertyNotFoundException, ELException
92		{
93
94	0	if (base != null)
95		{
96	0	return false;
97		}
98	0	if (property == null)
99		{
100	0	throw new PropertyNotFoundException();
101		}
102	0	if (!(property instanceof String))
103		{
104	0	return false;
105		}
106
107	0	final ResourceBundle bundle = getResourceBundle(context, (String)property);
108
109	0	if (bundle != null)
110		{
111	0	context.setPropertyResolved(true);
112	0	return true;
113		}
114
115	0	return false;
116		}
117
118		@Override
119		public Object getValue(final ELContext context, final Object base, final Object property)
120		throws NullPointerException, PropertyNotFoundException, ELException
121		{
122
123	0	if (base != null)
124		{
125	0	return null;
126		}
127	0	if (property == null)
128		{
129	0	throw new PropertyNotFoundException();
130		}
131	0	if (!(property instanceof String))
132		{
133	0	return null;
134		}
135
136	0	final ResourceBundle bundle = getResourceBundle(context, (String)property);
137
138	0	if (bundle != null)
139		{
140	0	context.setPropertyResolved(true);
141	0	return bundle;
142		}
143
144	0	return null;
145		}
146
147		@Override
148		public Class<?> getType(final ELContext context, final Object base, final Object property)
149		throws NullPointerException, PropertyNotFoundException, ELException
150		{
151
152	0	if (base != null)
153		{
154	0	return null;
155		}
156	0	if (property == null)
157		{
158	0	throw new PropertyNotFoundException();
159		}
160	0	if (!(property instanceof String))
161		{
162	0	return null;
163		}
164
165	0	final ResourceBundle bundle = getResourceBundle(context, (String)property);
166
167	0	if (bundle != null)
168		{
169	0	context.setPropertyResolved(true);
170	0	return ResourceBundle.class;
171		}
172
173	0	return null;
174		}
175
176		@Override
177		public Iterator<FeatureDescriptor> getFeatureDescriptors(final ELContext context, final Object base)
178		{
179
180	0	if (base != null)
181		{
182	0	return null;
183		}
184
185	0	final ArrayList<FeatureDescriptor> descriptors = new ArrayList<FeatureDescriptor>();
186
187	0	final Map<String, org.apache.myfaces.config.element.ResourceBundle> resourceBundles =
188		runtimeConfig(context).getResourceBundles();
189
190	0	for (org.apache.myfaces.config.element.ResourceBundle resourceBundle : resourceBundles.values())
191		{
192	0	descriptors.add(makeDescriptor(resourceBundle));
193	0	}
194
195	0	return descriptors.iterator();
196		}
197
198		@Override
199		public Class<?> getCommonPropertyType(final ELContext context, final Object base)
200		{
201
202	0	if (base != null)
203		{
204	0	return null;
205		}
206
207	0	return String.class;
208		}
209
210		// get the FacesContext from the ELContext
211		private static FacesContext facesContext(final ELContext context)
212		{
213	0	return (FacesContext)context.getContext(FacesContext.class);
214		}
215
216		private static ResourceBundle getResourceBundle(final ELContext context, final String property)
217		{
218	0	final FacesContext facesContext = facesContext(context);
219	0	if (facesContext != null)
220		{
221	0	final Application application = facesContext.getApplication();
222	0	return application.getResourceBundle(facesContext, property);
223		}
224
225	0	return null;
226		}
227
228		protected RuntimeConfig runtimeConfig(ELContext context)
229		{
230	0	final FacesContext facesContext = facesContext(context);
231
232		// application-level singleton - we can safely cache this
233	0	if (this.runtimeConfig == null)
234		{
235	0	this.runtimeConfig = RuntimeConfig.getCurrentInstance(facesContext.getExternalContext());
236		}
237
238	0	return runtimeConfig;
239		}
240
241		private static FeatureDescriptor makeDescriptor(
242		org.apache.myfaces.config.element.ResourceBundle bundle)
243		{
244	0	final FeatureDescriptor fd = new FeatureDescriptor();
245	0	fd.setValue(ELResolver.RESOLVABLE_AT_DESIGN_TIME, Boolean.TRUE);
246	0	fd.setName(bundle.getVar());
247	0	fd.setDisplayName(bundle.getDisplayName());
248	0	fd.setValue(ELResolver.TYPE, ResourceBundle.class);
249	0	fd.setShortDescription("");
250	0	fd.setExpert(false);
251	0	fd.setHidden(false);
252	0	fd.setPreferred(true);
253	0	return fd;
254		}
255		}