001
014
015 package com.liferay.portal.kernel.portlet;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.model.Layout;
021 import com.liferay.portal.kernel.model.Portlet;
022 import com.liferay.portal.kernel.model.PortletPreferencesIds;
023 import com.liferay.portal.kernel.security.pacl.permission.PortalRuntimePermission;
024 import com.liferay.portal.kernel.theme.ThemeDisplay;
025
026 import java.util.Map;
027
028 import javax.portlet.PortletPreferences;
029 import javax.portlet.PortletRequest;
030 import javax.portlet.PreferencesValidator;
031
032 import javax.servlet.http.HttpServletRequest;
033 import javax.servlet.http.HttpSession;
034
035
038 @ProviderType
039 public class PortletPreferencesFactoryUtil {
040
041 public static void checkControlPanelPortletPreferences(
042 ThemeDisplay themeDisplay, Portlet portlet)
043 throws PortalException {
044
045 getPortletPreferencesFactory().checkControlPanelPortletPreferences(
046 themeDisplay, portlet);
047 }
048
049 public static PortletPreferences fromDefaultXML(String xml) {
050 return getPortletPreferencesFactory().fromDefaultXML(xml);
051 }
052
053 public static PortalPreferences fromXML(
054 long ownerId, int ownerType, String xml) {
055
056 return getPortletPreferencesFactory().fromXML(ownerId, ownerType, xml);
057 }
058
059 public static PortletPreferences fromXML(
060 long companyId, long ownerId, int ownerType, long plid,
061 String portletId, String xml) {
062
063 return getPortletPreferencesFactory().fromXML(
064 companyId, ownerId, ownerType, plid, portletId, xml);
065 }
066
067 public static PortletPreferences getExistingPortletSetup(
068 Layout layout, String portletId)
069 throws PortalException {
070
071 return getPortletPreferencesFactory().getExistingPortletSetup(
072 layout, portletId);
073 }
074
075 public static PortletPreferences getExistingPortletSetup(
076 PortletRequest portletRequest)
077 throws PortalException {
078
079 return getPortletPreferencesFactory().getExistingPortletSetup(
080 portletRequest);
081 }
082
083 public static PortletPreferences getLayoutPortletSetup(
084 Layout layout, String portletId) {
085
086 return getPortletPreferencesFactory().getLayoutPortletSetup(
087 layout, portletId);
088 }
089
090 public static PortletPreferences getLayoutPortletSetup(
091 Layout layout, String portletId, String defaultPreferences) {
092
093 return getPortletPreferencesFactory().getLayoutPortletSetup(
094 layout, portletId, defaultPreferences);
095 }
096
097 public static PortletPreferences getLayoutPortletSetup(
098 long companyId, long ownerId, int ownerType, long plid,
099 String portletId, String defaultPreferences) {
100
101 return getPortletPreferencesFactory().getLayoutPortletSetup(
102 companyId, ownerId, ownerType, plid, portletId, defaultPreferences);
103 }
104
105 public static PortalPreferences getPortalPreferences(
106 HttpServletRequest request) {
107
108 return getPortletPreferencesFactory().getPortalPreferences(request);
109 }
110
111 public static PortalPreferences getPortalPreferences(
112 HttpSession session, long userId, boolean signedIn) {
113
114 return getPortletPreferencesFactory().getPortalPreferences(
115 session, userId, signedIn);
116 }
117
118 public static PortalPreferences getPortalPreferences(
119 long userId, boolean signedIn) {
120
121 return getPortletPreferencesFactory().getPortalPreferences(
122 userId, signedIn);
123 }
124
125 public static PortalPreferences getPortalPreferences(
126 PortletRequest portletRequest) {
127
128 return getPortletPreferencesFactory().getPortalPreferences(
129 portletRequest);
130 }
131
132 public static PortletPreferences getPortletPreferences(
133 HttpServletRequest request, String portletId)
134 throws PortalException {
135
136 return getPortletPreferencesFactory().getPortletPreferences(
137 request, portletId);
138 }
139
140 public static PortletPreferencesFactory getPortletPreferencesFactory() {
141 PortalRuntimePermission.checkGetBeanProperty(
142 PortletPreferencesFactoryUtil.class);
143
144 return _portletPreferencesFactory;
145 }
146
147 public static PortletPreferencesIds getPortletPreferencesIds(
148 HttpServletRequest request, Layout selLayout, String portletId)
149 throws PortalException {
150
151 return getPortletPreferencesFactory().getPortletPreferencesIds(
152 request, selLayout, portletId);
153 }
154
155 public static PortletPreferencesIds getPortletPreferencesIds(
156 HttpServletRequest request, String portletId)
157 throws PortalException {
158
159 return getPortletPreferencesFactory().getPortletPreferencesIds(
160 request, portletId);
161 }
162
163 public static PortletPreferencesIds getPortletPreferencesIds(
164 long siteGroupId, long userId, Layout layout, String portletId,
165 boolean modeEditGuest)
166 throws PortalException {
167
168 return getPortletPreferencesFactory().getPortletPreferencesIds(
169 siteGroupId, userId, layout, portletId, modeEditGuest);
170 }
171
172 public static PortletPreferencesIds getPortletPreferencesIds(
173 long companyId, long siteGroupId, long plid, String portletId,
174 String settingsScope) {
175
176 return getPortletPreferencesFactory().getPortletPreferencesIds(
177 companyId, siteGroupId, plid, portletId, settingsScope);
178 }
179
180 public static PortletPreferences getPortletSetup(
181 HttpServletRequest request, String portletId)
182 throws PortalException {
183
184 return getPortletPreferencesFactory().getPortletSetup(
185 request, portletId);
186 }
187
188 public static PortletPreferences getPortletSetup(
189 HttpServletRequest request, String portletId,
190 String defaultPreferences)
191 throws PortalException {
192
193 return getPortletPreferencesFactory().getPortletSetup(
194 request, portletId, defaultPreferences);
195 }
196
197 public static PortletPreferences getPortletSetup(
198 Layout layout, String portletId, String defaultPreferences) {
199
200 return getPortletPreferencesFactory().getPortletSetup(
201 layout, portletId, defaultPreferences);
202 }
203
204 public static PortletPreferences getPortletSetup(
205 long siteGroupId, Layout layout, String portletId,
206 String defaultPreferences) {
207
208 return getPortletPreferencesFactory().getPortletSetup(
209 siteGroupId, layout, portletId, defaultPreferences);
210 }
211
212 public static PortletPreferences getPortletSetup(
213 PortletRequest portletRequest)
214 throws PortalException {
215
216 return getPortletPreferencesFactory().getPortletSetup(portletRequest);
217 }
218
219 public static PortletPreferences getPortletSetup(
220 PortletRequest portletRequest, String portletId)
221 throws PortalException {
222
223 return getPortletPreferencesFactory().getPortletSetup(
224 portletRequest, portletId);
225 }
226
227 public static Map<Long, PortletPreferences> getPortletSetupMap(
228 long companyId, long groupId, long ownerId, int ownerType,
229 String portletId, boolean privateLayout) {
230
231 return getPortletPreferencesFactory().getPortletSetupMap(
232 companyId, groupId, ownerId, ownerType, portletId, privateLayout);
233 }
234
235 public static PortletPreferences getPreferences(
236 HttpServletRequest request) {
237
238 return getPortletPreferencesFactory().getPreferences(request);
239 }
240
241 public static PreferencesValidator getPreferencesValidator(
242 Portlet portlet) {
243
244 return getPortletPreferencesFactory().getPreferencesValidator(portlet);
245 }
246
247 public static PortletPreferences getStrictLayoutPortletSetup(
248 Layout layout, String portletId) {
249
250 return getPortletPreferencesFactory().getStrictLayoutPortletSetup(
251 layout, portletId);
252 }
253
254 public static PortletPreferences getStrictPortletSetup(
255 Layout layout, String portletId) {
256
257 return getPortletPreferencesFactory().getStrictPortletSetup(
258 layout, portletId);
259 }
260
261 public static PortletPreferences getStrictPortletSetup(
262 long companyId, long groupId, String portletId) {
263
264 return getPortletPreferencesFactory().getStrictPortletSetup(
265 companyId, groupId, portletId);
266 }
267
268 public static PortletPreferences strictFromXML(
269 long companyId, long ownerId, int ownerType, long plid,
270 String portletId, String xml) {
271
272 return getPortletPreferencesFactory().strictFromXML(
273 companyId, ownerId, ownerType, plid, portletId, xml);
274 }
275
276 public static String toXML(PortalPreferences portalPreferences) {
277 return getPortletPreferencesFactory().toXML(portalPreferences);
278 }
279
280 public static String toXML(PortletPreferences portletPreferences) {
281 return getPortletPreferencesFactory().toXML(portletPreferences);
282 }
283
284 public void setPortletPreferencesFactory(
285 PortletPreferencesFactory portletPreferencesFactory) {
286
287 PortalRuntimePermission.checkSetBeanProperty(getClass());
288
289 _portletPreferencesFactory = portletPreferencesFactory;
290 }
291
292 private static PortletPreferencesFactory _portletPreferencesFactory;
293
294 }