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 JSESSIONID = ";jsessionid=";
079
080 public static final String PATH_IMAGE = "/image";
081
082 public static final String PATH_MAIN = "/c";
083
084 public static final String PATH_MODULE = "/o";
085
086 public static final String PATH_PORTAL_LAYOUT = "/portal/layout";
087
088 public static final String PORTAL_REALM = "PortalRealm";
089
090 public static final String PORTLET_XML_FILE_NAME_CUSTOM =
091 "portlet-custom.xml";
092
093 public static final String PORTLET_XML_FILE_NAME_STANDARD = "portlet.xml";
094
095 public static final String TEMP_OBFUSCATION_VALUE =
096 "TEMP_OBFUSCATION_VALUE";
097
098
105 public void addPageDescription(
106 String description, HttpServletRequest request);
107
108
115 public void addPageKeywords(String keywords, HttpServletRequest request);
116
117
123 public void addPageSubtitle(String subtitle, HttpServletRequest request);
124
125
131 public void addPageTitle(String title, HttpServletRequest request);
132
133
139 public void addPortalPortEventListener(
140 PortalPortEventListener portalPortEventListener);
141
142
149 public void addPortletBreadcrumbEntry(
150 HttpServletRequest request, String title, String url);
151
152
160 public void addPortletBreadcrumbEntry(
161 HttpServletRequest request, String title, String url,
162 Map<String, Object> data);
163
164
172 public void addPortletDefaultResource(
173 HttpServletRequest request, Portlet portlet)
174 throws PortalException, SystemException;
175
176 public void addPortletDefaultResource(
177 long companyId, Layout layout, Portlet portlet)
178 throws PortalException, SystemException;
179
180
197 public String addPreservedParameters(
198 ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser);
199
200
208 public String addPreservedParameters(ThemeDisplay themeDisplay, String url);
209
210 public void addUserLocaleOptionsMessage(HttpServletRequest request);
211
212
218 public void clearRequestParameters(RenderRequest renderRequest);
219
220
227 public void copyRequestParameters(
228 ActionRequest actionRequest, ActionResponse actionResponse);
229
230
238 public String escapeRedirect(String url);
239
240
247 public String generateRandomKey(HttpServletRequest request, String input);
248
249 public String getAbsoluteURL(HttpServletRequest request, String url);
250
251 public LayoutQueryStringComposite getActualLayoutQueryStringComposite(
252 long groupId, boolean privateLayout, String friendlyURL,
253 Map<String, String[]> params, Map<String, Object> requestContext)
254 throws PortalException, SystemException;
255
256 public String getActualURL(
257 long groupId, boolean privateLayout, String mainPath,
258 String friendlyURL, Map<String, String[]> params,
259 Map<String, Object> requestContext)
260 throws PortalException, SystemException;
261
262
273 public Locale[] getAlternateLocales(HttpServletRequest request)
274 throws PortalException, SystemException;
275
276
288 public String getAlternateURL(
289 String canonicalURL, ThemeDisplay themeDisplay, Locale locale,
290 Layout layout)
291 throws PortalException, SystemException;
292
293
302 public Set<String> getAuthTokenIgnoreActions();
303
304
313 public Set<String> getAuthTokenIgnorePortlets();
314
315
326 public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
327 throws PortalException, SystemException;
328
329
340 public BaseModel<?> getBaseModel(String modelName, String primKey)
341 throws PortalException, SystemException;
342
343
354 public long getBasicAuthUserId(HttpServletRequest request)
355 throws PortalException, SystemException;
356
357
369 public long getBasicAuthUserId(HttpServletRequest request, long companyId)
370 throws PortalException, SystemException;
371
372
385 public String getCanonicalURL(
386 String completeURL, ThemeDisplay themeDisplay, Layout layout)
387 throws PortalException, SystemException;
388
389
404 public String getCanonicalURL(
405 String completeURL, ThemeDisplay themeDisplay, Layout layout,
406 boolean forceLayoutFriendlyURL)
407 throws PortalException, SystemException;
408
409
413 public String getCDNHost();
414
415
422 public String getCDNHost(boolean secure);
423
424 public String getCDNHost(HttpServletRequest request)
425 throws PortalException, SystemException;
426
427
434 public String getCDNHostHttp(long companyId);
435
436
443 public String getCDNHostHttps(long companyId);
444
445
451 public String getClassName(long classNameId);
452
453
459 public long getClassNameId(Class<?> clazz);
460
461
467 public long getClassNameId(String value);
468
469
479 public String getClassNamePortletId(String className);
480
481 public Company getCompany(HttpServletRequest request)
482 throws PortalException, SystemException;
483
484 public Company getCompany(PortletRequest portletRequest)
485 throws PortalException, SystemException;
486
487 public long getCompanyId(HttpServletRequest requestuest);
488
489 public long getCompanyId(PortletRequest portletRequest);
490
491 public long[] getCompanyIds();
492
493 public String getComputerAddress();
494
495 public String getComputerName();
496
497 public Map<String, List<Portlet>> getControlPanelCategoriesMap(
498 HttpServletRequest request)
499 throws SystemException;
500
501 public String getControlPanelCategory(
502 String portletId, ThemeDisplay themeDisplay)
503 throws SystemException;
504
505 public String getControlPanelFullURL(
506 long scopeGroupId, String ppid, Map<String, String[]> params)
507 throws PortalException, SystemException;
508
509 public long getControlPanelPlid(long companyId)
510 throws PortalException, SystemException;
511
512 public long getControlPanelPlid(PortletRequest portletRequest)
513 throws PortalException, SystemException;
514
515 public Set<Portlet> getControlPanelPortlets(long companyId, String category)
516 throws SystemException;
517
518 public List<Portlet> getControlPanelPortlets(
519 String category, ThemeDisplay themeDisplay)
520 throws SystemException;
521
522 public PortletURL getControlPanelPortletURL(
523 HttpServletRequest request, String portletId, long referrerPlid,
524 String lifecycle);
525
526 public PortletURL getControlPanelPortletURL(
527 PortletRequest portletRequest, String portletId, long referrerPlid,
528 String lifecycle);
529
530 public String getCreateAccountURL(
531 HttpServletRequest request, ThemeDisplay themeDisplay)
532 throws Exception;
533
534 public String getCurrentCompleteURL(HttpServletRequest request);
535
536 public String getCurrentURL(HttpServletRequest request);
537
538 public String getCurrentURL(PortletRequest portletRequest);
539
540 public String getCustomSQLFunctionIsNotNull();
541
542 public String getCustomSQLFunctionIsNull();
543
544
552 public Date getDate(int month, int day, int year);
553
554
569 public Date getDate(
570 int month, int day, int year,
571 Class<? extends PortalException> clazz)
572 throws PortalException;
573
574
591 public Date getDate(
592 int month, int day, int year, int hour, int min,
593 Class<? extends PortalException> clazz)
594 throws PortalException;
595
596
614 public Date getDate(
615 int month, int day, int year, int hour, int min, TimeZone timeZone,
616 Class<? extends PortalException> clazz)
617 throws PortalException;
618
619
635 public Date getDate(
636 int month, int day, int year, TimeZone timeZone,
637 Class<? extends PortalException> clazz)
638 throws PortalException;
639
640 public long getDefaultCompanyId();
641
642 public long getDigestAuthUserId(HttpServletRequest request)
643 throws PortalException, SystemException;
644
645 public String getDisplayURL(Group group, ThemeDisplay themeDisplay)
646 throws PortalException;
647
648 public String getDisplayURL(
649 Group group, ThemeDisplay themeDisplay, boolean privateLayout)
650 throws PortalException;
651
652 public String getEmailFromAddress(
653 PortletPreferences preferences, long companyId, String defaultValue)
654 throws SystemException;
655
656 public String getEmailFromName(
657 PortletPreferences preferences, long companyId, String defaultValue)
658 throws SystemException;
659
660 public Map<String, Serializable> getExpandoBridgeAttributes(
661 ExpandoBridge expandoBridge, PortletRequest portletRequest)
662 throws PortalException, SystemException;
663
664 public Map<String, Serializable> getExpandoBridgeAttributes(
665 ExpandoBridge expandoBridge,
666 UploadPortletRequest uploadPortletRequest)
667 throws PortalException, SystemException;
668
669 public Serializable getExpandoValue(
670 PortletRequest portletRequest, String name, int type,
671 String displayType)
672 throws PortalException, SystemException;
673
674 public Serializable getExpandoValue(
675 UploadPortletRequest uploadPortletRequest, String name, int type,
676 String displayType)
677 throws PortalException, SystemException;
678
679 public String getFacebookURL(
680 Portlet portlet, String facebookCanvasPageURL,
681 ThemeDisplay themeDisplay)
682 throws PortalException, SystemException;
683
684 public Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
685 throws SystemException;
686
687 public String getFirstPageLayoutTypes(PageContext pageContext);
688
689 public Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
690 throws SystemException;
691
692 public String getFullName(
693 String firstName, String middleName, String lastName);
694
695 public String getGlobalLibDir();
696
697 public String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
698 throws PortalException, SystemException;
699
700 public String getGroupFriendlyURL(
701 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)
702 throws PortalException, SystemException;
703
704 public String getGroupFriendlyURL(
705 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay,
706 Locale locale)
707 throws PortalException, SystemException;
708
709 public int[] getGroupFriendlyURLIndex(String requestURI);
710
711 public String[] getGroupPermissions(HttpServletRequest request);
712
713 public String[] getGroupPermissions(
714 HttpServletRequest request, String className);
715
716 public String[] getGroupPermissions(PortletRequest portletRequest);
717
718 public String[] getGroupPermissions(
719 PortletRequest portletRequest, String className);
720
721 public String[] getGuestPermissions(HttpServletRequest request);
722
723 public String[] getGuestPermissions(
724 HttpServletRequest request, String className);
725
726 public String[] getGuestPermissions(PortletRequest portletRequest);
727
728 public String[] getGuestPermissions(
729 PortletRequest portletRequest, String className);
730
731 public String getHomeURL(HttpServletRequest request)
732 throws PortalException, SystemException;
733
734 public String getHost(HttpServletRequest request);
735
736 public String getHost(PortletRequest portletRequest);
737
738 public HttpServletRequest getHttpServletRequest(
739 PortletRequest portletRequest);
740
741 public HttpServletResponse getHttpServletResponse(
742 PortletResponse portletResponse);
743
744 public String getI18nPathLanguageId(
745 Locale locale, String defaultI18nPathLanguageId);
746
747 public String getJournalArticleActualURL(
748 long groupId, boolean privateLayout, String mainPath,
749 String friendlyURL, Map<String, String[]> params,
750 Map<String, Object> requestContext)
751 throws PortalException, SystemException;
752
753 public Layout getJournalArticleLayout(
754 long groupId, boolean privateLayout, String friendlyURL)
755 throws PortalException, SystemException;
756
757 public String getJsSafePortletId(String portletId);
758
759 public String getLayoutActualURL(Layout layout);
760
761 public String getLayoutActualURL(Layout layout, String mainPath);
762
763 public String getLayoutActualURL(
764 long groupId, boolean privateLayout, String mainPath,
765 String friendlyURL)
766 throws PortalException, SystemException;
767
768 public String getLayoutActualURL(
769 long groupId, boolean privateLayout, String mainPath,
770 String friendlyURL, Map<String, String[]> params,
771 Map<String, Object> requestContext)
772 throws PortalException, SystemException;
773
774 public String getLayoutEditPage(Layout layout);
775
776 public String getLayoutEditPage(String type);
777
778 public String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
779 throws PortalException, SystemException;
780
781 public String getLayoutFriendlyURL(
782 Layout layout, ThemeDisplay themeDisplay, Locale locale)
783 throws PortalException, SystemException;
784
785 public LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(
786 long groupId, boolean privateLayout, String friendlyURL,
787 Map<String, String[]> params, Map<String, Object> requestContext)
788 throws PortalException, SystemException;
789
790 public String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
791 throws PortalException, SystemException;
792
793 public String getLayoutFullURL(
794 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
795 throws PortalException, SystemException;
796
797 public String getLayoutFullURL(long groupId, String portletId)
798 throws PortalException, SystemException;
799
800 public String getLayoutFullURL(
801 long groupId, String portletId, boolean secure)
802 throws PortalException, SystemException;
803
804 public String getLayoutFullURL(ThemeDisplay themeDisplay)
805 throws PortalException, SystemException;
806
807 public String getLayoutSetFriendlyURL(
808 LayoutSet layoutSet, ThemeDisplay themeDisplay)
809 throws PortalException, SystemException;
810
811 public String getLayoutTarget(Layout layout);
812
813 public String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
814 throws PortalException, SystemException;
815
816 public String getLayoutURL(
817 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
818 throws PortalException, SystemException;
819
820 public String getLayoutURL(
821 Layout layout, ThemeDisplay themeDisplay, Locale locale)
822 throws PortalException, SystemException;
823
824 public String getLayoutURL(ThemeDisplay themeDisplay)
825 throws PortalException, SystemException;
826
827 public String getLayoutViewPage(Layout layout);
828
829 public String getLayoutViewPage(String type);
830
831 public LiferayPortletRequest getLiferayPortletRequest(
832 PortletRequest portletRequest);
833
834 public LiferayPortletResponse getLiferayPortletResponse(
835 PortletResponse portletResponse);
836
837 public Locale getLocale(HttpServletRequest request);
838
839 public Locale getLocale(
840 HttpServletRequest request, HttpServletResponse response,
841 boolean initialize);
842
843 public Locale getLocale(PortletRequest portletRequest);
844
845 public String getLocalizedFriendlyURL(
846 HttpServletRequest request, Layout layout, Locale locale,
847 Locale originalLocale)
848 throws Exception;
849
850 public String getMailId(String mx, String popPortletPrefix, Object... ids);
851
852 public String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
853 throws PortalException, SystemException;
854
855 public String getNewPortletTitle(
856 String portletTitle, String oldScopeName, String newScopeName);
857
858 public HttpServletRequest getOriginalServletRequest(
859 HttpServletRequest request);
860
861
864 public long getParentGroupId(long scopeGroupId)
865 throws PortalException, SystemException;
866
867 public String getPathContext();
868
869 public String getPathContext(HttpServletRequest request);
870
871 public String getPathContext(PortletRequest portletRequest);
872
873 public String getPathContext(String contextPath);
874
875 public String getPathFriendlyURLPrivateGroup();
876
877 public String getPathFriendlyURLPrivateUser();
878
879 public String getPathFriendlyURLPublic();
880
881 public String getPathImage();
882
883 public String getPathMain();
884
885 public String getPathModule();
886
887 public String getPathProxy();
888
889 public long getPlidFromFriendlyURL(long companyId, String friendlyURL);
890
891 public long getPlidFromPortletId(
892 long groupId, boolean privateLayout, String portletId)
893 throws PortalException, SystemException;
894
895 public long getPlidFromPortletId(long groupId, String portletId)
896 throws PortalException, SystemException;
897
898 public String getPortalLibDir();
899
900
904 public int getPortalPort();
905
906 public int getPortalPort(boolean secure);
907
908 public Properties getPortalProperties();
909
910 public String getPortalURL(HttpServletRequest request);
911
912 public String getPortalURL(HttpServletRequest request, boolean secure);
913
914 public String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
915 throws PortalException, SystemException;
916
917 public String getPortalURL(PortletRequest portletRequest);
918
919 public String getPortalURL(PortletRequest portletRequest, boolean secure);
920
921 public String getPortalURL(
922 String serverName, int serverPort, boolean secure);
923
924 public String getPortalURL(ThemeDisplay themeDisplay)
925 throws PortalException, SystemException;
926
927 public String getPortalWebDir();
928
929
933 public Set<String> getPortletAddDefaultResourceCheckWhitelist();
934
935
939 public Set<String> getPortletAddDefaultResourceCheckWhitelistActions();
940
941
945 public List<BreadcrumbEntry> getPortletBreadcrumbList(
946 HttpServletRequest request);
947
948 public List<BreadcrumbEntry> getPortletBreadcrumbs(
949 HttpServletRequest request);
950
951 public PortletConfig getPortletConfig(
952 long companyId, String portletId, ServletContext servletContext)
953 throws PortletException, SystemException;
954
955 public String getPortletDescription(
956 Portlet portlet, ServletContext servletContext, Locale locale);
957
958 public String getPortletDescription(Portlet portlet, User user);
959
960 public String getPortletDescription(String portletId, Locale locale);
961
962 public String getPortletDescription(String portletId, String languageId);
963
964 public String getPortletDescription(String portletId, User user);
965
966 public String getPortletId(HttpServletRequest request);
967
968 public String getPortletId(PortletRequest portletRequest);
969
970 public String getPortletLongTitle(Portlet portlet, Locale locale);
971
972 public String getPortletLongTitle(
973 Portlet portlet, ServletContext servletContext, Locale locale);
974
975 public String getPortletLongTitle(Portlet portlet, String languageId);
976
977 public String getPortletLongTitle(Portlet portlet, User user);
978
979 public String getPortletLongTitle(String portletId, Locale locale);
980
981 public String getPortletLongTitle(String portletId, String languageId);
982
983 public String getPortletLongTitle(String portletId, User user);
984
985 public String getPortletNamespace(String portletId);
986
987 public String getPortletTitle(Portlet portlet, Locale locale);
988
989 public String getPortletTitle(
990 Portlet portlet, ServletContext servletContext, Locale locale);
991
992 public String getPortletTitle(Portlet portlet, String languageId);
993
994 public String getPortletTitle(Portlet portlet, User user);
995
996 public String getPortletTitle(RenderRequest renderRequest);
997
998 public String getPortletTitle(RenderResponse renderResponse);
999
1000 public String getPortletTitle(String portletId, Locale locale);
1001
1002 public String getPortletTitle(String portletId, String languageId);
1003
1004 public String getPortletTitle(String portletId, User user);
1005
1006 public String getPortletXmlFileName() throws SystemException;
1007
1008 public PortletPreferences getPreferences(HttpServletRequest request);
1009
1010 public PreferencesValidator getPreferencesValidator(Portlet portlet);
1011
1012 public String getRelativeHomeURL(HttpServletRequest request)
1013 throws PortalException, SystemException;
1014
1015 public long getScopeGroupId(HttpServletRequest request)
1016 throws PortalException, SystemException;
1017
1018 public long getScopeGroupId(HttpServletRequest request, String portletId)
1019 throws PortalException, SystemException;
1020
1021 public long getScopeGroupId(
1022 HttpServletRequest request, String portletId,
1023 boolean checkStagingGroup)
1024 throws PortalException, SystemException;
1025
1026 public long getScopeGroupId(Layout layout);
1027
1028 public long getScopeGroupId(Layout layout, String portletId);
1029
1030 public long getScopeGroupId(long plid);
1031
1032 public long getScopeGroupId(PortletRequest portletRequest)
1033 throws PortalException, SystemException;
1034
1035 public User getSelectedUser(HttpServletRequest request)
1036 throws PortalException, SystemException;
1037
1038 public User getSelectedUser(
1039 HttpServletRequest request, boolean checkPermission)
1040 throws PortalException, SystemException;
1041
1042 public User getSelectedUser(PortletRequest portletRequest)
1043 throws PortalException, SystemException;
1044
1045 public User getSelectedUser(
1046 PortletRequest portletRequest, boolean checkPermission)
1047 throws PortalException, SystemException;
1048
1049 public String getServletContextName();
1050
1051 public long[] getSharedContentSiteGroupIds(
1052 long companyId, long groupId, long userId)
1053 throws PortalException, SystemException;
1054
1055 public Map<String, List<Portlet>> getSiteAdministrationCategoriesMap(
1056 HttpServletRequest request)
1057 throws SystemException;
1058
1059 public PortletURL getSiteAdministrationURL(
1060 HttpServletRequest request, ThemeDisplay themeDisplay)
1061 throws SystemException;
1062
1063 public PortletURL getSiteAdministrationURL(
1064 HttpServletRequest request, ThemeDisplay themeDisplay,
1065 String portletName);
1066
1067 public PortletURL getSiteAdministrationURL(
1068 PortletResponse portletResponse, ThemeDisplay themeDisplay)
1069 throws SystemException;
1070
1071 public PortletURL getSiteAdministrationURL(
1072 PortletResponse portletResponse, ThemeDisplay themeDisplay,
1073 String portletName);
1074
1075 public long[] getSiteAndCompanyGroupIds(long groupId)
1076 throws PortalException, SystemException;
1077
1078 public long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
1079 throws PortalException, SystemException;
1080
1081 public Locale getSiteDefaultLocale(long groupId)
1082 throws PortalException, SystemException;
1083
1084 public long getSiteGroupId(long groupId)
1085 throws PortalException, SystemException;
1086
1087
1097 public String getSiteLoginURL(ThemeDisplay themeDisplay)
1098 throws PortalException, SystemException;
1099
1100 public String getStaticResourceURL(HttpServletRequest request, String uri);
1101
1102 public String getStaticResourceURL(
1103 HttpServletRequest request, String uri, long timestamp);
1104
1105 public String getStaticResourceURL(
1106 HttpServletRequest request, String uri, String queryString);
1107
1108 public String getStaticResourceURL(
1109 HttpServletRequest request, String uri, String queryString,
1110 long timestamp);
1111
1112 public String getStrutsAction(HttpServletRequest request);
1113
1114 public String[] getSystemGroups();
1115
1116 public String[] getSystemOrganizationRoles();
1117
1118 public String[] getSystemRoles();
1119
1120 public String[] getSystemSiteRoles();
1121
1122 public String getUniqueElementId(
1123 HttpServletRequest request, String namespace, String id);
1124
1125 public String getUniqueElementId(
1126 PortletRequest request, String namespace, String id);
1127
1128 public UploadPortletRequest getUploadPortletRequest(
1129 PortletRequest portletRequest);
1130
1131 public UploadServletRequest getUploadServletRequest(
1132 HttpServletRequest request);
1133
1134 public Date getUptime();
1135
1136 public String getURLWithSessionId(String url, String sessionId);
1137
1138 public User getUser(HttpServletRequest request)
1139 throws PortalException, SystemException;
1140
1141 public User getUser(PortletRequest portletRequest)
1142 throws PortalException, SystemException;
1143
1144 public String getUserEmailAddress(long userId) throws SystemException;
1145
1146 public long getUserId(HttpServletRequest request);
1147
1148 public long getUserId(PortletRequest portletRequest);
1149
1150 public String getUserName(BaseModel<?> baseModel);
1151
1152 public String getUserName(long userId, String defaultUserName);
1153
1154 public String getUserName(
1155 long userId, String defaultUserName, HttpServletRequest request);
1156
1157 public String getUserName(
1158 long userId, String defaultUserName, String userAttribute);
1159
1160 public String getUserName(
1161 long userId, String defaultUserName, String userAttribute,
1162 HttpServletRequest request);
1163
1164 public String getUserPassword(HttpServletRequest request);
1165
1166 public String getUserPassword(HttpSession session);
1167
1168 public String getUserPassword(PortletRequest portletRequest);
1169
1170 public String getUserValue(long userId, String param, String defaultValue)
1171 throws SystemException;
1172
1173 public String getValidPortalDomain(long companyId, String domain);
1174
1175 public long getValidUserId(long companyId, long userId)
1176 throws PortalException, SystemException;
1177
1178 public String getVirtualLayoutActualURL(
1179 long groupId, boolean privateLayout, String mainPath,
1180 String friendlyURL, Map<String, String[]> params,
1181 Map<String, Object> requestContext)
1182 throws PortalException, SystemException;
1183
1184 public LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(
1185 boolean privateLayout, String friendlyURL,
1186 Map<String, String[]> params, Map<String, Object> requestContext)
1187 throws PortalException, SystemException;
1188
1189 public String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
1190 throws PortalException, SystemException;
1191
1192 public void initCustomSQL();
1193
1194 public User initUser(HttpServletRequest request) throws Exception;
1195
1196 public void invokeTaglibDiscussion(
1197 PortletConfig portletConfig, ActionRequest actionRequest,
1198 ActionResponse actionResponse)
1199 throws Exception;
1200
1201
1204 public boolean isAllowAddPortletDefaultResource(
1205 HttpServletRequest request, Portlet portlet)
1206 throws PortalException, SystemException;
1207
1208 public boolean isCDNDynamicResourcesEnabled(HttpServletRequest request)
1209 throws PortalException, SystemException;
1210
1211 public boolean isCDNDynamicResourcesEnabled(long companyId);
1212
1213
1216 public boolean isCommunityAdmin(User user, long groupId) throws Exception;
1217
1218
1221 public boolean isCommunityOwner(User user, long groupId) throws Exception;
1222
1223 public boolean isCompanyAdmin(User user) throws Exception;
1224
1225 public boolean isCompanyControlPanelPortlet(
1226 String portletId, String category, ThemeDisplay themeDisplay)
1227 throws PortalException, SystemException;
1228
1229 public boolean isCompanyControlPanelPortlet(
1230 String portletId, ThemeDisplay themeDisplay)
1231 throws PortalException, SystemException;
1232
1233 public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
1234 throws PortalException, SystemException;
1235
1236 public boolean isControlPanelPortlet(
1237 String portletId, String category, ThemeDisplay themeDisplay)
1238 throws SystemException;
1239
1240 public boolean isControlPanelPortlet(
1241 String portletId, ThemeDisplay themeDisplay)
1242 throws SystemException;
1243
1244 public boolean isGroupAdmin(User user, long groupId) throws Exception;
1245
1246 public boolean isGroupFriendlyURL(
1247 String fullURL, String groupFriendlyURL, String layoutFriendlyURL);
1248
1249 public boolean isGroupOwner(User user, long groupId) throws Exception;
1250
1251 public boolean isLayoutDescendant(Layout layout, long layoutId)
1252 throws PortalException, SystemException;
1253
1254 public boolean isLayoutFirstPageable(Layout layout);
1255
1256 public boolean isLayoutFirstPageable(String type);
1257
1258 public boolean isLayoutFriendliable(Layout layout);
1259
1260 public boolean isLayoutFriendliable(String type);
1261
1262 public boolean isLayoutParentable(Layout layout);
1263
1264 public boolean isLayoutParentable(String type);
1265
1266 public boolean isLayoutSitemapable(Layout layout);
1267
1268 public boolean isLoginRedirectRequired(HttpServletRequest request)
1269 throws SystemException;
1270
1271 public boolean isMethodGet(PortletRequest portletRequest);
1272
1273 public boolean isMethodPost(PortletRequest portletRequest);
1274
1275 public boolean isMultipartRequest(HttpServletRequest request);
1276
1277 public boolean isOmniadmin(long userId);
1278
1279 public boolean isReservedParameter(String name);
1280
1281 public boolean isRSSFeedsEnabled();
1282
1283 public boolean isSecure(HttpServletRequest request);
1284
1285 public boolean isSystemGroup(String groupName);
1286
1287 public boolean isSystemRole(String roleName);
1288
1289 public boolean isUpdateAvailable() throws SystemException;
1290
1291 public boolean isValidResourceId(String resourceId);
1292
1293 public void removePortalPortEventListener(
1294 PortalPortEventListener portalPortEventListener);
1295
1296 public void resetCDNHosts();
1297
1298
1302 public Set<String> resetPortletAddDefaultResourceCheckWhitelist();
1303
1304
1308 public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions();
1309
1310 public String resetPortletParameters(String url, String portletId);
1311
1312 public void sendError(
1313 Exception e, ActionRequest actionRequest,
1314 ActionResponse actionResponse)
1315 throws IOException;
1316
1317 public void sendError(
1318 Exception e, HttpServletRequest request,
1319 HttpServletResponse response)
1320 throws IOException, ServletException;
1321
1322 public void sendError(
1323 int status, Exception e, ActionRequest actionRequest,
1324 ActionResponse actionResponse)
1325 throws IOException;
1326
1327 public void sendError(
1328 int status, Exception e, HttpServletRequest request,
1329 HttpServletResponse response)
1330 throws IOException, ServletException;
1331
1332 public void sendRSSFeedsDisabledError(
1333 HttpServletRequest request, HttpServletResponse response)
1334 throws IOException, ServletException;
1335
1336 public void sendRSSFeedsDisabledError(
1337 PortletRequest portletRequest, PortletResponse portletResponse)
1338 throws IOException, ServletException;
1339
1340
1344 public void setPageDescription(
1345 String description, HttpServletRequest request);
1346
1347
1350 public void setPageKeywords(String keywords, HttpServletRequest request);
1351
1352
1355 public void setPageSubtitle(String subtitle, HttpServletRequest request);
1356
1357
1361 public void setPageTitle(String title, HttpServletRequest request);
1362
1363
1366 public void setPortalPort(HttpServletRequest request);
1367
1368 public void storePreferences(PortletPreferences portletPreferences)
1369 throws IOException, ValidatorException;
1370
1371 public String[] stripURLAnchor(String url, String separator);
1372
1373 public String transformCustomSQL(String sql);
1374
1375 public String transformSQL(String sql);
1376
1377 public PortletMode updatePortletMode(
1378 String portletId, User user, Layout layout, PortletMode portletMode,
1379 HttpServletRequest request);
1380
1381 public String updateRedirect(
1382 String redirect, String oldPath, String newPath);
1383
1384 public WindowState updateWindowState(
1385 String portletId, User user, Layout layout, WindowState windowState,
1386 HttpServletRequest request);
1387
1388 }