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
148 public void addPortalPortProtocolEventListener(
149 PortalPortProtocolEventListener portalPortProtocolEventListener);
150
151
158 public void addPortletBreadcrumbEntry(
159 HttpServletRequest request, String title, String url);
160
161
169 public void addPortletBreadcrumbEntry(
170 HttpServletRequest request, String title, String url,
171 Map<String, Object> data);
172
173
181 public void addPortletDefaultResource(
182 HttpServletRequest request, Portlet portlet)
183 throws PortalException, SystemException;
184
185 public void addPortletDefaultResource(
186 long companyId, Layout layout, Portlet portlet)
187 throws PortalException, SystemException;
188
189
206 public String addPreservedParameters(
207 ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser);
208
209
217 public String addPreservedParameters(ThemeDisplay themeDisplay, String url);
218
219 public void addUserLocaleOptionsMessage(HttpServletRequest request);
220
221
227 public void clearRequestParameters(RenderRequest renderRequest);
228
229
236 public void copyRequestParameters(
237 ActionRequest actionRequest, ActionResponse actionResponse);
238
239
247 public String escapeRedirect(String url);
248
249
256 public String generateRandomKey(HttpServletRequest request, String input);
257
258 public String getAbsoluteURL(HttpServletRequest request, String url);
259
260 public LayoutQueryStringComposite getActualLayoutQueryStringComposite(
261 long groupId, boolean privateLayout, String friendlyURL,
262 Map<String, String[]> params, Map<String, Object> requestContext)
263 throws PortalException, SystemException;
264
265 public String getActualURL(
266 long groupId, boolean privateLayout, String mainPath,
267 String friendlyURL, Map<String, String[]> params,
268 Map<String, Object> requestContext)
269 throws PortalException, SystemException;
270
271
282 public Locale[] getAlternateLocales(HttpServletRequest request)
283 throws PortalException, SystemException;
284
285
297 public String getAlternateURL(
298 String canonicalURL, ThemeDisplay themeDisplay, Locale locale,
299 Layout layout)
300 throws PortalException, SystemException;
301
302
311 public Set<String> getAuthTokenIgnoreActions();
312
313
322 public Set<String> getAuthTokenIgnorePortlets();
323
324
335 public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
336 throws PortalException, SystemException;
337
338
349 public BaseModel<?> getBaseModel(String modelName, String primKey)
350 throws PortalException, SystemException;
351
352
363 public long getBasicAuthUserId(HttpServletRequest request)
364 throws PortalException, SystemException;
365
366
378 public long getBasicAuthUserId(HttpServletRequest request, long companyId)
379 throws PortalException, SystemException;
380
381
394 public String getCanonicalURL(
395 String completeURL, ThemeDisplay themeDisplay, Layout layout)
396 throws PortalException, SystemException;
397
398
413 public String getCanonicalURL(
414 String completeURL, ThemeDisplay themeDisplay, Layout layout,
415 boolean forceLayoutFriendlyURL)
416 throws PortalException, SystemException;
417
418
422 public String getCDNHost();
423
424
431 public String getCDNHost(boolean secure);
432
433 public String getCDNHost(HttpServletRequest request)
434 throws PortalException, SystemException;
435
436
443 public String getCDNHostHttp(long companyId);
444
445
452 public String getCDNHostHttps(long companyId);
453
454
460 public String getClassName(long classNameId);
461
462
468 public long getClassNameId(Class<?> clazz);
469
470
476 public long getClassNameId(String value);
477
478
488 public String getClassNamePortletId(String className);
489
490 public Company getCompany(HttpServletRequest request)
491 throws PortalException, SystemException;
492
493 public Company getCompany(PortletRequest portletRequest)
494 throws PortalException, SystemException;
495
496 public long getCompanyId(HttpServletRequest requestuest);
497
498 public long getCompanyId(PortletRequest portletRequest);
499
500 public long[] getCompanyIds();
501
502
505 @Deprecated
506 public String getComputerAddress();
507
508 public Set<String> getComputerAddresses();
509
510 public String getComputerName();
511
512 public Map<String, List<Portlet>> getControlPanelCategoriesMap(
513 HttpServletRequest request)
514 throws SystemException;
515
516 public String getControlPanelCategory(
517 String portletId, ThemeDisplay themeDisplay)
518 throws SystemException;
519
520 public String getControlPanelFullURL(
521 long scopeGroupId, String ppid, Map<String, String[]> params)
522 throws PortalException, SystemException;
523
524 public long getControlPanelPlid(long companyId)
525 throws PortalException, SystemException;
526
527 public long getControlPanelPlid(PortletRequest portletRequest)
528 throws PortalException, SystemException;
529
530 public Set<Portlet> getControlPanelPortlets(long companyId, String category)
531 throws SystemException;
532
533 public List<Portlet> getControlPanelPortlets(
534 String category, ThemeDisplay themeDisplay)
535 throws SystemException;
536
537 public PortletURL getControlPanelPortletURL(
538 HttpServletRequest request, String portletId, long referrerPlid,
539 String lifecycle);
540
541 public PortletURL getControlPanelPortletURL(
542 PortletRequest portletRequest, String portletId, long referrerPlid,
543 String lifecycle);
544
545 public String getCreateAccountURL(
546 HttpServletRequest request, ThemeDisplay themeDisplay)
547 throws Exception;
548
549 public String getCurrentCompleteURL(HttpServletRequest request);
550
551 public String getCurrentURL(HttpServletRequest request);
552
553 public String getCurrentURL(PortletRequest portletRequest);
554
555 public String getCustomSQLFunctionIsNotNull();
556
557 public String getCustomSQLFunctionIsNull();
558
559
567 public Date getDate(int month, int day, int year);
568
569
584 public Date getDate(
585 int month, int day, int year,
586 Class<? extends PortalException> clazz)
587 throws PortalException;
588
589
606 public Date getDate(
607 int month, int day, int year, int hour, int min,
608 Class<? extends PortalException> clazz)
609 throws PortalException;
610
611
629 public Date getDate(
630 int month, int day, int year, int hour, int min, TimeZone timeZone,
631 Class<? extends PortalException> clazz)
632 throws PortalException;
633
634
650 public Date getDate(
651 int month, int day, int year, TimeZone timeZone,
652 Class<? extends PortalException> clazz)
653 throws PortalException;
654
655 public long getDefaultCompanyId();
656
657 public long getDigestAuthUserId(HttpServletRequest request)
658 throws PortalException, SystemException;
659
660 public String getDisplayURL(Group group, ThemeDisplay themeDisplay)
661 throws PortalException;
662
663 public String getDisplayURL(
664 Group group, ThemeDisplay themeDisplay, boolean privateLayout)
665 throws PortalException;
666
667 public String getEmailFromAddress(
668 PortletPreferences preferences, long companyId, String defaultValue)
669 throws SystemException;
670
671 public String getEmailFromName(
672 PortletPreferences preferences, long companyId, String defaultValue)
673 throws SystemException;
674
675 public Map<String, Serializable> getExpandoBridgeAttributes(
676 ExpandoBridge expandoBridge, HttpServletRequest request)
677 throws PortalException, SystemException;
678
679 public Map<String, Serializable> getExpandoBridgeAttributes(
680 ExpandoBridge expandoBridge, PortletRequest portletRequest)
681 throws PortalException, SystemException;
682
683 public Map<String, Serializable> getExpandoBridgeAttributes(
684 ExpandoBridge expandoBridge,
685 UploadPortletRequest uploadPortletRequest)
686 throws PortalException, SystemException;
687
688 public Serializable getExpandoValue(
689 HttpServletRequest request, String name, int type,
690 String displayType)
691 throws PortalException, SystemException;
692
693 public Serializable getExpandoValue(
694 PortletRequest portletRequest, String name, int type,
695 String displayType)
696 throws PortalException, SystemException;
697
698 public Serializable getExpandoValue(
699 UploadPortletRequest uploadPortletRequest, String name, int type,
700 String displayType)
701 throws PortalException, SystemException;
702
703 public String getFacebookURL(
704 Portlet portlet, String facebookCanvasPageURL,
705 ThemeDisplay themeDisplay)
706 throws PortalException, SystemException;
707
708 public Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
709 throws SystemException;
710
711 public String getFirstPageLayoutTypes(PageContext pageContext);
712
713 public Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
714 throws SystemException;
715
716 public String getFullName(
717 String firstName, String middleName, String lastName);
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 getGroupFriendlyURL(
729 Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay,
730 Locale locale)
731 throws PortalException, SystemException;
732
733 public int[] getGroupFriendlyURLIndex(String requestURI);
734
735 public String[] getGroupPermissions(HttpServletRequest request);
736
737 public String[] getGroupPermissions(
738 HttpServletRequest request, String className);
739
740 public String[] getGroupPermissions(PortletRequest portletRequest);
741
742 public String[] getGroupPermissions(
743 PortletRequest portletRequest, String className);
744
745 public String[] getGuestPermissions(HttpServletRequest request);
746
747 public String[] getGuestPermissions(
748 HttpServletRequest request, String className);
749
750 public String[] getGuestPermissions(PortletRequest portletRequest);
751
752 public String[] getGuestPermissions(
753 PortletRequest portletRequest, String className);
754
755 public String getHomeURL(HttpServletRequest request)
756 throws PortalException, SystemException;
757
758 public String getHost(HttpServletRequest request);
759
760 public String getHost(PortletRequest portletRequest);
761
762 public HttpServletRequest getHttpServletRequest(
763 PortletRequest portletRequest);
764
765 public HttpServletResponse getHttpServletResponse(
766 PortletResponse portletResponse);
767
768 public String getI18nPathLanguageId(
769 Locale locale, String defaultI18nPathLanguageId);
770
771 public String getJournalArticleActualURL(
772 long groupId, boolean privateLayout, String mainPath,
773 String friendlyURL, Map<String, String[]> params,
774 Map<String, Object> requestContext)
775 throws PortalException, SystemException;
776
777 public Layout getJournalArticleLayout(
778 long groupId, boolean privateLayout, String friendlyURL)
779 throws PortalException, SystemException;
780
781 public String getJsSafePortletId(String portletId);
782
783 public String getLayoutActualURL(Layout layout);
784
785 public String getLayoutActualURL(Layout layout, String mainPath);
786
787 public String getLayoutActualURL(
788 long groupId, boolean privateLayout, String mainPath,
789 String friendlyURL)
790 throws PortalException, SystemException;
791
792 public String getLayoutActualURL(
793 long groupId, boolean privateLayout, String mainPath,
794 String friendlyURL, Map<String, String[]> params,
795 Map<String, Object> requestContext)
796 throws PortalException, SystemException;
797
798 public String getLayoutEditPage(Layout layout);
799
800 public String getLayoutEditPage(String type);
801
802 public String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
803 throws PortalException, SystemException;
804
805 public String getLayoutFriendlyURL(
806 Layout layout, ThemeDisplay themeDisplay, Locale locale)
807 throws PortalException, SystemException;
808
809 public LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(
810 long groupId, boolean privateLayout, String friendlyURL,
811 Map<String, String[]> params, Map<String, Object> requestContext)
812 throws PortalException, SystemException;
813
814 public String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
815 throws PortalException, SystemException;
816
817 public String getLayoutFullURL(
818 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
819 throws PortalException, SystemException;
820
821 public String getLayoutFullURL(long groupId, String portletId)
822 throws PortalException, SystemException;
823
824 public String getLayoutFullURL(
825 long groupId, String portletId, boolean secure)
826 throws PortalException, SystemException;
827
828 public String getLayoutFullURL(ThemeDisplay themeDisplay)
829 throws PortalException, SystemException;
830
831 public String getLayoutSetFriendlyURL(
832 LayoutSet layoutSet, ThemeDisplay themeDisplay)
833 throws PortalException, SystemException;
834
835 public String getLayoutTarget(Layout layout);
836
837 public String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
838 throws PortalException, SystemException;
839
840 public String getLayoutURL(
841 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
842 throws PortalException, SystemException;
843
844 public String getLayoutURL(
845 Layout layout, ThemeDisplay themeDisplay, Locale locale)
846 throws PortalException, SystemException;
847
848 public String getLayoutURL(ThemeDisplay themeDisplay)
849 throws PortalException, SystemException;
850
851 public String getLayoutViewPage(Layout layout);
852
853 public String getLayoutViewPage(String type);
854
855 public LiferayPortletRequest getLiferayPortletRequest(
856 PortletRequest portletRequest);
857
858 public LiferayPortletResponse getLiferayPortletResponse(
859 PortletResponse portletResponse);
860
861 public Locale getLocale(HttpServletRequest request);
862
863 public Locale getLocale(
864 HttpServletRequest request, HttpServletResponse response,
865 boolean initialize);
866
867 public Locale getLocale(PortletRequest portletRequest);
868
869 public String getLocalizedFriendlyURL(
870 HttpServletRequest request, Layout layout, Locale locale,
871 Locale originalLocale)
872 throws Exception;
873
874 public String getMailId(String mx, String popPortletPrefix, Object... ids);
875
876 public String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
877 throws PortalException, SystemException;
878
879 public String getNewPortletTitle(
880 String portletTitle, String oldScopeName, String newScopeName);
881
882 public HttpServletRequest getOriginalServletRequest(
883 HttpServletRequest request);
884
885
888 public long getParentGroupId(long scopeGroupId)
889 throws PortalException, SystemException;
890
891 public String getPathContext();
892
893 public String getPathContext(HttpServletRequest request);
894
895 public String getPathContext(PortletRequest portletRequest);
896
897 public String getPathContext(String contextPath);
898
899 public String getPathFriendlyURLPrivateGroup();
900
901 public String getPathFriendlyURLPrivateUser();
902
903 public String getPathFriendlyURLPublic();
904
905 public String getPathImage();
906
907 public String getPathMain();
908
909 public String getPathModule();
910
911 public String getPathProxy();
912
913 public long getPlidFromFriendlyURL(long companyId, String friendlyURL);
914
915 public long getPlidFromPortletId(
916 long groupId, boolean privateLayout, String portletId)
917 throws PortalException, SystemException;
918
919 public long getPlidFromPortletId(long groupId, String portletId)
920 throws PortalException, SystemException;
921
922 public String getPortalLibDir();
923
924
928 public int getPortalPort();
929
930 public int getPortalPort(boolean secure);
931
932 public Properties getPortalProperties();
933
934 public String getPortalURL(HttpServletRequest request);
935
936 public String getPortalURL(HttpServletRequest request, boolean secure);
937
938 public String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
939 throws PortalException, SystemException;
940
941 public String getPortalURL(PortletRequest portletRequest);
942
943 public String getPortalURL(PortletRequest portletRequest, boolean secure);
944
945 public String getPortalURL(
946 String serverName, int serverPort, boolean secure);
947
948 public String getPortalURL(ThemeDisplay themeDisplay)
949 throws PortalException, SystemException;
950
951 public String getPortalWebDir();
952
953
957 public Set<String> getPortletAddDefaultResourceCheckWhitelist();
958
959
963 public Set<String> getPortletAddDefaultResourceCheckWhitelistActions();
964
965
969 public List<BreadcrumbEntry> getPortletBreadcrumbList(
970 HttpServletRequest request);
971
972 public List<BreadcrumbEntry> getPortletBreadcrumbs(
973 HttpServletRequest request);
974
975 public PortletConfig getPortletConfig(
976 long companyId, String portletId, ServletContext servletContext)
977 throws PortletException, SystemException;
978
979 public String getPortletDescription(
980 Portlet portlet, ServletContext servletContext, Locale locale);
981
982 public String getPortletDescription(Portlet portlet, User user);
983
984 public String getPortletDescription(String portletId, Locale locale);
985
986 public String getPortletDescription(String portletId, String languageId);
987
988 public String getPortletDescription(String portletId, User user);
989
990 public String getPortletId(HttpServletRequest request);
991
992 public String getPortletId(PortletRequest portletRequest);
993
994 public String getPortletLongTitle(Portlet portlet, Locale locale);
995
996 public String getPortletLongTitle(
997 Portlet portlet, ServletContext servletContext, Locale locale);
998
999 public String getPortletLongTitle(Portlet portlet, String languageId);
1000
1001 public String getPortletLongTitle(Portlet portlet, User user);
1002
1003 public String getPortletLongTitle(String portletId, Locale locale);
1004
1005 public String getPortletLongTitle(String portletId, String languageId);
1006
1007 public String getPortletLongTitle(String portletId, User user);
1008
1009 public String getPortletNamespace(String portletId);
1010
1011 public String getPortletTitle(Portlet portlet, Locale locale);
1012
1013 public String getPortletTitle(
1014 Portlet portlet, ServletContext servletContext, Locale locale);
1015
1016 public String getPortletTitle(Portlet portlet, String languageId);
1017
1018 public String getPortletTitle(Portlet portlet, User user);
1019
1020 public String getPortletTitle(RenderRequest renderRequest);
1021
1022 public String getPortletTitle(RenderResponse renderResponse);
1023
1024 public String getPortletTitle(String portletId, Locale locale);
1025
1026 public String getPortletTitle(String portletId, String languageId);
1027
1028 public String getPortletTitle(String portletId, User user);
1029
1030 public String getPortletXmlFileName() throws SystemException;
1031
1032 public PortletPreferences getPreferences(HttpServletRequest request);
1033
1034 public PreferencesValidator getPreferencesValidator(Portlet portlet);
1035
1036 public String getRelativeHomeURL(HttpServletRequest request)
1037 throws PortalException, SystemException;
1038
1039 public long getScopeGroupId(HttpServletRequest request)
1040 throws PortalException, SystemException;
1041
1042 public long getScopeGroupId(HttpServletRequest request, String portletId)
1043 throws PortalException, SystemException;
1044
1045 public long getScopeGroupId(
1046 HttpServletRequest request, String portletId,
1047 boolean checkStagingGroup)
1048 throws PortalException, SystemException;
1049
1050 public long getScopeGroupId(Layout layout);
1051
1052 public long getScopeGroupId(Layout layout, String portletId);
1053
1054 public long getScopeGroupId(long plid);
1055
1056 public long getScopeGroupId(PortletRequest portletRequest)
1057 throws PortalException, SystemException;
1058
1059 public User getSelectedUser(HttpServletRequest request)
1060 throws PortalException, SystemException;
1061
1062 public User getSelectedUser(
1063 HttpServletRequest request, boolean checkPermission)
1064 throws PortalException, SystemException;
1065
1066 public User getSelectedUser(PortletRequest portletRequest)
1067 throws PortalException, SystemException;
1068
1069 public User getSelectedUser(
1070 PortletRequest portletRequest, boolean checkPermission)
1071 throws PortalException, SystemException;
1072
1073 public String getServletContextName();
1074
1075 public long[] getSharedContentSiteGroupIds(
1076 long companyId, long groupId, long userId)
1077 throws PortalException, SystemException;
1078
1079 public Map<String, List<Portlet>> getSiteAdministrationCategoriesMap(
1080 HttpServletRequest request)
1081 throws SystemException;
1082
1083 public PortletURL getSiteAdministrationURL(
1084 HttpServletRequest request, ThemeDisplay themeDisplay)
1085 throws SystemException;
1086
1087 public PortletURL getSiteAdministrationURL(
1088 HttpServletRequest request, ThemeDisplay themeDisplay,
1089 String portletName);
1090
1091 public PortletURL getSiteAdministrationURL(
1092 PortletResponse portletResponse, ThemeDisplay themeDisplay)
1093 throws SystemException;
1094
1095 public PortletURL getSiteAdministrationURL(
1096 PortletResponse portletResponse, ThemeDisplay themeDisplay,
1097 String portletName);
1098
1099 public long[] getSiteAndCompanyGroupIds(long groupId)
1100 throws PortalException, SystemException;
1101
1102 public long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
1103 throws PortalException, SystemException;
1104
1105 public Locale getSiteDefaultLocale(long groupId)
1106 throws PortalException, SystemException;
1107
1108 public long getSiteGroupId(long groupId)
1109 throws PortalException, SystemException;
1110
1111
1121 public String getSiteLoginURL(ThemeDisplay themeDisplay)
1122 throws PortalException, SystemException;
1123
1124 public String getStaticResourceURL(HttpServletRequest request, String uri);
1125
1126 public String getStaticResourceURL(
1127 HttpServletRequest request, String uri, long timestamp);
1128
1129 public String getStaticResourceURL(
1130 HttpServletRequest request, String uri, String queryString);
1131
1132 public String getStaticResourceURL(
1133 HttpServletRequest request, String uri, String queryString,
1134 long timestamp);
1135
1136 public String getStrutsAction(HttpServletRequest request);
1137
1138 public String[] getSystemGroups();
1139
1140 public String[] getSystemOrganizationRoles();
1141
1142 public String[] getSystemRoles();
1143
1144 public String[] getSystemSiteRoles();
1145
1146 public String getUniqueElementId(
1147 HttpServletRequest request, String namespace, String id);
1148
1149 public String getUniqueElementId(
1150 PortletRequest request, String namespace, String id);
1151
1152 public UploadPortletRequest getUploadPortletRequest(
1153 PortletRequest portletRequest);
1154
1155 public UploadServletRequest getUploadServletRequest(
1156 HttpServletRequest request);
1157
1158 public Date getUptime();
1159
1160 public String getURLWithSessionId(String url, String sessionId);
1161
1162 public User getUser(HttpServletRequest request)
1163 throws PortalException, SystemException;
1164
1165 public User getUser(PortletRequest portletRequest)
1166 throws PortalException, SystemException;
1167
1168 public String getUserEmailAddress(long userId) throws SystemException;
1169
1170 public long getUserId(HttpServletRequest request);
1171
1172 public long getUserId(PortletRequest portletRequest);
1173
1174 public String getUserName(BaseModel<?> baseModel);
1175
1176 public String getUserName(long userId, String defaultUserName);
1177
1178 public String getUserName(
1179 long userId, String defaultUserName, HttpServletRequest request);
1180
1181 public String getUserName(
1182 long userId, String defaultUserName, String userAttribute);
1183
1184 public String getUserName(
1185 long userId, String defaultUserName, String userAttribute,
1186 HttpServletRequest request);
1187
1188 public String getUserPassword(HttpServletRequest request);
1189
1190 public String getUserPassword(HttpSession session);
1191
1192 public String getUserPassword(PortletRequest portletRequest);
1193
1194 public String getUserValue(long userId, String param, String defaultValue)
1195 throws SystemException;
1196
1197 public String getValidPortalDomain(long companyId, String domain);
1198
1199 public long getValidUserId(long companyId, long userId)
1200 throws PortalException, SystemException;
1201
1202 public String getVirtualLayoutActualURL(
1203 long groupId, boolean privateLayout, String mainPath,
1204 String friendlyURL, Map<String, String[]> params,
1205 Map<String, Object> requestContext)
1206 throws PortalException, SystemException;
1207
1208 public LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(
1209 boolean privateLayout, String friendlyURL,
1210 Map<String, String[]> params, Map<String, Object> requestContext)
1211 throws PortalException, SystemException;
1212
1213 public String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
1214 throws PortalException, SystemException;
1215
1216 public void initCustomSQL();
1217
1218 public User initUser(HttpServletRequest request) throws Exception;
1219
1220 public void invokeTaglibDiscussion(
1221 PortletConfig portletConfig, ActionRequest actionRequest,
1222 ActionResponse actionResponse)
1223 throws Exception;
1224
1225
1228 public boolean isAllowAddPortletDefaultResource(
1229 HttpServletRequest request, Portlet portlet)
1230 throws PortalException, SystemException;
1231
1232 public boolean isCDNDynamicResourcesEnabled(HttpServletRequest request)
1233 throws PortalException, SystemException;
1234
1235 public boolean isCDNDynamicResourcesEnabled(long companyId);
1236
1237
1240 public boolean isCommunityAdmin(User user, long groupId) throws Exception;
1241
1242
1245 public boolean isCommunityOwner(User user, long groupId) throws Exception;
1246
1247 public boolean isCompanyAdmin(User user) throws Exception;
1248
1249 public boolean isCompanyControlPanelPortlet(
1250 String portletId, String category, ThemeDisplay themeDisplay)
1251 throws PortalException, SystemException;
1252
1253 public boolean isCompanyControlPanelPortlet(
1254 String portletId, ThemeDisplay themeDisplay)
1255 throws PortalException, SystemException;
1256
1257 public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
1258 throws PortalException, SystemException;
1259
1260 public boolean isControlPanelPortlet(
1261 String portletId, String category, ThemeDisplay themeDisplay)
1262 throws SystemException;
1263
1264 public boolean isControlPanelPortlet(
1265 String portletId, ThemeDisplay themeDisplay)
1266 throws SystemException;
1267
1268 public boolean isGroupAdmin(User user, long groupId) throws Exception;
1269
1270 public boolean isGroupFriendlyURL(
1271 String fullURL, String groupFriendlyURL, String layoutFriendlyURL);
1272
1273 public boolean isGroupOwner(User user, long groupId) throws Exception;
1274
1275 public boolean isLayoutDescendant(Layout layout, long layoutId)
1276 throws PortalException, SystemException;
1277
1278 public boolean isLayoutFirstPageable(Layout layout);
1279
1280 public boolean isLayoutFirstPageable(String type);
1281
1282 public boolean isLayoutFriendliable(Layout layout);
1283
1284 public boolean isLayoutFriendliable(String type);
1285
1286 public boolean isLayoutParentable(Layout layout);
1287
1288 public boolean isLayoutParentable(String type);
1289
1290 public boolean isLayoutSitemapable(Layout layout);
1291
1292 public boolean isLoginRedirectRequired(HttpServletRequest request)
1293 throws SystemException;
1294
1295 public boolean isMethodGet(PortletRequest portletRequest);
1296
1297 public boolean isMethodPost(PortletRequest portletRequest);
1298
1299 public boolean isMultipartRequest(HttpServletRequest request);
1300
1301 public boolean isOmniadmin(long userId);
1302
1303 public boolean isReservedParameter(String name);
1304
1305 public boolean isRightToLeft(HttpServletRequest request);
1306
1307 public boolean isRSSFeedsEnabled();
1308
1309 public boolean isSecure(HttpServletRequest request);
1310
1311 public boolean isSystemGroup(String groupName);
1312
1313 public boolean isSystemRole(String roleName);
1314
1315 public boolean isUpdateAvailable() throws SystemException;
1316
1317 public boolean isValidResourceId(String resourceId);
1318
1319 public void removePortalPortEventListener(
1320 PortalPortEventListener portalPortEventListener);
1321
1322 public void resetCDNHosts();
1323
1324
1328 public Set<String> resetPortletAddDefaultResourceCheckWhitelist();
1329
1330
1334 public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions();
1335
1336 public String resetPortletParameters(String url, String portletId);
1337
1338 public void sendError(
1339 Exception e, ActionRequest actionRequest,
1340 ActionResponse actionResponse)
1341 throws IOException;
1342
1343 public void sendError(
1344 Exception e, HttpServletRequest request,
1345 HttpServletResponse response)
1346 throws IOException, ServletException;
1347
1348 public void sendError(
1349 int status, Exception e, ActionRequest actionRequest,
1350 ActionResponse actionResponse)
1351 throws IOException;
1352
1353 public void sendError(
1354 int status, Exception e, HttpServletRequest request,
1355 HttpServletResponse response)
1356 throws IOException, ServletException;
1357
1358 public void sendRSSFeedsDisabledError(
1359 HttpServletRequest request, HttpServletResponse response)
1360 throws IOException, ServletException;
1361
1362 public void sendRSSFeedsDisabledError(
1363 PortletRequest portletRequest, PortletResponse portletResponse)
1364 throws IOException, ServletException;
1365
1366
1370 public void setPageDescription(
1371 String description, HttpServletRequest request);
1372
1373
1376 public void setPageKeywords(String keywords, HttpServletRequest request);
1377
1378
1381 public void setPageSubtitle(String subtitle, HttpServletRequest request);
1382
1383
1387 public void setPageTitle(String title, HttpServletRequest request);
1388
1389
1392 public void setPortalPort(HttpServletRequest request);
1393
1394 public void storePreferences(PortletPreferences portletPreferences)
1395 throws IOException, ValidatorException;
1396
1397 public String[] stripURLAnchor(String url, String separator);
1398
1399 public String transformCustomSQL(String sql);
1400
1401 public String transformSQL(String sql);
1402
1403 public PortletMode updatePortletMode(
1404 String portletId, User user, Layout layout, PortletMode portletMode,
1405 HttpServletRequest request)
1406 throws PortalException, SystemException;
1407
1408 public String updateRedirect(
1409 String redirect, String oldPath, String newPath);
1410
1411 public WindowState updateWindowState(
1412 String portletId, User user, Layout layout, WindowState windowState,
1413 HttpServletRequest request);
1414
1415 }