1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.kernel.portlet;
16  
17  import com.liferay.portal.kernel.log.Log;
18  import com.liferay.portal.kernel.log.LogFactoryUtil;
19  import com.liferay.portal.util.PortalUtil;
20  
21  import java.util.Map;
22  
23  /**
24   * <a href="BaseFriendlyURLMapper.java.html"><b><i>View Source</i></b></a>
25   *
26   * @author Jorge Ferrer
27   * @author Brian Wing Shun Chan
28   */
29  public abstract class BaseFriendlyURLMapper implements FriendlyURLMapper {
30  
31      public abstract String getPortletId();
32  
33      public Router getRouter() {
34          return router;
35      }
36  
37      public boolean isCheckMappingWithPrefix() {
38          return _CHECK_MAPPING_WITH_PREFIX;
39      }
40  
41      public void setRouter(Router router) {
42          this.router = router;
43      }
44  
45      /**
46       * @deprecated
47       */
48      protected void addParam(
49          Map<String, String[]> parameterMap, String name, boolean value) {
50  
51          addParameter(parameterMap, name, value);
52      }
53  
54      /**
55       * @deprecated
56       */
57      protected void addParam(
58          Map<String, String[]> parameterMap, String name, double value) {
59  
60          addParameter(parameterMap, name, value);
61      }
62  
63      /**
64       * @deprecated
65       */
66      protected void addParam(
67          Map<String, String[]> parameterMap, String name, int value) {
68  
69          addParameter(parameterMap, name, value);
70      }
71  
72      /**
73       * @deprecated
74       */
75      protected void addParam(
76          Map<String, String[]> parameterMap, String name, long value) {
77  
78          addParameter(parameterMap, name, value);
79      }
80  
81      /**
82       * @deprecated
83       */
84      protected void addParam(
85          Map<String, String[]> parameterMap, String name, Object value) {
86  
87          addParameter(parameterMap, name, value);
88      }
89  
90      /**
91       * @deprecated
92       */
93      protected void addParam(
94          Map<String, String[]> parameterMap, String name, short value) {
95  
96          addParameter(parameterMap, name, value);
97      }
98  
99      /**
100      * @deprecated
101      */
102     protected void addParam(
103         Map<String, String[]> parameterMap, String name, String value) {
104 
105         addParameter(parameterMap, name, value);
106     }
107 
108     protected void addParameter(
109         Map<String, String[]> parameterMap, String name, boolean value) {
110 
111         addParameter(parameterMap, name, String.valueOf(value));
112     }
113 
114     protected void addParameter(
115         Map<String, String[]> parameterMap, String name, double value) {
116 
117         addParameter(parameterMap, name, String.valueOf(value));
118     }
119 
120     protected void addParameter(
121         Map<String, String[]> parameterMap, String name, int value) {
122 
123         addParameter(parameterMap, name, String.valueOf(value));
124     }
125 
126     protected void addParameter(
127         Map<String, String[]> parameterMap, String name, long value) {
128 
129         addParameter(parameterMap, name, String.valueOf(value));
130     }
131 
132     protected void addParameter(
133         Map<String, String[]> parameterMap, String name, Object value) {
134 
135         addParameter(parameterMap, name, String.valueOf(value));
136     }
137 
138     protected void addParameter(
139         Map<String, String[]> parameterMap, String name, short value) {
140 
141         addParameter(parameterMap, name, String.valueOf(value));
142     }
143 
144     protected void addParameter(
145         Map<String, String[]> parameterMap, String name, String value) {
146 
147         try {
148             if (!PortalUtil.isReservedParameter(name)) {
149                 Map<String, String> prpIdentifers =
150                     FriendlyURLMapperThreadLocal.getPRPIdentifiers();
151 
152                 if (prpIdentifers.containsKey(name)) {
153                     name = prpIdentifers.get(name);
154                 }
155                 else {
156                     name = getNamespace() + name;
157                 }
158             }
159 
160             parameterMap.put(name, new String[] {value});
161         }
162         catch (Exception e) {
163             _log.error(e, e);
164         }
165     }
166 
167     protected String getNamespace() {
168         return PortalUtil.getPortletNamespace(getPortletId());
169     }
170 
171     protected Router router;
172 
173     private static final boolean _CHECK_MAPPING_WITH_PREFIX = true;
174 
175     private static Log _log = LogFactoryUtil.getLog(
176         BaseFriendlyURLMapper.class);
177 
178 }