Coverage Report

Coverage Report - org.apache.myfaces.util.DebugUtils

Classes in this File

0/174

0/88

 /*
  * 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.util;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
 import javax.faces.FacesException;
 import javax.faces.component.*;
 import javax.faces.context.FacesContext;
 import javax.faces.el.MethodBinding;
 import javax.faces.el.ValueBinding;
 import javax.faces.event.FacesListener;
 import javax.faces.validator.Validator;
 import java.beans.BeanInfo;
 import java.beans.IntrospectionException;
 import java.beans.Introspector;
 import java.beans.PropertyDescriptor;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PrintStream;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.Map;
 
 
 /**
  * Utilities for logging.
  *
  * @author Manfred Geiler (latest modification by $Author: skitching $)
  * @version $Revision: 684465 $ $Date: 2008-08-10 06:38:21 -0500 (Sun, 10 Aug 2008) $
  */
 public class DebugUtils
 {
     private static final Log log = LogFactory.getLog(DebugUtils.class);
 
     //Attributes that should not be printed
     private static final HashSet<String> IGNORE_ATTRIBUTES;
     static
     {
         IGNORE_ATTRIBUTES = new HashSet<String>();
         IGNORE_ATTRIBUTES.add("attributes");
         IGNORE_ATTRIBUTES.add("children");
         IGNORE_ATTRIBUTES.add("childCount");
         IGNORE_ATTRIBUTES.add("class");
         IGNORE_ATTRIBUTES.add("facets");
         IGNORE_ATTRIBUTES.add("facetsAndChildren");
         IGNORE_ATTRIBUTES.add("parent");
         IGNORE_ATTRIBUTES.add("actionListeners");
         IGNORE_ATTRIBUTES.add("valueChangeListeners");
         IGNORE_ATTRIBUTES.add("validators");
         IGNORE_ATTRIBUTES.add("rowData");
         IGNORE_ATTRIBUTES.add("javax.faces.webapp.COMPONENT_IDS");
         IGNORE_ATTRIBUTES.add("javax.faces.webapp.FACET_NAMES");
         IGNORE_ATTRIBUTES.add("javax.faces.webapp.CURRENT_VIEW_ROOT");
     }
 
     private static final String JSF_COMPONENT_PACKAGE = "javax.faces.component.";
     private static final String MYFACES_COMPONENT_PACKAGE = "org.apache.myfaces.component.";
 
 
     private DebugUtils()
     {
         // hide from public access
     }
 
     public static void assertError(boolean condition, Log log_, String msg)
             throws FacesException
     {
         if (!condition)
         {
             log_.error(msg);
             throw new FacesException(msg);
         }
     }
 
     public static void assertFatal(boolean condition, Log log_, String msg)
         throws FacesException
     {
         if (!condition)
         {
             log_.fatal(msg);
             throw new FacesException(msg);
         }
     }
 
 
 
     public static void traceView(String additionalMsg)
     {
         if (log.isTraceEnabled())
         {
             FacesContext facesContext = FacesContext.getCurrentInstance();
             if (facesContext == null)
             {
                 log.error("Cannot not print view to console (no FacesContext).");
                 return;
             }
             UIViewRoot viewRoot = facesContext.getViewRoot();
             if (viewRoot == null)
             {
                 log.error("Cannot not print view to console (no ViewRoot in FacesContext).");
                 return;
             }
 
             traceView(additionalMsg, viewRoot);
         }
     }
 
     /**
      * Be careful, when using this version of traceView:
      * Some component properties (e.g. getRenderer) assume, that there is a
      * valid viewRoot set in the FacesContext!
      * @param additionalMsg
      * @param viewRoot
      */
     private static void traceView(String additionalMsg, UIViewRoot viewRoot)
     {
         ByteArrayOutputStream baos = new ByteArrayOutputStream();
         PrintStream ps = new PrintStream(baos);
         if (additionalMsg != null)
         {
             ps.println(additionalMsg);
         }
         ps.println("========================================");
         printView(viewRoot, ps);
         ps.println("========================================");
         ps.close();
         log.trace(baos.toString());
     }
 
     public static void printView(UIViewRoot uiViewRoot, PrintStream stream)
     {
         printComponent(uiViewRoot, stream, 0, true, null);
     }
 
     public static void printComponent(UIComponent comp, PrintStream stream)
     {
         printComponent(comp, stream, 0, false, null);
     }
 
     private static void printComponent(UIComponent comp,
                                        PrintStream stream,
                                        int indent,
                                        boolean withChildrenAndFacets,
                                        String facetName)
     {
         printIndent(stream, indent);
         stream.print('<');
 
         String compType = comp.getClass().getName();
         if (compType.startsWith(JSF_COMPONENT_PACKAGE))
         {
             compType = compType.substring(JSF_COMPONENT_PACKAGE.length());
         }
         else if (compType.startsWith(MYFACES_COMPONENT_PACKAGE))
         {
             compType = compType.substring(MYFACES_COMPONENT_PACKAGE.length());
         }
         stream.print(compType);
 
         printAttribute(stream, "id", comp.getId());
 
         if (facetName != null)
         {
             printAttribute(stream, "facetName", facetName);
         }
 
         for (Iterator it = comp.getAttributes().entrySet().iterator(); it.hasNext(); )
         {
             Map.Entry entry = (Map.Entry)it.next();
             if (!"id".equals(entry.getKey()))
             {
                 printAttribute(stream, (String)entry.getKey(), entry.getValue());
             }
         }
 
         //HACK: comp.getAttributes() only returns attributes, that are NOT backed
         //by a corresponding component property. So, we must explicitly get the
         //available properties by Introspection:
         BeanInfo beanInfo;
         try
         {
             beanInfo = Introspector.getBeanInfo(comp.getClass());
         }
         catch (IntrospectionException e)
         {
             throw new RuntimeException(e);
         }
 
         PropertyDescriptor propDescriptors[] = beanInfo.getPropertyDescriptors();
         for (int i = 0; i < propDescriptors.length; i++)
         {
             if (propDescriptors[i].getReadMethod() != null)
             {
                 String name = propDescriptors[i].getName();
                 if (!"id".equals(name))
                 {
                     ValueBinding vb = comp.getValueBinding(name);
                     if (vb != null)
                     {
                         printAttribute(stream, name, vb.getExpressionString());
                     }
                     else
                     {
                         if (name.equals("value") && comp instanceof ValueHolder)
                         {
                             //-> localValue
                         }
                         else if (!IGNORE_ATTRIBUTES.contains(name))
                         {
                             try
                             {
                                 Object value = comp.getAttributes().get(name);
                                 printAttribute(stream, name, value);
                             }
                             catch (Exception e)
                             {
                                 log.error(e);
                                 printAttribute(stream, name, null);
                             }
                         }
                     }
                 }
             }
         }
 
         boolean mustClose = true;
         boolean nestedObjects = false;
 
         if (comp instanceof UICommand)
         {
             FacesListener[] listeners = ((UICommand)comp).getActionListeners();
             if (listeners != null && listeners.length > 0)
             {
                 nestedObjects = true;
                 stream.println('>'); mustClose = false;
                 for (int i = 0; i < listeners.length; i++)
                 {
                     FacesListener listener = listeners[i];
                     printIndent(stream, indent + 1);
                     stream.print('<');
                     stream.print(listener.getClass().getName());
                     stream.println("/>");
                 }
             }
         }
 
         if (comp instanceof UIInput)
         {
             FacesListener[] listeners = ((UIInput)comp).getValueChangeListeners();
             if (listeners != null && listeners.length > 0)
             {
                 nestedObjects = true;
                 stream.println('>'); mustClose = false;
                 for (int i = 0; i < listeners.length; i++)
                 {
                     FacesListener listener = listeners[i];
                     printIndent(stream, indent + 1);
                     stream.print('<');
                     stream.print(listener.getClass().getName());
                     stream.println("/>");
                 }
             }
 
             Validator[] validators = ((UIInput)comp).getValidators();
             if (validators != null && validators.length > 0)
             {
                 nestedObjects = true;
                 stream.println('>'); mustClose = false;
                 for (int i = 0; i < validators.length; i++)
                 {
                     Validator validator = validators[i];
                     printIndent(stream, indent + 1);
                     stream.print('<');
                     stream.print(validator.getClass().getName());
                     stream.println("/>");
                 }
             }
         }
 
         if (withChildrenAndFacets)
         {
             int childCount = comp.getChildCount();
             Map<String, UIComponent> facetsMap = comp.getFacets();
             if (childCount > 0 || !facetsMap.isEmpty())
             {
                 nestedObjects = true;
                 if (mustClose)
                 {
                     stream.println('>');
                     mustClose = false;
                 }
 
                 if (childCount > 0)
                 {
                     for (Iterator it = comp.getChildren().iterator(); it.hasNext(); )
                     {
                         UIComponent child = (UIComponent)it.next();
                         printComponent(child, stream, indent + 1, true, null);
                     }
                 }
 
                 for (Iterator it = facetsMap.entrySet().iterator(); it.hasNext(); )
                 {
                     Map.Entry entry = (Map.Entry)it.next();
                     printComponent((UIComponent)entry.getValue(),
                                    stream, indent + 1, true,
                                    (String)entry.getKey());
                 }
             }
         }
 
         if (nestedObjects)
         {
             if (mustClose)
             {
                 stream.println("/>");
             }
             else
             {
                 printIndent(stream, indent);
                 stream.print("</");
                 stream.print(compType);
                 stream.println('>');
             }
         }
         else
         {
             stream.println("/>");
         }
     }
 
     private static void printAttribute(PrintStream stream,
                                        String name,
                                        Object value)
     {
         if (IGNORE_ATTRIBUTES.contains(name)) return;
         if (name.startsWith("javax.faces.webapp.UIComponentTag."))
         {
             name = name.substring("javax.faces.webapp.UIComponentTag.".length());
         }
         stream.print(' ');
         stream.print(name.toString());
         stream.print("=\"");
         if (value != null)
         {
             if (value instanceof UIComponent)
             {
                 stream.print("[id:");
                 stream.print(((UIComponent)value).getId());
                 stream.print(']');
             }
             else if (value instanceof MethodBinding)
             {
                 stream.print(((MethodBinding)value).getExpressionString());
             }
             else
             {
                 stream.print(value.toString());
             }
         }
         else
         {
             stream.print("NULL");
         }
         stream.print('"');
     }
 
 
     private static void printIndent(PrintStream stream, int depth)
     {
         for (int i = 0; i < depth; i++)
         {
             stream.print("  ");
         }
     }
 
     public static String componentAsString(UIComponent comp)
     {
         try
         {
             ByteArrayOutputStream baos = new ByteArrayOutputStream();
             printComponent(comp, new PrintStream(baos));
             baos.close();
             return baos.toString();
         }
         catch (IOException e)
         {
             throw new RuntimeException(e);
         }
     }
 }

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.util;
20
21		import org.apache.commons.logging.Log;
22		import org.apache.commons.logging.LogFactory;
23
24		import javax.faces.FacesException;
25		import javax.faces.component.*;
26		import javax.faces.context.FacesContext;
27		import javax.faces.el.MethodBinding;
28		import javax.faces.el.ValueBinding;
29		import javax.faces.event.FacesListener;
30		import javax.faces.validator.Validator;
31		import java.beans.BeanInfo;
32		import java.beans.IntrospectionException;
33		import java.beans.Introspector;
34		import java.beans.PropertyDescriptor;
35		import java.io.ByteArrayOutputStream;
36		import java.io.IOException;
37		import java.io.PrintStream;
38		import java.util.HashSet;
39		import java.util.Iterator;
40		import java.util.Map;
41
42
43		/**
44		* Utilities for logging.
45		*
46		* @author Manfred Geiler (latest modification by $Author: skitching $)
47		* @version $Revision: 684465 $ $Date: 2008-08-10 06:38:21 -0500 (Sun, 10 Aug 2008) $
48		*/
49		public class DebugUtils
50		{
51	0	private static final Log log = LogFactory.getLog(DebugUtils.class);
52
53		//Attributes that should not be printed
54		private static final HashSet<String> IGNORE_ATTRIBUTES;
55		static
56		{
57	0	IGNORE_ATTRIBUTES = new HashSet<String>();
58	0	IGNORE_ATTRIBUTES.add("attributes");
59	0	IGNORE_ATTRIBUTES.add("children");
60	0	IGNORE_ATTRIBUTES.add("childCount");
61	0	IGNORE_ATTRIBUTES.add("class");
62	0	IGNORE_ATTRIBUTES.add("facets");
63	0	IGNORE_ATTRIBUTES.add("facetsAndChildren");
64	0	IGNORE_ATTRIBUTES.add("parent");
65	0	IGNORE_ATTRIBUTES.add("actionListeners");
66	0	IGNORE_ATTRIBUTES.add("valueChangeListeners");
67	0	IGNORE_ATTRIBUTES.add("validators");
68	0	IGNORE_ATTRIBUTES.add("rowData");
69	0	IGNORE_ATTRIBUTES.add("javax.faces.webapp.COMPONENT_IDS");
70	0	IGNORE_ATTRIBUTES.add("javax.faces.webapp.FACET_NAMES");
71	0	IGNORE_ATTRIBUTES.add("javax.faces.webapp.CURRENT_VIEW_ROOT");
72	0	}
73
74		private static final String JSF_COMPONENT_PACKAGE = "javax.faces.component.";
75		private static final String MYFACES_COMPONENT_PACKAGE = "org.apache.myfaces.component.";
76
77
78		private DebugUtils()
79	0	{
80		// hide from public access
81	0	}
82
83		public static void assertError(boolean condition, Log log_, String msg)
84		throws FacesException
85		{
86	0	if (!condition)
87		{
88	0	log_.error(msg);
89	0	throw new FacesException(msg);
90		}
91	0	}
92
93		public static void assertFatal(boolean condition, Log log_, String msg)
94		throws FacesException
95		{
96	0	if (!condition)
97		{
98	0	log_.fatal(msg);
99	0	throw new FacesException(msg);
100		}
101	0	}
102
103
104
105		public static void traceView(String additionalMsg)
106		{
107	0	if (log.isTraceEnabled())
108		{
109	0	FacesContext facesContext = FacesContext.getCurrentInstance();
110	0	if (facesContext == null)
111		{
112	0	log.error("Cannot not print view to console (no FacesContext).");
113	0	return;
114		}
115	0	UIViewRoot viewRoot = facesContext.getViewRoot();
116	0	if (viewRoot == null)
117		{
118	0	log.error("Cannot not print view to console (no ViewRoot in FacesContext).");
119	0	return;
120		}
121
122	0	traceView(additionalMsg, viewRoot);
123		}
124	0	}
125
126		/**
127		* Be careful, when using this version of traceView:
128		* Some component properties (e.g. getRenderer) assume, that there is a
129		* valid viewRoot set in the FacesContext!
130		* @param additionalMsg
131		* @param viewRoot
132		*/
133		private static void traceView(String additionalMsg, UIViewRoot viewRoot)
134		{
135	0	ByteArrayOutputStream baos = new ByteArrayOutputStream();
136	0	PrintStream ps = new PrintStream(baos);
137	0	if (additionalMsg != null)
138		{
139	0	ps.println(additionalMsg);
140		}
141	0	ps.println("========================================");
142	0	printView(viewRoot, ps);
143	0	ps.println("========================================");
144	0	ps.close();
145	0	log.trace(baos.toString());
146	0	}
147
148		public static void printView(UIViewRoot uiViewRoot, PrintStream stream)
149		{
150	0	printComponent(uiViewRoot, stream, 0, true, null);
151	0	}
152
153		public static void printComponent(UIComponent comp, PrintStream stream)
154		{
155	0	printComponent(comp, stream, 0, false, null);
156	0	}
157
158		private static void printComponent(UIComponent comp,
159		PrintStream stream,
160		int indent,
161		boolean withChildrenAndFacets,
162		String facetName)
163		{
164	0	printIndent(stream, indent);
165	0	stream.print('<');
166
167	0	String compType = comp.getClass().getName();
168	0	if (compType.startsWith(JSF_COMPONENT_PACKAGE))
169		{
170	0	compType = compType.substring(JSF_COMPONENT_PACKAGE.length());
171		}
172	0	else if (compType.startsWith(MYFACES_COMPONENT_PACKAGE))
173		{
174	0	compType = compType.substring(MYFACES_COMPONENT_PACKAGE.length());
175		}
176	0	stream.print(compType);
177
178	0	printAttribute(stream, "id", comp.getId());
179
180	0	if (facetName != null)
181		{
182	0	printAttribute(stream, "facetName", facetName);
183		}
184
185	0	for (Iterator it = comp.getAttributes().entrySet().iterator(); it.hasNext(); )
186		{
187	0	Map.Entry entry = (Map.Entry)it.next();
188	0	if (!"id".equals(entry.getKey()))
189		{
190	0	printAttribute(stream, (String)entry.getKey(), entry.getValue());
191		}
192	0	}
193
194		//HACK: comp.getAttributes() only returns attributes, that are NOT backed
195		//by a corresponding component property. So, we must explicitly get the
196		//available properties by Introspection:
197		BeanInfo beanInfo;
198		try
199		{
200	0	beanInfo = Introspector.getBeanInfo(comp.getClass());
201		}
202	0	catch (IntrospectionException e)
203		{
204	0	throw new RuntimeException(e);
205	0	}
206
207	0	PropertyDescriptor propDescriptors[] = beanInfo.getPropertyDescriptors();
208	0	for (int i = 0; i < propDescriptors.length; i++)
209		{
210	0	if (propDescriptors[i].getReadMethod() != null)
211		{
212	0	String name = propDescriptors[i].getName();
213	0	if (!"id".equals(name))
214		{
215	0	ValueBinding vb = comp.getValueBinding(name);
216	0	if (vb != null)
217		{
218	0	printAttribute(stream, name, vb.getExpressionString());
219		}
220		else
221		{
222	0	if (name.equals("value") && comp instanceof ValueHolder)
223		{
224		//-> localValue
225		}
226	0	else if (!IGNORE_ATTRIBUTES.contains(name))
227		{
228		try
229		{
230	0	Object value = comp.getAttributes().get(name);
231	0	printAttribute(stream, name, value);
232		}
233	0	catch (Exception e)
234		{
235	0	log.error(e);
236	0	printAttribute(stream, name, null);
237	0	}
238		}
239		}
240		}
241		}
242		}
243
244	0	boolean mustClose = true;
245	0	boolean nestedObjects = false;
246
247	0	if (comp instanceof UICommand)
248		{
249	0	FacesListener[] listeners = ((UICommand)comp).getActionListeners();
250	0	if (listeners != null && listeners.length > 0)
251		{
252	0	nestedObjects = true;
253	0	stream.println('>'); mustClose = false;
254	0	for (int i = 0; i < listeners.length; i++)
255		{
256	0	FacesListener listener = listeners[i];
257	0	printIndent(stream, indent + 1);
258	0	stream.print('<');
259	0	stream.print(listener.getClass().getName());
260	0	stream.println("/>");
261		}
262		}
263		}
264
265	0	if (comp instanceof UIInput)
266		{
267	0	FacesListener[] listeners = ((UIInput)comp).getValueChangeListeners();
268	0	if (listeners != null && listeners.length > 0)
269		{
270	0	nestedObjects = true;
271	0	stream.println('>'); mustClose = false;
272	0	for (int i = 0; i < listeners.length; i++)
273		{
274	0	FacesListener listener = listeners[i];
275	0	printIndent(stream, indent + 1);
276	0	stream.print('<');
277	0	stream.print(listener.getClass().getName());
278	0	stream.println("/>");
279		}
280		}
281
282	0	Validator[] validators = ((UIInput)comp).getValidators();
283	0	if (validators != null && validators.length > 0)
284		{
285	0	nestedObjects = true;
286	0	stream.println('>'); mustClose = false;
287	0	for (int i = 0; i < validators.length; i++)
288		{
289	0	Validator validator = validators[i];
290	0	printIndent(stream, indent + 1);
291	0	stream.print('<');
292	0	stream.print(validator.getClass().getName());
293	0	stream.println("/>");
294		}
295		}
296		}
297
298	0	if (withChildrenAndFacets)
299		{
300	0	int childCount = comp.getChildCount();
301	0	Map<String, UIComponent> facetsMap = comp.getFacets();
302	0	if (childCount > 0 \|\| !facetsMap.isEmpty())
303		{
304	0	nestedObjects = true;
305	0	if (mustClose)
306		{
307	0	stream.println('>');
308	0	mustClose = false;
309		}
310
311	0	if (childCount > 0)
312		{
313	0	for (Iterator it = comp.getChildren().iterator(); it.hasNext(); )
314		{
315	0	UIComponent child = (UIComponent)it.next();
316	0	printComponent(child, stream, indent + 1, true, null);
317	0	}
318		}
319
320	0	for (Iterator it = facetsMap.entrySet().iterator(); it.hasNext(); )
321		{
322	0	Map.Entry entry = (Map.Entry)it.next();
323	0	printComponent((UIComponent)entry.getValue(),
324		stream, indent + 1, true,
325		(String)entry.getKey());
326	0	}
327		}
328		}
329
330	0	if (nestedObjects)
331		{
332	0	if (mustClose)
333		{
334	0	stream.println("/>");
335		}
336		else
337		{
338	0	printIndent(stream, indent);
339	0	stream.print("</");
340	0	stream.print(compType);
341	0	stream.println('>');
342		}
343		}
344		else
345		{
346	0	stream.println("/>");
347		}
348	0	}
349
350		private static void printAttribute(PrintStream stream,
351		String name,
352		Object value)
353		{
354	0	if (IGNORE_ATTRIBUTES.contains(name)) return;
355	0	if (name.startsWith("javax.faces.webapp.UIComponentTag."))
356		{
357	0	name = name.substring("javax.faces.webapp.UIComponentTag.".length());
358		}
359	0	stream.print(' ');
360	0	stream.print(name.toString());
361	0	stream.print("=\"");
362	0	if (value != null)
363		{
364	0	if (value instanceof UIComponent)
365		{
366	0	stream.print("[id:");
367	0	stream.print(((UIComponent)value).getId());
368	0	stream.print(']');
369		}
370	0	else if (value instanceof MethodBinding)
371		{
372	0	stream.print(((MethodBinding)value).getExpressionString());
373		}
374		else
375		{
376	0	stream.print(value.toString());
377		}
378		}
379		else
380		{
381	0	stream.print("NULL");
382		}
383	0	stream.print('"');
384	0	}
385
386
387		private static void printIndent(PrintStream stream, int depth)
388		{
389	0	for (int i = 0; i < depth; i++)
390		{
391	0	stream.print(" ");
392		}
393	0	}
394
395		public static String componentAsString(UIComponent comp)
396		{
397		try
398		{
399	0	ByteArrayOutputStream baos = new ByteArrayOutputStream();
400	0	printComponent(comp, new PrintStream(baos));
401	0	baos.close();
402	0	return baos.toString();
403		}
404	0	catch (IOException e)
405		{
406	0	throw new RuntimeException(e);
407		}
408		}
409		}