1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.util;
24  
25  import java.text.DateFormat;
26  
27  import java.util.Date;
28  import java.util.Enumeration;
29  
30  import javax.portlet.PortletRequest;
31  
32  import javax.servlet.http.HttpServletRequest;
33  
34  /**
35   * <a href="ParamUtil.java.html"><b><i>View Source</i></b></a>
36   *
37   * @author Brian Wing Shun Chan
38   * @author Raymond Augé
39   */
40  public class ParamUtil {
41  
42      // Servlet Request
43  
44      public static boolean getBoolean(HttpServletRequest request, String param) {
45          return GetterUtil.getBoolean(request.getParameter(param));
46      }
47  
48      public static boolean getBoolean(
49          HttpServletRequest request, String param, boolean defaultValue) {
50  
51          return get(request, param, defaultValue);
52      }
53  
54      public static boolean[] getBooleanValues(
55          HttpServletRequest request, String param) {
56  
57          return getBooleanValues(request, param, new boolean[0]);
58      }
59  
60      public static boolean[] getBooleanValues(
61          HttpServletRequest request, String param, boolean[] defaultValue) {
62  
63          return GetterUtil.getBooleanValues(
64              request.getParameterValues(param), defaultValue);
65      }
66  
67      public static Date getDate(
68          HttpServletRequest request, String param, DateFormat df) {
69  
70          return GetterUtil.getDate(request.getParameter(param), df);
71      }
72  
73      public static Date getDate(
74          HttpServletRequest request, String param, DateFormat df,
75          Date defaultValue) {
76  
77          return get(request, param, df, defaultValue);
78      }
79  
80      public static double getDouble(HttpServletRequest request, String param) {
81          return GetterUtil.getDouble(request.getParameter(param));
82      }
83  
84      public static double getDouble(
85          HttpServletRequest request, String param, double defaultValue) {
86  
87          return get(request, param, defaultValue);
88      }
89  
90      public static double[] getDoubleValues(
91          HttpServletRequest request, String param) {
92  
93          return getDoubleValues(request, param, new double[0]);
94      }
95  
96      public static double[] getDoubleValues(
97          HttpServletRequest request, String param, double[] defaultValue) {
98  
99          return GetterUtil.getDoubleValues(
100             request.getParameterValues(param), defaultValue);
101     }
102 
103     public static float getFloat(HttpServletRequest request, String param) {
104         return GetterUtil.getFloat(request.getParameter(param));
105     }
106 
107     public static float getFloat(
108         HttpServletRequest request, String param, float defaultValue) {
109 
110         return get(request, param, defaultValue);
111     }
112 
113     public static float[] getFloatValues(
114         HttpServletRequest request, String param) {
115 
116         return getFloatValues(request, param, new float[0]);
117     }
118 
119     public static float[] getFloatValues(
120         HttpServletRequest request, String param, float[] defaultValue) {
121 
122         return GetterUtil.getFloatValues(
123             request.getParameterValues(param), defaultValue);
124     }
125 
126     public static int getInteger(HttpServletRequest request, String param) {
127         return GetterUtil.getInteger(request.getParameter(param));
128     }
129 
130     public static int getInteger(
131         HttpServletRequest request, String param, int defaultValue) {
132 
133         return get(request, param, defaultValue);
134     }
135 
136     public static int[] getIntegerValues(
137         HttpServletRequest request, String param) {
138 
139         return getIntegerValues(request, param, new int[0]);
140     }
141 
142     public static int[] getIntegerValues(
143         HttpServletRequest request, String param, int[] defaultValue) {
144 
145         return GetterUtil.getIntegerValues(
146             request.getParameterValues(param), defaultValue);
147     }
148 
149     public static long getLong(HttpServletRequest request, String param) {
150         return GetterUtil.getLong(request.getParameter(param));
151     }
152 
153     public static long getLong(
154         HttpServletRequest request, String param, long defaultValue) {
155 
156         return get(request, param, defaultValue);
157     }
158 
159     public static long[] getLongValues(
160         HttpServletRequest request, String param) {
161 
162         return getLongValues(request, param, new long[0]);
163     }
164 
165     public static long[] getLongValues(
166         HttpServletRequest request, String param, long[] defaultValue) {
167 
168         return GetterUtil.getLongValues(
169             request.getParameterValues(param), defaultValue);
170     }
171 
172     public static short getShort(HttpServletRequest request, String param) {
173         return GetterUtil.getShort(request.getParameter(param));
174     }
175 
176     public static short getShort(
177         HttpServletRequest request, String param, short defaultValue) {
178 
179         return get(request, param, defaultValue);
180     }
181 
182     public static short[] getShortValues(
183         HttpServletRequest request, String param) {
184 
185         return getShortValues(request, param, new short[0]);
186     }
187 
188     public static short[] getShortValues(
189         HttpServletRequest request, String param, short[] defaultValue) {
190 
191         return GetterUtil.getShortValues(
192             request.getParameterValues(param), defaultValue);
193     }
194 
195     public static String getString(HttpServletRequest request, String param) {
196         return GetterUtil.getString(request.getParameter(param));
197     }
198 
199     public static String getString(
200         HttpServletRequest request, String param, String defaultValue) {
201 
202         return get(request, param, defaultValue);
203     }
204 
205     public static boolean get(
206         HttpServletRequest request, String param, boolean defaultValue) {
207 
208         return GetterUtil.get(request.getParameter(param), defaultValue);
209     }
210 
211     public static Date get(
212         HttpServletRequest request, String param, DateFormat df,
213         Date defaultValue) {
214 
215         return GetterUtil.get(request.getParameter(param), df, defaultValue);
216     }
217 
218     public static double get(
219         HttpServletRequest request, String param, double defaultValue) {
220 
221         return GetterUtil.get(request.getParameter(param), defaultValue);
222     }
223 
224     public static float get(
225         HttpServletRequest request, String param, float defaultValue) {
226 
227         return GetterUtil.get(request.getParameter(param), defaultValue);
228     }
229 
230     public static int get(
231         HttpServletRequest request, String param, int defaultValue) {
232 
233         return GetterUtil.get(request.getParameter(param), defaultValue);
234     }
235 
236     public static long get(
237         HttpServletRequest request, String param, long defaultValue) {
238 
239         return GetterUtil.get(request.getParameter(param), defaultValue);
240     }
241 
242     public static short get(
243         HttpServletRequest request, String param, short defaultValue) {
244 
245         return GetterUtil.get(request.getParameter(param), defaultValue);
246     }
247 
248     public static String get(
249         HttpServletRequest request, String param, String defaultValue) {
250 
251         String returnValue =
252             GetterUtil.get(request.getParameter(param), defaultValue);
253 
254         if (returnValue != null) {
255             return returnValue.trim();
256         }
257 
258         return null;
259     }
260 
261     public static void print(HttpServletRequest request) {
262         Enumeration<String> enu = request.getParameterNames();
263 
264         while (enu.hasMoreElements()) {
265             String param = enu.nextElement();
266 
267             String[] values = request.getParameterValues(param);
268 
269             for (int i = 0; i < values.length; i++) {
270                 System.out.println(param + "[" + i + "] = " + values[i]);
271             }
272         }
273     }
274 
275     // Portlet Request
276 
277     public static boolean getBoolean(
278         PortletRequest portletRequest, String param) {
279 
280         return GetterUtil.getBoolean(portletRequest.getParameter(param));
281     }
282 
283     public static boolean getBoolean(
284         PortletRequest portletRequest, String param, boolean defaultValue) {
285 
286         return get(portletRequest, param, defaultValue);
287     }
288 
289     public static boolean[] getBooleanValues(
290         PortletRequest portletRequest, String param) {
291 
292         return getBooleanValues(portletRequest, param, new boolean[0]);
293     }
294 
295     public static boolean[] getBooleanValues(
296         PortletRequest portletRequest, String param, boolean[] defaultValue) {
297 
298         return GetterUtil.getBooleanValues(
299             portletRequest.getParameterValues(param), defaultValue);
300     }
301 
302     public static Date getDate(
303         PortletRequest portletRequest, String param, DateFormat df) {
304 
305         return GetterUtil.getDate(portletRequest.getParameter(param), df);
306     }
307 
308     public static Date getDate(
309         PortletRequest portletRequest, String param, DateFormat df,
310         Date defaultValue) {
311 
312         return get(portletRequest, param, df, defaultValue);
313     }
314 
315     public static double getDouble(
316         PortletRequest portletRequest, String param) {
317 
318         return GetterUtil.getDouble(portletRequest.getParameter(param));
319     }
320 
321     public static double getDouble(
322         PortletRequest portletRequest, String param, double defaultValue) {
323 
324         return get(portletRequest, param, defaultValue);
325     }
326 
327     public static double[] getDoubleValues(
328         PortletRequest portletRequest, String param) {
329 
330         return getDoubleValues(portletRequest, param, new double[0]);
331     }
332 
333     public static double[] getDoubleValues(
334         PortletRequest portletRequest, String param, double[] defaultValue) {
335 
336         return GetterUtil.getDoubleValues(
337             portletRequest.getParameterValues(param), defaultValue);
338     }
339 
340     public static float getFloat(PortletRequest portletRequest, String param) {
341         return GetterUtil.getFloat(portletRequest.getParameter(param));
342     }
343 
344     public static float getFloat(
345         PortletRequest portletRequest, String param, float defaultValue) {
346 
347         return get(portletRequest, param, defaultValue);
348     }
349 
350     public static float[] getFloatValues(
351         PortletRequest portletRequest, String param) {
352 
353         return getFloatValues(portletRequest, param, new float[0]);
354     }
355 
356     public static float[] getFloatValues(
357         PortletRequest portletRequest, String param, float[] defaultValue) {
358 
359         return GetterUtil.getFloatValues(
360             portletRequest.getParameterValues(param), defaultValue);
361     }
362 
363     public static int getInteger(PortletRequest portletRequest, String param) {
364         return GetterUtil.getInteger(portletRequest.getParameter(param));
365     }
366 
367     public static int getInteger(
368         PortletRequest portletRequest, String param, int defaultValue) {
369 
370         return get(portletRequest, param, defaultValue);
371     }
372 
373     public static int[] getIntegerValues(
374         PortletRequest portletRequest, String param) {
375 
376         return getIntegerValues(portletRequest, param, new int[0]);
377     }
378 
379     public static int[] getIntegerValues(
380         PortletRequest portletRequest, String param, int[] defaultValue) {
381 
382         return GetterUtil.getIntegerValues(
383             portletRequest.getParameterValues(param), defaultValue);
384     }
385 
386     public static long getLong(PortletRequest portletRequest, String param) {
387         return GetterUtil.getLong(portletRequest.getParameter(param));
388     }
389 
390     public static long getLong(
391         PortletRequest portletRequest, String param, long defaultValue) {
392 
393         return get(portletRequest, param, defaultValue);
394     }
395 
396     public static long[] getLongValues(
397         PortletRequest portletRequest, String param) {
398 
399         return getLongValues(portletRequest, param, new long[0]);
400     }
401 
402     public static long[] getLongValues(
403         PortletRequest portletRequest, String param, long[] defaultValue) {
404 
405         return GetterUtil.getLongValues(
406             portletRequest.getParameterValues(param), defaultValue);
407     }
408 
409     public static short getShort(PortletRequest portletRequest, String param) {
410         return GetterUtil.getShort(portletRequest.getParameter(param));
411     }
412 
413     public static short getShort(
414         PortletRequest portletRequest, String param, short defaultValue) {
415 
416         return get(portletRequest, param, defaultValue);
417     }
418 
419     public static short[] getShortValues(
420         PortletRequest portletRequest, String param) {
421 
422         return getShortValues(portletRequest, param, new short[0]);
423     }
424 
425     public static short[] getShortValues(
426         PortletRequest portletRequest, String param, short[] defaultValue) {
427 
428         return GetterUtil.getShortValues(
429             portletRequest.getParameterValues(param), defaultValue);
430     }
431 
432     public static String getString(
433         PortletRequest portletRequest, String param) {
434 
435         return GetterUtil.getString(portletRequest.getParameter(param));
436     }
437 
438     public static String getString(
439         PortletRequest portletRequest, String param, String defaultValue) {
440 
441         return get(portletRequest, param, defaultValue);
442     }
443 
444     public static boolean get(
445         PortletRequest portletRequest, String param, boolean defaultValue) {
446 
447         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
448     }
449 
450     public static Date get(
451         PortletRequest portletRequest, String param, DateFormat df,
452         Date defaultValue) {
453 
454         return GetterUtil.get(
455             portletRequest.getParameter(param), df, defaultValue);
456     }
457 
458     public static double get(
459         PortletRequest portletRequest, String param, double defaultValue) {
460 
461         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
462     }
463 
464     public static float get(
465         PortletRequest portletRequest, String param, float defaultValue) {
466 
467         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
468     }
469 
470     public static int get(
471         PortletRequest portletRequest, String param, int defaultValue) {
472 
473         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
474     }
475 
476     public static long get(
477         PortletRequest portletRequest, String param, long defaultValue) {
478 
479         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
480     }
481 
482     public static short get(
483         PortletRequest portletRequest, String param, short defaultValue) {
484 
485         return GetterUtil.get(portletRequest.getParameter(param), defaultValue);
486     }
487 
488     public static String get(
489         PortletRequest portletRequest, String param, String defaultValue) {
490 
491         String returnValue =
492             GetterUtil.get(portletRequest.getParameter(param), defaultValue);
493 
494         if (returnValue != null) {
495             return returnValue.trim();
496         }
497 
498         return null;
499     }
500 
501     public static void print(PortletRequest portletRequest) {
502         Enumeration<String> enu = portletRequest.getParameterNames();
503 
504         while (enu.hasMoreElements()) {
505             String param = enu.nextElement();
506 
507             String[] values = portletRequest.getParameterValues(param);
508 
509             for (int i = 0; i < values.length; i++) {
510                 System.out.println(param + "[" + i + "] = " + values[i]);
511             }
512         }
513     }
514 
515 }