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.LayoutFriendlyURLComposite;
029 import com.liferay.portal.model.LayoutQueryStringComposite;
030 import com.liferay.portal.model.LayoutSet;
031 import com.liferay.portal.model.Portlet;
032 import com.liferay.portal.model.ResourcePermission;
033 import com.liferay.portal.model.User;
034 import com.liferay.portal.theme.ThemeDisplay;
035 import com.liferay.portlet.expando.model.ExpandoBridge;
036
037 import java.io.IOException;
038 import java.io.Serializable;
039
040 import java.util.Date;
041 import java.util.List;
042 import java.util.Locale;
043 import java.util.Map;
044 import java.util.Properties;
045 import java.util.Set;
046 import java.util.TimeZone;
047
048 import javax.portlet.ActionRequest;
049 import javax.portlet.ActionResponse;
050 import javax.portlet.PortletConfig;
051 import javax.portlet.PortletException;
052 import javax.portlet.PortletMode;
053 import javax.portlet.PortletPreferences;
054 import javax.portlet.PortletRequest;
055 import javax.portlet.PortletResponse;
056 import javax.portlet.PortletURL;
057 import javax.portlet.PreferencesValidator;
058 import javax.portlet.RenderRequest;
059 import javax.portlet.RenderResponse;
060 import javax.portlet.ValidatorException;
061 import javax.portlet.WindowState;
062
063 import javax.servlet.ServletContext;
064 import javax.servlet.ServletException;
065 import javax.servlet.http.HttpServletRequest;
066 import javax.servlet.http.HttpServletResponse;
067 import javax.servlet.http.HttpSession;
068 import javax.servlet.jsp.PageContext;
069
070
074 public interface Portal {
075
076 public static final String FRIENDLY_URL_SEPARATOR = "/-/";
077
078 public static final String PATH_IMAGE = "/image";
079
080 public static final String PATH_MAIN = "/c";
081
082 public static final String PATH_MODULE = "/o";
083
084 public static final String PATH_PORTAL_LAYOUT = "/portal/layout";
085
086 public static final String PORTAL_REALM = "PortalRealm";
087
088 public static final String PORTLET_XML_FILE_NAME_CUSTOM =
089 "portlet-custom.xml";
090
091 public static final String PORTLET_XML_FILE_NAME_STANDARD = "portlet.xml";
092
093 public static final String TEMP_OBFUSCATION_VALUE =
094 "TEMP_OBFUSCATION_VALUE";
095
096
103 public void addPageDescription(
104 String description, HttpServletRequest request);
105
106
113 public void addPageKeywords(String keywords, HttpServletRequest request);
114
115
121 public void addPageSubtitle(String subtitle, HttpServletRequest request);
122
123
129 public void addPageTitle(String title, HttpServletRequest request);
130
131
137 public void addPortalPortEventListener(
138 PortalPortEventListener portalPortEventListener);
139
140
147 public void addPortletBreadcrumbEntry(
148 HttpServletRequest request, String title, String url);
149
150
158 public void addPortletBreadcrumbEntry(
159 HttpServletRequest request, String title, String url,
160 Map<String, Object> data);
161
162
170 public void addPortletDefaultResource(
171 HttpServletRequest request, Portlet portlet)
172 throws PortalException, SystemException;
173
174 public void addPortletDefaultResource(
175 long companyId, Layout layout, Portlet portlet)
176 throws PortalException, SystemException;
177
178
195 public String addPreservedParameters(
196 ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser);
197
198
206 public String addPreservedParameters(ThemeDisplay themeDisplay, String url);
207
208 public void addUserLocaleOptionsMessage(HttpServletRequest request);
209
210
216 public void clearRequestParameters(RenderRequest renderRequest);
217
218
225 public void copyRequestParameters(
226 ActionRequest actionRequest, ActionResponse actionResponse);
227
228
236 public String escapeRedirect(String url);
237
238
245 public String generateRandomKey(HttpServletRequest request, String input);
246
247 public String getAbsoluteURL(HttpServletRequest request, String url);
248
249 public LayoutQueryStringComposite getActualLayoutQueryStringComposite(
250 long groupId, boolean privateLayout, String friendlyURL,
251 Map<String, String[]> params, Map<String, Object> requestContext)
252 throws PortalException, SystemException;
253
254 public String getActualURL(
255 long groupId, boolean privateLayout, String mainPath,
256 String friendlyURL, Map<String, String[]> params,
257 Map<String, Object> requestContext)
258 throws PortalException, SystemException;
259
260
271 public Locale[] getAlternateLocales(HttpServletRequest request)
272 throws PortalException, SystemException;
273
274
286 public String getAlternateURL(
287 String canonicalURL, ThemeDisplay themeDisplay, Locale locale,
288 Layout layout)
289 throws PortalException, SystemException;
290
291
300 public Set<String> getAuthTokenIgnoreActions();
301
302
311 public Set<String> getAuthTokenIgnorePortlets();
312
313
324 public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
325 throws PortalException, SystemException;
326
327
338 public BaseModel<?> getBaseModel(String modelName, String primKey)
339 throws PortalException, SystemException;
340
341
352 public long getBasicAuthUserId(HttpServletRequest request)
353 throws PortalException, SystemException;
354
355
367 public long getBasicAuthUserId(HttpServletRequest request, long companyId)
368 throws PortalException, SystemException;
369
370
383 public String getCanonicalURL(
384 String completeURL, ThemeDisplay themeDisplay, Layout layout)
385 throws PortalException, SystemException;
386
387
402 public String getCanonicalURL(
403 String completeURL, ThemeDisplay themeDisplay, Layout layout,
404 boolean forceLayoutFriendlyURL)
405 throws PortalException, SystemException;
406
407
411 public String getCDNHost();
412
413
420 public String getCDNHost(boolean secure);
421
422 public String getCDNHost(HttpServletRequest request)
423 throws PortalException, SystemException;
424
425
432 public String getCDNHostHttp(long companyId);
433
434
441 public String getCDNHostHttps(long companyId);
442
443
449 public String getClassName(long classNameId);
450
451
457 public long getClassNameId(Class<?> clazz);
458
459
465 public long getClassNameId(String value);
466
467
477 public String getClassNamePortletId(String className);
478
479 public Company getCompany(HttpServletRequest request)
480 throws PortalException, SystemException;
481
482 public Company getCompany(PortletRequest portletRequest)
483 throws PortalException, SystemException;
484
485 public long getCompanyId(HttpServletRequest requestuest);
486
487 public long getCompanyId(PortletRequest portletRequest);
488
489 public long[] getCompanyIds();
490
491 public String getComputerAddress();
492
493 public String getComputerName();
494
495 public Map<String, List<Portlet>> getControlPanelCategoriesMap(
496 HttpServletRequest request)
497 throws SystemException;
498
499 public String getControlPanelCategory(
500 String portletId, ThemeDisplay themeDisplay)
501 throws SystemException;
502
503 public String getControlPanelFullURL(
504 long scopeGroupId, String ppid, Map<String, String[]> params)
505 throws PortalException, SystemException;
506
507 public long getControlPanelPlid(long companyId)
508 throws PortalException, SystemException;
509
510 public long getControlPanelPlid(PortletRequest portletRequest)
511 throws PortalException, SystemException;
512
513 public Set<Portlet> getControlPanelPortlets(long companyId, String category)
514 throws SystemException;
515
516 public List<Portlet> getControlPanelPortlets(
517 String category, ThemeDisplay themeDisplay)
518 throws SystemException;
519
520 public PortletURL getControlPanelPortletURL(
521 HttpServletRequest request, String portletId, long referrerPlid,
522 String lifecycle);
523
524 public PortletURL getControlPanelPortletURL(
525 PortletRequest portletRequest, String portletId, long referrerPlid,
526 String lifecycle);
527
528 public String getCreateAccountURL(
529 HttpServletRequest request, ThemeDisplay themeDisplay)
530 throws Exception;
531
532 public String getCurrentCompleteURL(HttpServletRequest request);
533
534 public String getCurrentURL(HttpServletRequest request);
535
536 public String getCurrentURL(PortletRequest portletRequest);
537
538 public String getCustomSQLFunctionIsNotNull();
539
540 public String getCustomSQLFunctionIsNull();
541
542
550 public Date getDate(int month, int day, int year);
551
552
567 public Date getDate(
568 int month, int day, int year,
569 Class<? extends PortalException> clazz)
570 throws PortalException;
571
572
589 public Date getDate(
590 int month, int day, int year, int hour, int min,
591 Class<? extends PortalException> clazz)
592 throws PortalException;
593
594
612 public Date getDate(
613 int month, int day, int year, int hour, int min, TimeZone timeZone,
614 Class<? extends PortalException> clazz)
615 throws PortalException;
616
617
633 public Date getDate(
634 int month, int day, int year, TimeZone timeZone,
635 Class<? extends PortalException> clazz)
636 throws PortalException;
637
638 public long getDefaultCompanyId();
639
640 public long getDigestAuthUserId(HttpServletRequest request)
641 throws PortalException, SystemException;
642
643 public String getEmailFromAddress(
644 PortletPreferences preferences, long companyId, String defaultValue)
645 throws SystemException;
646
647 public String getEmailFromName(
648 PortletPreferences preferences, long companyId, String defaultValue)
649 throws SystemException;
650
651 public Map<String, Serializable> getExpandoBridgeAttributes(
652 ExpandoBridge expandoBridge, PortletRequest portletRequest)
653 throws PortalException, SystemException;
654
655 public Map<String, Serializable> getExpandoBridgeAttributes(
656 ExpandoBridge expandoBridge,
657 UploadPortletRequest uploadPortletRequest)
658 throws PortalException, SystemException;
659
660 public Serializable getExpandoValue(
661 PortletRequest portletRequest, String name, int type,
662 String displayType)
663 throws PortalException, SystemException;
664
665 public Serializable getExpandoValue(
666 UploadPortletRequest uploadPortletRequest, String name, int type,
667 String displayType)
668 throws PortalException, SystemException;
669
670 public String getFacebookURL(
671 Portlet portlet, String facebookCanvasPageURL,
672 ThemeDisplay themeDisplay)
673 throws PortalException, SystemException;
674
675 public Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
676 throws SystemException;
677
678 public String getFirstPageLayoutTypes(PageContext pageContext);
679
680 public Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
681 throws SystemException;
682
683 public String getFullName(
684 String firstName, String middleName, String lastName);
685
686 public String getGlobalLibDir();
687
688 public String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
689 throws PortalException, SystemException;
690
691 public String getGroupFriendlyURL(
692 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)
693 throws PortalException, SystemException;
694
695 public String getGroupFriendlyURL(
696 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay,
697 Locale locale)
698 throws PortalException, SystemException;
699
700 public int[] getGroupFriendlyURLIndex(String requestURI);
701
702 public String[] getGroupPermissions(HttpServletRequest request);
703
704 public String[] getGroupPermissions(
705 HttpServletRequest request, String className);
706
707 public String[] getGroupPermissions(PortletRequest portletRequest);
708
709 public String[] getGroupPermissions(
710 PortletRequest portletRequest, String className);
711
712 public String[] getGuestPermissions(HttpServletRequest request);
713
714 public String[] getGuestPermissions(
715 HttpServletRequest request, String className);
716
717 public String[] getGuestPermissions(PortletRequest portletRequest);
718
719 public String[] getGuestPermissions(
720 PortletRequest portletRequest, String className);
721
722 public String getHomeURL(HttpServletRequest request)
723 throws PortalException, SystemException;
724
725 public String getHost(HttpServletRequest request);
726
727 public String getHost(PortletRequest portletRequest);
728
729 public HttpServletRequest getHttpServletRequest(
730 PortletRequest portletRequest);
731
732 public HttpServletResponse getHttpServletResponse(
733 PortletResponse portletResponse);
734
735 public String getI18nPathLanguageId(
736 Locale locale, String defaultI18nPathLanguageId);
737
738 public String getJournalArticleActualURL(
739 long groupId, boolean privateLayout, String mainPath,
740 String friendlyURL, Map<String, String[]> params,
741 Map<String, Object> requestContext)
742 throws PortalException, SystemException;
743
744 public Layout getJournalArticleLayout(
745 long groupId, boolean privateLayout, String friendlyURL)
746 throws PortalException, SystemException;
747
748 public String getJsSafePortletId(String portletId);
749
750 public String getLayoutActualURL(Layout layout);
751
752 public String getLayoutActualURL(Layout layout, String mainPath);
753
754 public String getLayoutActualURL(
755 long groupId, boolean privateLayout, String mainPath,
756 String friendlyURL)
757 throws PortalException, SystemException;
758
759 public String getLayoutActualURL(
760 long groupId, boolean privateLayout, String mainPath,
761 String friendlyURL, Map<String, String[]> params,
762 Map<String, Object> requestContext)
763 throws PortalException, SystemException;
764
765 public String getLayoutEditPage(Layout layout);
766
767 public String getLayoutEditPage(String type);
768
769 public String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
770 throws PortalException, SystemException;
771
772 public String getLayoutFriendlyURL(
773 Layout layout, ThemeDisplay themeDisplay, Locale locale)
774 throws PortalException, SystemException;
775
776 public LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(
777 long groupId, boolean privateLayout, String friendlyURL,
778 Map<String, String[]> params, Map<String, Object> requestContext)
779 throws PortalException, SystemException;
780
781 public String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
782 throws PortalException, SystemException;
783
784 public String getLayoutFullURL(
785 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
786 throws PortalException, SystemException;
787
788 public String getLayoutFullURL(long groupId, String portletId)
789 throws PortalException, SystemException;
790
791 public String getLayoutFullURL(
792 long groupId, String portletId, boolean secure)
793 throws PortalException, SystemException;
794
795 public String getLayoutFullURL(ThemeDisplay themeDisplay)
796 throws PortalException, SystemException;
797
798 public String getLayoutSetFriendlyURL(
799 LayoutSet layoutSet, ThemeDisplay themeDisplay)
800 throws PortalException, SystemException;
801
802 public String getLayoutTarget(Layout layout);
803
804 public String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
805 throws PortalException, SystemException;
806
807 public String getLayoutURL(
808 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
809 throws PortalException, SystemException;
810
811 public String getLayoutURL(ThemeDisplay themeDisplay)
812 throws PortalException, SystemException;
813
814 public String getLayoutViewPage(Layout layout);
815
816 public String getLayoutViewPage(String type);
817
818 public LiferayPortletRequest getLiferayPortletRequest(
819 PortletRequest portletRequest);
820
821 public LiferayPortletResponse getLiferayPortletResponse(
822 PortletResponse portletResponse);
823
824 public Locale getLocale(HttpServletRequest request);
825
826 public Locale getLocale(
827 HttpServletRequest request, HttpServletResponse response,
828 boolean initialize);
829
830 public Locale getLocale(PortletRequest portletRequest);
831
832 public String getLocalizedFriendlyURL(
833 HttpServletRequest request, Layout layout, Locale locale)
834 throws Exception;
835
836 public String getMailId(String mx, String popPortletPrefix, Object... ids);
837
838 public String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
839 throws PortalException, SystemException;
840
841 public String getNewPortletTitle(
842 String portletTitle, String oldScopeName, String newScopeName);
843
844 public HttpServletRequest getOriginalServletRequest(
845 HttpServletRequest request);
846
847
850 public long getParentGroupId(long scopeGroupId)
851 throws PortalException, SystemException;
852
853 public String getPathContext();
854
855 public String getPathFriendlyURLPrivateGroup();
856
857 public String getPathFriendlyURLPrivateUser();
858
859 public String getPathFriendlyURLPublic();
860
861 public String getPathImage();
862
863 public String getPathMain();
864
865 public String getPathModule();
866
867 public String getPathProxy();
868
869 public long getPlidFromFriendlyURL(long companyId, String friendlyURL);
870
871 public long getPlidFromPortletId(
872 long groupId, boolean privateLayout, String portletId)
873 throws PortalException, SystemException;
874
875 public long getPlidFromPortletId(long groupId, String portletId)
876 throws PortalException, SystemException;
877
878 public String getPortalLibDir();
879
880
884 public int getPortalPort();
885
886 public int getPortalPort(boolean secure);
887
888 public Properties getPortalProperties();
889
890 public String getPortalURL(HttpServletRequest request);
891
892 public String getPortalURL(HttpServletRequest request, boolean secure);
893
894 public String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
895 throws PortalException, SystemException;
896
897 public String getPortalURL(PortletRequest portletRequest);
898
899 public String getPortalURL(PortletRequest portletRequest, boolean secure);
900
901 public String getPortalURL(
902 String serverName, int serverPort, boolean secure);
903
904 public String getPortalURL(ThemeDisplay themeDisplay)
905 throws PortalException, SystemException;
906
907 public String getPortalWebDir();
908
909
913 public Set<String> getPortletAddDefaultResourceCheckWhitelist();
914
915
919 public Set<String> getPortletAddDefaultResourceCheckWhitelistActions();
920
921
925 public List<BreadcrumbEntry> getPortletBreadcrumbList(
926 HttpServletRequest request);
927
928 public List<BreadcrumbEntry> getPortletBreadcrumbs(
929 HttpServletRequest request);
930
931 public PortletConfig getPortletConfig(
932 long companyId, String portletId, ServletContext servletContext)
933 throws PortletException, SystemException;
934
935 public String getPortletDescription(
936 Portlet portlet, ServletContext servletContext, Locale locale);
937
938 public String getPortletDescription(Portlet portlet, User user);
939
940 public String getPortletDescription(String portletId, Locale locale);
941
942 public String getPortletDescription(String portletId, String languageId);
943
944 public String getPortletDescription(String portletId, User user);
945
946 public String getPortletId(HttpServletRequest request);
947
948 public String getPortletId(PortletRequest portletRequest);
949
950 public String getPortletLongTitle(Portlet portlet, Locale locale);
951
952 public String getPortletLongTitle(
953 Portlet portlet, ServletContext servletContext, Locale locale);
954
955 public String getPortletLongTitle(Portlet portlet, String languageId);
956
957 public String getPortletLongTitle(Portlet portlet, User user);
958
959 public String getPortletLongTitle(String portletId, Locale locale);
960
961 public String getPortletLongTitle(String portletId, String languageId);
962
963 public String getPortletLongTitle(String portletId, User user);
964
965 public String getPortletNamespace(String portletId);
966
967 public String getPortletTitle(Portlet portlet, Locale locale);
968
969 public String getPortletTitle(
970 Portlet portlet, ServletContext servletContext, Locale locale);
971
972 public String getPortletTitle(Portlet portlet, String languageId);
973
974 public String getPortletTitle(Portlet portlet, User user);
975
976 public String getPortletTitle(RenderRequest renderRequest);
977
978 public String getPortletTitle(RenderResponse renderResponse);
979
980 public String getPortletTitle(String portletId, Locale locale);
981
982 public String getPortletTitle(String portletId, String languageId);
983
984 public String getPortletTitle(String portletId, User user);
985
986 public String getPortletXmlFileName() throws SystemException;
987
988 public PortletPreferences getPreferences(HttpServletRequest request);
989
990 public PreferencesValidator getPreferencesValidator(Portlet portlet);
991
992 public String getRelativeHomeURL(HttpServletRequest request)
993 throws PortalException, SystemException;
994
995 public long getScopeGroupId(HttpServletRequest request)
996 throws PortalException, SystemException;
997
998 public long getScopeGroupId(HttpServletRequest request, String portletId)
999 throws PortalException, SystemException;
1000
1001 public long getScopeGroupId(
1002 HttpServletRequest request, String portletId,
1003 boolean checkStagingGroup)
1004 throws PortalException, SystemException;
1005
1006 public long getScopeGroupId(Layout layout);
1007
1008 public long getScopeGroupId(Layout layout, String portletId);
1009
1010 public long getScopeGroupId(long plid);
1011
1012 public long getScopeGroupId(PortletRequest portletRequest)
1013 throws PortalException, SystemException;
1014
1015 public User getSelectedUser(HttpServletRequest request)
1016 throws PortalException, SystemException;
1017
1018 public User getSelectedUser(
1019 HttpServletRequest request, boolean checkPermission)
1020 throws PortalException, SystemException;
1021
1022 public User getSelectedUser(PortletRequest portletRequest)
1023 throws PortalException, SystemException;
1024
1025 public User getSelectedUser(
1026 PortletRequest portletRequest, boolean checkPermission)
1027 throws PortalException, SystemException;
1028
1029 public String getServletContextName();
1030
1031 public Map<String, List<Portlet>> getSiteAdministrationCategoriesMap(
1032 HttpServletRequest request)
1033 throws SystemException;
1034
1035 public PortletURL getSiteAdministrationURL(
1036 HttpServletRequest request, ThemeDisplay themeDisplay)
1037 throws SystemException;
1038
1039 public PortletURL getSiteAdministrationURL(
1040 HttpServletRequest request, ThemeDisplay themeDisplay,
1041 String portletName);
1042
1043 public PortletURL getSiteAdministrationURL(
1044 PortletResponse portletResponse, ThemeDisplay themeDisplay)
1045 throws SystemException;
1046
1047 public PortletURL getSiteAdministrationURL(
1048 PortletResponse portletResponse, ThemeDisplay themeDisplay,
1049 String portletName);
1050
1051 public long[] getSiteAndCompanyGroupIds(long groupId)
1052 throws PortalException, SystemException;
1053
1054 public long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
1055 throws PortalException, SystemException;
1056
1057 public Locale getSiteDefaultLocale(long groupId)
1058 throws PortalException, SystemException;
1059
1060 public long getSiteGroupId(long groupId)
1061 throws PortalException, SystemException;
1062
1063
1073 public String getSiteLoginURL(ThemeDisplay themeDisplay)
1074 throws PortalException, SystemException;
1075
1076 public String getStaticResourceURL(HttpServletRequest request, String uri);
1077
1078 public String getStaticResourceURL(
1079 HttpServletRequest request, String uri, long timestamp);
1080
1081 public String getStaticResourceURL(
1082 HttpServletRequest request, String uri, String queryString);
1083
1084 public String getStaticResourceURL(
1085 HttpServletRequest request, String uri, String queryString,
1086 long timestamp);
1087
1088 public String getStrutsAction(HttpServletRequest request);
1089
1090 public String[] getSystemGroups();
1091
1092 public String[] getSystemOrganizationRoles();
1093
1094 public String[] getSystemRoles();
1095
1096 public String[] getSystemSiteRoles();
1097
1098 public String getUniqueElementId(
1099 HttpServletRequest request, String namespace, String id);
1100
1101 public String getUniqueElementId(
1102 PortletRequest request, String namespace, String id);
1103
1104 public UploadPortletRequest getUploadPortletRequest(
1105 PortletRequest portletRequest);
1106
1107 public UploadServletRequest getUploadServletRequest(
1108 HttpServletRequest request);
1109
1110 public Date getUptime();
1111
1112 public String getURLWithSessionId(String url, String sessionId);
1113
1114 public User getUser(HttpServletRequest request)
1115 throws PortalException, SystemException;
1116
1117 public User getUser(PortletRequest portletRequest)
1118 throws PortalException, SystemException;
1119
1120 public String getUserEmailAddress(long userId) throws SystemException;
1121
1122 public long getUserId(HttpServletRequest request);
1123
1124 public long getUserId(PortletRequest portletRequest);
1125
1126 public String getUserName(BaseModel<?> baseModel);
1127
1128 public String getUserName(long userId, String defaultUserName);
1129
1130 public String getUserName(
1131 long userId, String defaultUserName, HttpServletRequest request);
1132
1133 public String getUserName(
1134 long userId, String defaultUserName, String userAttribute);
1135
1136 public String getUserName(
1137 long userId, String defaultUserName, String userAttribute,
1138 HttpServletRequest request);
1139
1140 public String getUserPassword(HttpServletRequest request);
1141
1142 public String getUserPassword(HttpSession session);
1143
1144 public String getUserPassword(PortletRequest portletRequest);
1145
1146 public String getUserValue(long userId, String param, String defaultValue)
1147 throws SystemException;
1148
1149 public long getValidUserId(long companyId, long userId)
1150 throws PortalException, SystemException;
1151
1152 public String getVirtualLayoutActualURL(
1153 long groupId, boolean privateLayout, String mainPath,
1154 String friendlyURL, Map<String, String[]> params,
1155 Map<String, Object> requestContext)
1156 throws PortalException, SystemException;
1157
1158 public LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(
1159 boolean privateLayout, String friendlyURL,
1160 Map<String, String[]> params, Map<String, Object> requestContext)
1161 throws PortalException, SystemException;
1162
1163 public String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
1164 throws PortalException, SystemException;
1165
1166 public void initCustomSQL();
1167
1168 public User initUser(HttpServletRequest request) throws Exception;
1169
1170 public void invokeTaglibDiscussion(
1171 PortletConfig portletConfig, ActionRequest actionRequest,
1172 ActionResponse actionResponse)
1173 throws Exception;
1174
1175
1178 public boolean isAllowAddPortletDefaultResource(
1179 HttpServletRequest request, Portlet portlet)
1180 throws PortalException, SystemException;
1181
1182 public boolean isCDNDynamicResourcesEnabled(HttpServletRequest request)
1183 throws PortalException, SystemException;
1184
1185 public boolean isCDNDynamicResourcesEnabled(long companyId);
1186
1187
1190 public boolean isCommunityAdmin(User user, long groupId) throws Exception;
1191
1192
1195 public boolean isCommunityOwner(User user, long groupId) throws Exception;
1196
1197 public boolean isCompanyAdmin(User user) throws Exception;
1198
1199 public boolean isCompanyControlPanelPortlet(
1200 String portletId, String category, ThemeDisplay themeDisplay)
1201 throws PortalException, SystemException;
1202
1203 public boolean isCompanyControlPanelPortlet(
1204 String portletId, ThemeDisplay themeDisplay)
1205 throws PortalException, SystemException;
1206
1207 public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
1208 throws PortalException, SystemException;
1209
1210 public boolean isControlPanelPortlet(
1211 String portletId, String category, ThemeDisplay themeDisplay)
1212 throws SystemException;
1213
1214 public boolean isControlPanelPortlet(
1215 String portletId, ThemeDisplay themeDisplay)
1216 throws SystemException;
1217
1218 public boolean isGroupAdmin(User user, long groupId) throws Exception;
1219
1220 public boolean isGroupFriendlyURL(
1221 String fullURL, String groupFriendlyURL, String layoutFriendlyURL);
1222
1223 public boolean isGroupOwner(User user, long groupId) throws Exception;
1224
1225 public boolean isLayoutDescendant(Layout layout, long layoutId)
1226 throws PortalException, SystemException;
1227
1228 public boolean isLayoutFirstPageable(Layout layout);
1229
1230 public boolean isLayoutFirstPageable(String type);
1231
1232 public boolean isLayoutFriendliable(Layout layout);
1233
1234 public boolean isLayoutFriendliable(String type);
1235
1236 public boolean isLayoutParentable(Layout layout);
1237
1238 public boolean isLayoutParentable(String type);
1239
1240 public boolean isLayoutSitemapable(Layout layout);
1241
1242 public boolean isLoginRedirectRequired(HttpServletRequest request)
1243 throws SystemException;
1244
1245 public boolean isMethodGet(PortletRequest portletRequest);
1246
1247 public boolean isMethodPost(PortletRequest portletRequest);
1248
1249 public boolean isMultipartRequest(HttpServletRequest request);
1250
1251 public boolean isOmniadmin(long userId);
1252
1253 public boolean isReservedParameter(String name);
1254
1255 public boolean isRSSFeedsEnabled();
1256
1257 public boolean isSecure(HttpServletRequest request);
1258
1259 public boolean isSystemGroup(String groupName);
1260
1261 public boolean isSystemRole(String roleName);
1262
1263 public boolean isUpdateAvailable() throws SystemException;
1264
1265 public boolean isValidResourceId(String resourceId);
1266
1267 public void removePortalPortEventListener(
1268 PortalPortEventListener portalPortEventListener);
1269
1270 public void resetCDNHosts();
1271
1272
1276 public Set<String> resetPortletAddDefaultResourceCheckWhitelist();
1277
1278
1282 public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions();
1283
1284 public void sendError(
1285 Exception e, ActionRequest actionRequest,
1286 ActionResponse actionResponse)
1287 throws IOException;
1288
1289 public void sendError(
1290 Exception e, HttpServletRequest request,
1291 HttpServletResponse response)
1292 throws IOException, ServletException;
1293
1294 public void sendError(
1295 int status, Exception e, ActionRequest actionRequest,
1296 ActionResponse actionResponse)
1297 throws IOException;
1298
1299 public void sendError(
1300 int status, Exception e, HttpServletRequest request,
1301 HttpServletResponse response)
1302 throws IOException, ServletException;
1303
1304 public void sendRSSFeedsDisabledError(
1305 HttpServletRequest request, HttpServletResponse response)
1306 throws IOException, ServletException;
1307
1308 public void sendRSSFeedsDisabledError(
1309 PortletRequest portletRequest, PortletResponse portletResponse)
1310 throws IOException, ServletException;
1311
1312
1316 public void setPageDescription(
1317 String description, HttpServletRequest request);
1318
1319
1322 public void setPageKeywords(String keywords, HttpServletRequest request);
1323
1324
1327 public void setPageSubtitle(String subtitle, HttpServletRequest request);
1328
1329
1333 public void setPageTitle(String title, HttpServletRequest request);
1334
1335
1338 public void setPortalPort(HttpServletRequest request);
1339
1340 public void storePreferences(PortletPreferences portletPreferences)
1341 throws IOException, ValidatorException;
1342
1343 public String[] stripURLAnchor(String url, String separator);
1344
1345 public String transformCustomSQL(String sql);
1346
1347 public String transformSQL(String sql);
1348
1349 public PortletMode updatePortletMode(
1350 String portletId, User user, Layout layout, PortletMode portletMode,
1351 HttpServletRequest request);
1352
1353 public String updateRedirect(
1354 String redirect, String oldPath, String newPath);
1355
1356 public WindowState updateWindowState(
1357 String portletId, User user, Layout layout, WindowState windowState,
1358 HttpServletRequest request);
1359
1360 }