001
014
015 package com.liferay.portal.util;
016
017 import com.liferay.portal.kernel.exception.PortalException;
018 import com.liferay.portal.kernel.exception.SystemException;
019 import com.liferay.portal.kernel.portlet.LiferayPortletRequest;
020 import com.liferay.portal.kernel.portlet.LiferayPortletResponse;
021 import com.liferay.portal.kernel.servlet.taglib.ui.BreadcrumbEntry;
022 import com.liferay.portal.kernel.upload.UploadPortletRequest;
023 import com.liferay.portal.kernel.upload.UploadServletRequest;
024 import com.liferay.portal.model.BaseModel;
025 import com.liferay.portal.model.Company;
026 import com.liferay.portal.model.Group;
027 import com.liferay.portal.model.Layout;
028 import com.liferay.portal.model.LayoutSet;
029 import com.liferay.portal.model.Portlet;
030 import com.liferay.portal.model.Resource;
031 import com.liferay.portal.model.ResourcePermission;
032 import com.liferay.portal.model.User;
033 import com.liferay.portal.theme.ThemeDisplay;
034 import com.liferay.portlet.expando.model.ExpandoBridge;
035
036 import java.io.IOException;
037 import java.io.Serializable;
038
039 import java.util.Date;
040 import java.util.List;
041 import java.util.Locale;
042 import java.util.Map;
043 import java.util.Properties;
044 import java.util.Set;
045 import java.util.TimeZone;
046
047 import javax.portlet.ActionRequest;
048 import javax.portlet.ActionResponse;
049 import javax.portlet.PortletMode;
050 import javax.portlet.PortletPreferences;
051 import javax.portlet.PortletRequest;
052 import javax.portlet.PortletResponse;
053 import javax.portlet.PreferencesValidator;
054 import javax.portlet.RenderRequest;
055 import javax.portlet.RenderResponse;
056 import javax.portlet.ValidatorException;
057 import javax.portlet.WindowState;
058
059 import javax.servlet.ServletContext;
060 import javax.servlet.ServletException;
061 import javax.servlet.http.HttpServletRequest;
062 import javax.servlet.http.HttpServletResponse;
063 import javax.servlet.http.HttpSession;
064 import javax.servlet.jsp.PageContext;
065
066
070 public interface Portal {
071
072 public static final String FRIENDLY_URL_SEPARATOR = "/-/";
073
074 public static final String PATH_IMAGE = "/image";
075
076 public static final String PATH_MAIN = "/c";
077
078 public static final String PATH_PORTAL_LAYOUT = "/portal/layout";
079
080 public static final String PORTAL_REALM = "PortalRealm";
081
082 public static final String PORTLET_XML_FILE_NAME_CUSTOM =
083 "portlet-custom.xml";
084
085 public static final String PORTLET_XML_FILE_NAME_STANDARD = "portlet.xml";
086
087 public static final String TEMP_OBFUSCATION_VALUE =
088 "TEMP_OBFUSCATION_VALUE";
089
090
097 public void addPageDescription(
098 String description, HttpServletRequest request);
099
100
107 public void addPageKeywords(String keywords, HttpServletRequest request);
108
109
115 public void addPageSubtitle(String subtitle, HttpServletRequest request);
116
117
123 public void addPageTitle(String title, HttpServletRequest request);
124
125
131 public void addPortalPortEventListener(
132 PortalPortEventListener portalPortEventListener);
133
134
141 public void addPortletBreadcrumbEntry(
142 HttpServletRequest request, String title, String url);
143
144
152 public void addPortletBreadcrumbEntry(
153 HttpServletRequest request, String title, String url,
154 Map<String, Object> data);
155
156
164 public void addPortletDefaultResource(
165 HttpServletRequest request, Portlet portlet)
166 throws PortalException, SystemException;
167
168 public void addPortletDefaultResource(
169 long companyId, Layout layout, Portlet portlet)
170 throws PortalException, SystemException;
171
172
189 public String addPreservedParameters(
190 ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser);
191
192
200 public String addPreservedParameters(ThemeDisplay themeDisplay, String url);
201
202
208 public void clearRequestParameters(RenderRequest renderRequest);
209
210
217 public void copyRequestParameters(
218 ActionRequest actionRequest, ActionResponse actionResponse);
219
220
228 public String escapeRedirect(String url);
229
230
237 public String generateRandomKey(HttpServletRequest request, String input);
238
239 public String getActualURL(
240 long groupId, boolean privateLayout, String mainPath,
241 String friendlyURL, Map<String, String[]> params,
242 Map<String, Object> requestContext)
243 throws PortalException, SystemException;
244
245
252 public Locale[] getAlternateLocales(HttpServletRequest request)
253 throws PortalException, SystemException;
254
255
258 public String getAlternateURL(
259 HttpServletRequest request, String canonicalURL, Locale locale);
260
261
270 public String getAlternateURL(
271 String canonicalURL, ThemeDisplay themeDisplay, Locale locale);
272
273
280 public Set<String> getAuthTokenIgnoreActions();
281
282
289 public Set<String> getAuthTokenIgnorePortlets();
290
291
301 public BaseModel<?> getBaseModel(Resource resource)
302 throws PortalException, SystemException;
303
304
315 public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
316 throws PortalException, SystemException;
317
318
329 public BaseModel<?> getBaseModel(String modelName, String primKey)
330 throws PortalException, SystemException;
331
332
343 public long getBasicAuthUserId(HttpServletRequest request)
344 throws PortalException, SystemException;
345
346
358 public long getBasicAuthUserId(HttpServletRequest request, long companyId)
359 throws PortalException, SystemException;
360
361
364 public String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay)
365 throws PortalException, SystemException;
366
367
380 public String getCanonicalURL(
381 String completeURL, ThemeDisplay themeDisplay, Layout layout)
382 throws PortalException, SystemException;
383
384
387 public String getCDNHost();
388
389
396 public String getCDNHost(boolean secure);
397
398 public String getCDNHost(HttpServletRequest request)
399 throws PortalException, SystemException;
400
401
407 public String getCDNHostHttp(long companyId);
408
409
415 public String getCDNHostHttps(long companyId);
416
417
423 public String getClassName(long classNameId);
424
425
431 public long getClassNameId(Class<?> clazz);
432
433
439 public long getClassNameId(String value);
440
441
451 public String getClassNamePortletId(String className);
452
453 public Company getCompany(HttpServletRequest request)
454 throws PortalException, SystemException;
455
456 public Company getCompany(PortletRequest portletRequest)
457 throws PortalException, SystemException;
458
459 public long getCompanyId(HttpServletRequest requestuest);
460
461 public long getCompanyId(PortletRequest portletRequest);
462
463 public long[] getCompanyIds();
464
465 public String getComputerAddress();
466
467 public String getComputerName();
468
469 public String getControlPanelCategory(
470 String portletId, ThemeDisplay themeDisplay)
471 throws SystemException;
472
473 public String getControlPanelFullURL(
474 long scopeGroupId, String ppid, Map<String, String[]> params)
475 throws PortalException, SystemException;
476
477 public Set<Portlet> getControlPanelPortlets(long companyId, String category)
478 throws SystemException;
479
480 public List<Portlet> getControlPanelPortlets(
481 String category, ThemeDisplay themeDisplay)
482 throws SystemException;
483
484 public String getCreateAccountURL(
485 HttpServletRequest request, ThemeDisplay themeDisplay)
486 throws Exception;
487
488 public String getCurrentCompleteURL(HttpServletRequest request);
489
490 public String getCurrentURL(HttpServletRequest request);
491
492 public String getCurrentURL(PortletRequest portletRequest);
493
494 public String getCustomSQLFunctionIsNotNull();
495
496 public String getCustomSQLFunctionIsNull();
497
498
506 public Date getDate(int month, int day, int year);
507
508
523 public Date getDate(
524 int month, int day, int year,
525 Class<? extends PortalException> clazz)
526 throws PortalException;
527
528
545 public Date getDate(
546 int month, int day, int year, int hour, int min,
547 Class<? extends PortalException> clazz)
548 throws PortalException;
549
550
568 public Date getDate(
569 int month, int day, int year, int hour, int min, PortalException pe)
570 throws PortalException;
571
572
590 public Date getDate(
591 int month, int day, int year, int hour, int min, TimeZone timeZone,
592 Class<? extends PortalException> clazz)
593 throws PortalException;
594
595
614 public Date getDate(
615 int month, int day, int year, int hour, int min, TimeZone timeZone,
616 PortalException pe)
617 throws PortalException;
618
619
635 public Date getDate(int month, int day, int year, PortalException pe)
636 throws PortalException;
637
638
654 public Date getDate(
655 int month, int day, int year, TimeZone timeZone,
656 Class<? extends PortalException> clazz)
657 throws PortalException;
658
659
676 public Date getDate(
677 int month, int day, int year, TimeZone timeZone, PortalException pe)
678 throws PortalException;
679
680 public long getDefaultCompanyId();
681
682 public long getDigestAuthUserId(HttpServletRequest request)
683 throws PortalException, SystemException;
684
685 public String getEmailFromAddress(
686 PortletPreferences preferences, long companyId, String defaultValue)
687 throws SystemException;
688
689 public String getEmailFromName(
690 PortletPreferences preferences, long companyId, String defaultValue)
691 throws SystemException;
692
693 public Map<String, Serializable> getExpandoBridgeAttributes(
694 ExpandoBridge expandoBridge, PortletRequest portletRequest)
695 throws PortalException, SystemException;
696
697 public Map<String, Serializable> getExpandoBridgeAttributes(
698 ExpandoBridge expandoBridge,
699 UploadPortletRequest uploadPortletRequest)
700 throws PortalException, SystemException;
701
702 public Serializable getExpandoValue(
703 PortletRequest portletRequest, String name, int type,
704 String displayType)
705 throws PortalException, SystemException;
706
707 public Serializable getExpandoValue(
708 UploadPortletRequest uploadPortletRequest, String name, int type,
709 String displayType)
710 throws PortalException, SystemException;
711
712 public String getFacebookURL(
713 Portlet portlet, String facebookCanvasPageURL,
714 ThemeDisplay themeDisplay)
715 throws PortalException, SystemException;
716
717 public String getFirstPageLayoutTypes(PageContext pageContext);
718
719 public String getGlobalLibDir();
720
721 public String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
722 throws PortalException, SystemException;
723
724 public String getGroupFriendlyURL(
725 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)
726 throws PortalException, SystemException;
727
728 public String[] getGroupPermissions(HttpServletRequest request);
729
730 public String[] getGroupPermissions(PortletRequest portletRequest);
731
732 public String[] getGuestPermissions(HttpServletRequest request);
733
734 public String[] getGuestPermissions(PortletRequest portletRequest);
735
736 public String getHomeURL(HttpServletRequest request)
737 throws PortalException, SystemException;
738
739 public String getHost(HttpServletRequest request);
740
741 public String getHost(PortletRequest portletRequest);
742
743 public HttpServletRequest getHttpServletRequest(
744 PortletRequest portletRequest);
745
746 public HttpServletResponse getHttpServletResponse(
747 PortletResponse portletResponse);
748
749 public String getJournalArticleActualURL(
750 long groupId, String mainPath, String friendlyURL,
751 Map<String, String[]> params, Map<String, Object> requestContext)
752 throws PortalException, SystemException;
753
754 public String getJsSafePortletId(String portletId) ;
755
756 public String getLayoutActualURL(Layout layout);
757
758 public String getLayoutActualURL(Layout layout, String mainPath);
759
760 public String getLayoutActualURL(
761 long groupId, boolean privateLayout, String mainPath,
762 String friendlyURL)
763 throws PortalException, SystemException;
764
765 public String getLayoutActualURL(
766 long groupId, boolean privateLayout, String mainPath,
767 String friendlyURL, Map<String, String[]> params,
768 Map<String, Object> requestContext)
769 throws PortalException, SystemException;
770
771 public String getLayoutEditPage(Layout layout);
772
773 public String getLayoutEditPage(String type);
774
775 public String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
776 throws PortalException, SystemException;
777
778 public String getLayoutFriendlyURL(
779 Layout layout, ThemeDisplay themeDisplay, Locale locale)
780 throws PortalException, SystemException;
781
782 public String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
783 throws PortalException, SystemException;
784
785 public String getLayoutFullURL(
786 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
787 throws PortalException, SystemException;
788
789 public String getLayoutFullURL(long groupId, String portletId)
790 throws PortalException, SystemException;
791
792 public String getLayoutFullURL(
793 long groupId, String portletId, boolean secure)
794 throws PortalException, SystemException;
795
796 public String getLayoutFullURL(ThemeDisplay themeDisplay)
797 throws PortalException, SystemException;
798
799 public String getLayoutSetFriendlyURL(
800 LayoutSet layoutSet, ThemeDisplay themeDisplay)
801 throws PortalException, SystemException;
802
803 public String getLayoutTarget(Layout layout);
804
805 public String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
806 throws PortalException, SystemException;
807
808 public String getLayoutURL(
809 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
810 throws PortalException, SystemException;
811
812 public String getLayoutURL(ThemeDisplay themeDisplay)
813 throws PortalException, SystemException;
814
815 public String getLayoutViewPage(Layout layout);
816
817 public String getLayoutViewPage(String type);
818
819 public LiferayPortletRequest getLiferayPortletRequest(
820 PortletRequest portletRequest);
821
822 public LiferayPortletResponse getLiferayPortletResponse(
823 PortletResponse portletResponse);
824
825 public Locale getLocale(HttpServletRequest request);
826
827 public Locale getLocale(RenderRequest renderRequest);
828
829 public String getMailId(String mx, String popPortletPrefix, Object... ids);
830
831 public String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
832 throws PortalException, SystemException;
833
834 public String getNewPortletTitle(
835 String portletTitle, String oldScopeName, String newScopeName);
836
837 public HttpServletRequest getOriginalServletRequest(
838 HttpServletRequest request);
839
840 public String getOuterPortletId(HttpServletRequest request);
841
842 public long getParentGroupId(long scopeGroupId)
843 throws PortalException, SystemException;
844
845 public String getPathContext();
846
847 public String getPathFriendlyURLPrivateGroup();
848
849 public String getPathFriendlyURLPrivateUser();
850
851 public String getPathFriendlyURLPublic();
852
853 public String getPathImage();
854
855 public String getPathMain();
856
857 public String getPathProxy();
858
859 public long getPlidFromFriendlyURL(long companyId, String friendlyURL);
860
861 public long getPlidFromPortletId(
862 long groupId, boolean privateLayout, String portletId)
863 throws PortalException, SystemException;
864
865 public long getPlidFromPortletId(long groupId, String portletId)
866 throws PortalException, SystemException;
867
868 public String getPortalLibDir();
869
870
873 public int getPortalPort();
874
875 public int getPortalPort(boolean secure);
876
877 public Properties getPortalProperties();
878
879 public String getPortalURL(HttpServletRequest request);
880
881 public String getPortalURL(HttpServletRequest request, boolean secure);
882
883 public String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
884 throws PortalException, SystemException;
885
886 public String getPortalURL(PortletRequest portletRequest);
887
888 public String getPortalURL(PortletRequest portletRequest, boolean secure);
889
890 public String getPortalURL(
891 String serverName, int serverPort, boolean secure);
892
893 public String getPortalURL(ThemeDisplay themeDisplay)
894 throws PortalException, SystemException;
895
896 public String getPortalWebDir();
897
898 public Set<String> getPortletAddDefaultResourceCheckWhitelist();
899
900 public Set<String> getPortletAddDefaultResourceCheckWhitelistActions();
901
902
905 public List<BreadcrumbEntry> getPortletBreadcrumbList(
906 HttpServletRequest request);
907
908 public List<BreadcrumbEntry> getPortletBreadcrumbs(
909 HttpServletRequest request);
910
911 public String getPortletDescription(
912 Portlet portlet, ServletContext servletContext, Locale locale);
913
914 public String getPortletDescription(Portlet portlet, User user);
915
916 public String getPortletDescription(String portletId, Locale locale);
917
918 public String getPortletDescription(String portletId, String languageId);
919
920 public String getPortletDescription(String portletId, User user);
921
922 public String getPortletId(HttpServletRequest request);
923
924 public String getPortletId(PortletRequest portletRequest);
925
926 public String getPortletLongTitle(Portlet portlet, Locale locale);
927
928 public String getPortletLongTitle(
929 Portlet portlet, ServletContext servletContext, Locale locale);
930
931 public String getPortletLongTitle(Portlet portlet, String languageId);
932
933 public String getPortletLongTitle(Portlet portlet, User user);
934
935 public String getPortletLongTitle(String portletId, Locale locale);
936
937 public String getPortletLongTitle(String portletId, String languageId);
938
939 public String getPortletLongTitle(String portletId, User user);
940
941 public String getPortletNamespace(String portletId);
942
943 public String getPortletTitle(Portlet portlet, Locale locale);
944
945 public String getPortletTitle(
946 Portlet portlet, ServletContext servletContext, Locale locale);
947
948 public String getPortletTitle(Portlet portlet, String languageId);
949
950 public String getPortletTitle(Portlet portlet, User user);
951
952 public String getPortletTitle(RenderResponse renderResponse);
953
954 public String getPortletTitle(String portletId, Locale locale);
955
956 public String getPortletTitle(String portletId, String languageId);
957
958 public String getPortletTitle(String portletId, User user);
959
960 public String getPortletXmlFileName() throws SystemException;
961
962 public PortletPreferences getPreferences(HttpServletRequest request);
963
964 public PreferencesValidator getPreferencesValidator(Portlet portlet);
965
966 public String getRelativeHomeURL(HttpServletRequest request)
967 throws PortalException, SystemException;
968
969 public long getScopeGroupId(HttpServletRequest request)
970 throws PortalException, SystemException;
971
972 public long getScopeGroupId(HttpServletRequest request, String portletId)
973 throws PortalException, SystemException;
974
975 public long getScopeGroupId(
976 HttpServletRequest request, String portletId,
977 boolean checkStagingGroup)
978 throws PortalException, SystemException;
979
980 public long getScopeGroupId(Layout layout);
981
982 public long getScopeGroupId(Layout layout, String portletId);
983
984 public long getScopeGroupId(long plid);
985
986 public long getScopeGroupId(PortletRequest portletRequest)
987 throws PortalException, SystemException;
988
989 public User getSelectedUser(HttpServletRequest request)
990 throws PortalException, SystemException;
991
992 public User getSelectedUser(
993 HttpServletRequest request, boolean checkPermission)
994 throws PortalException, SystemException;
995
996 public User getSelectedUser(PortletRequest portletRequest)
997 throws PortalException, SystemException;
998
999 public User getSelectedUser(
1000 PortletRequest portletRequest, boolean checkPermission)
1001 throws PortalException, SystemException;
1002
1003 public ServletContext getServletContext(
1004 Portlet portlet, ServletContext servletContext);
1005
1006
1016 public String getSiteLoginURL(ThemeDisplay themeDisplay)
1017 throws PortalException, SystemException;
1018
1019 public String getStaticResourceURL(HttpServletRequest request, String uri);
1020
1021 public String getStaticResourceURL(
1022 HttpServletRequest request, String uri, long timestamp);
1023
1024 public String getStaticResourceURL(
1025 HttpServletRequest request, String uri, String queryString);
1026
1027 public String getStaticResourceURL(
1028 HttpServletRequest request, String uri, String queryString,
1029 long timestamp);
1030
1031 public String getStrutsAction(HttpServletRequest request);
1032
1033 public String[] getSystemGroups();
1034
1035 public String[] getSystemOrganizationRoles();
1036
1037 public String[] getSystemRoles();
1038
1039 public String[] getSystemSiteRoles();
1040
1041 public String getUniqueElementId(
1042 HttpServletRequest request, String namespace, String id);
1043
1044 public String getUniqueElementId(
1045 PortletRequest request, String namespace, String id);
1046
1047 public UploadPortletRequest getUploadPortletRequest(
1048 PortletRequest portletRequest);
1049
1050 public UploadServletRequest getUploadServletRequest(
1051 HttpServletRequest request);
1052
1053 public Date getUptime();
1054
1055 public String getURLWithSessionId(String url, String sessionId);
1056
1057 public User getUser(HttpServletRequest request)
1058 throws PortalException, SystemException;
1059
1060 public User getUser(PortletRequest portletRequest)
1061 throws PortalException, SystemException;
1062
1063 public String getUserEmailAddress(long userId) throws SystemException;
1064
1065 public long getUserId(HttpServletRequest request);
1066
1067 public long getUserId(PortletRequest portletRequest);
1068
1069 public String getUserName(long userId, String defaultUserName);
1070
1071 public String getUserName(
1072 long userId, String defaultUserName, HttpServletRequest request);
1073
1074 public String getUserName(
1075 long userId, String defaultUserName, String userAttribute);
1076
1077 public String getUserName(
1078 long userId, String defaultUserName, String userAttribute,
1079 HttpServletRequest request);
1080
1081 public String getUserPassword(HttpServletRequest request);
1082
1083 public String getUserPassword(HttpSession session);
1084
1085 public String getUserPassword(PortletRequest portletRequest);
1086
1087 public String getUserValue(long userId, String param, String defaultValue)
1088 throws SystemException;
1089
1090 public long getValidUserId(long companyId, long userId)
1091 throws PortalException, SystemException;
1092
1093 public String getVirtualLayoutActualURL(
1094 long groupId, boolean privateLayout, String mainPath,
1095 String friendlyURL, Map<String, String[]> params,
1096 Map<String, Object> requestContext)
1097 throws PortalException, SystemException;
1098
1099 public String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
1100 throws PortalException, SystemException;
1101
1102 public void initCustomSQL();
1103
1104 public boolean isAllowAddPortletDefaultResource(
1105 HttpServletRequest request, Portlet portlet)
1106 throws PortalException, SystemException;
1107
1108 public boolean isCDNDynamicResourcesEnabled(HttpServletRequest request)
1109 throws PortalException, SystemException;
1110
1111 public boolean isCDNDynamicResourcesEnabled(long companyId);
1112
1113
1116 public boolean isCommunityAdmin(User user, long groupId) throws Exception;
1117
1118
1121 public boolean isCommunityOwner(User user, long groupId) throws Exception;
1122
1123 public boolean isCompanyAdmin(User user) throws Exception;
1124
1125 public boolean isCompanyControlPanelPortlet(
1126 String portletId, String category, ThemeDisplay themeDisplay)
1127 throws PortalException, SystemException;
1128
1129 public boolean isCompanyControlPanelPortlet(
1130 String portletId, ThemeDisplay themeDisplay)
1131 throws PortalException, SystemException;
1132
1133 public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
1134 throws PortalException, SystemException;
1135
1136 public boolean isControlPanelPortlet(
1137 String portletId, String category, ThemeDisplay themeDisplay)
1138 throws SystemException;
1139
1140 public boolean isControlPanelPortlet(
1141 String portletId, ThemeDisplay themeDisplay)
1142 throws SystemException;
1143
1144 public boolean isGroupAdmin(User user, long groupId) throws Exception;
1145
1146 public boolean isGroupOwner(User user, long groupId) throws Exception;
1147
1148 public boolean isLayoutDescendant(Layout layout, long layoutId)
1149 throws PortalException, SystemException;
1150
1151 public boolean isLayoutFirstPageable(Layout layout);
1152
1153 public boolean isLayoutFirstPageable(String type);
1154
1155 public boolean isLayoutFriendliable(Layout layout);
1156
1157 public boolean isLayoutFriendliable(String type);
1158
1159 public boolean isLayoutParentable(Layout layout);
1160
1161 public boolean isLayoutParentable(String type);
1162
1163 public boolean isLayoutSitemapable(Layout layout);
1164
1165 public boolean isMethodGet(PortletRequest portletRequest);
1166
1167 public boolean isMethodPost(PortletRequest portletRequest);
1168
1169 public boolean isMultipartRequest(HttpServletRequest request);
1170
1171 public boolean isOmniadmin(long userId);
1172
1173 public boolean isReservedParameter(String name);
1174
1175 public boolean isSecure(HttpServletRequest request);
1176
1177 public boolean isSystemGroup(String groupName);
1178
1179 public boolean isSystemRole(String roleName);
1180
1181 public boolean isUpdateAvailable() throws SystemException;
1182
1183 public boolean isValidResourceId(String resourceId);
1184
1185 public void removePortalPortEventListener(
1186 PortalPortEventListener portalPortEventListener);
1187
1188 public String renderPage(
1189 ServletContext servletContext, HttpServletRequest request,
1190 HttpServletResponse response, String path)
1191 throws IOException, ServletException;
1192
1193 public String renderPortlet(
1194 ServletContext servletContext, HttpServletRequest request,
1195 HttpServletResponse response, Portlet portlet, String queryString,
1196 boolean writeOutput)
1197 throws IOException, ServletException;
1198
1199 public String renderPortlet(
1200 ServletContext servletContext, HttpServletRequest request,
1201 HttpServletResponse response, Portlet portlet, String queryString,
1202 String columnId, Integer columnPos, Integer columnCount,
1203 boolean writeOutput)
1204 throws IOException, ServletException;
1205
1206 public String renderPortlet(
1207 ServletContext servletContext, HttpServletRequest request,
1208 HttpServletResponse response, Portlet portlet, String queryString,
1209 String columnId, Integer columnPos, Integer columnCount,
1210 String path, boolean writeOutput)
1211 throws IOException, ServletException;
1212
1213 public void resetCDNHosts();
1214
1215 public Set<String> resetPortletAddDefaultResourceCheckWhitelist();
1216
1217 public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions();
1218
1219 public void sendError(
1220 Exception e, ActionRequest actionRequest,
1221 ActionResponse actionResponse)
1222 throws IOException;
1223
1224 public void sendError(
1225 Exception e, HttpServletRequest request,
1226 HttpServletResponse response)
1227 throws IOException, ServletException;
1228
1229 public void sendError(
1230 int status, Exception e, ActionRequest actionRequest,
1231 ActionResponse actionResponse)
1232 throws IOException;
1233
1234 public void sendError(
1235 int status, Exception e, HttpServletRequest request,
1236 HttpServletResponse response)
1237 throws IOException, ServletException;
1238
1239
1243 public void setPageDescription(
1244 String description, HttpServletRequest request);
1245
1246
1249 public void setPageKeywords(String keywords, HttpServletRequest request);
1250
1251
1254 public void setPageSubtitle(String subtitle, HttpServletRequest request);
1255
1256
1260 public void setPageTitle(String title, HttpServletRequest request);
1261
1262
1265 public void setPortalPort(HttpServletRequest request);
1266
1267 public void storePreferences(PortletPreferences portletPreferences)
1268 throws IOException, ValidatorException;
1269
1270 public String[] stripURLAnchor(String url, String separator);
1271
1272 public String transformCustomSQL(String sql);
1273
1274 public PortletMode updatePortletMode(
1275 String portletId, User user, Layout layout, PortletMode portletMode,
1276 HttpServletRequest request);
1277
1278 public String updateRedirect(
1279 String redirect, String oldPath, String newPath);
1280
1281 public WindowState updateWindowState(
1282 String portletId, User user, Layout layout, WindowState windowState,
1283 HttpServletRequest request);
1284
1285 }