001
014
015 package com.liferay.portal.util;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.portlet.LiferayPortletRequest;
021 import com.liferay.portal.kernel.portlet.LiferayPortletResponse;
022 import com.liferay.portal.kernel.servlet.taglib.ui.BreadcrumbEntry;
023 import com.liferay.portal.kernel.upload.UploadPortletRequest;
024 import com.liferay.portal.kernel.upload.UploadServletRequest;
025 import com.liferay.portal.model.BaseModel;
026 import com.liferay.portal.model.Company;
027 import com.liferay.portal.model.Group;
028 import com.liferay.portal.model.Layout;
029 import com.liferay.portal.model.LayoutFriendlyURLComposite;
030 import com.liferay.portal.model.LayoutQueryStringComposite;
031 import com.liferay.portal.model.LayoutSet;
032 import com.liferay.portal.model.Portlet;
033 import com.liferay.portal.model.ResourcePermission;
034 import com.liferay.portal.model.User;
035 import com.liferay.portal.theme.ThemeDisplay;
036 import com.liferay.portlet.expando.model.ExpandoBridge;
037
038 import java.io.IOException;
039 import java.io.Serializable;
040
041 import java.net.InetAddress;
042
043 import java.util.Date;
044 import java.util.List;
045 import java.util.Locale;
046 import java.util.Map;
047 import java.util.Properties;
048 import java.util.ResourceBundle;
049 import java.util.Set;
050 import java.util.TimeZone;
051
052 import javax.portlet.ActionRequest;
053 import javax.portlet.ActionResponse;
054 import javax.portlet.PortletConfig;
055 import javax.portlet.PortletException;
056 import javax.portlet.PortletMode;
057 import javax.portlet.PortletPreferences;
058 import javax.portlet.PortletRequest;
059 import javax.portlet.PortletResponse;
060 import javax.portlet.PortletURL;
061 import javax.portlet.PreferencesValidator;
062 import javax.portlet.RenderRequest;
063 import javax.portlet.ResourceRequest;
064 import javax.portlet.ResourceResponse;
065 import javax.portlet.ValidatorException;
066 import javax.portlet.WindowState;
067
068 import javax.servlet.ServletContext;
069 import javax.servlet.ServletException;
070 import javax.servlet.http.HttpServletRequest;
071 import javax.servlet.http.HttpServletResponse;
072 import javax.servlet.http.HttpSession;
073
074
078 @ProviderType
079 public interface Portal {
080
081 public static final String FRIENDLY_URL_SEPARATOR = "/-/";
082
083 public static final String JSESSIONID = ";jsessionid=";
084
085 public static final String PATH_IMAGE = "/image";
086
087 public static final String PATH_MAIN = "/c";
088
089 public static final String PATH_MODULE = "/o";
090
091 public static final String PATH_PORTAL_LAYOUT = "/portal/layout";
092
093 public static final String PORTAL_REALM = "PortalRealm";
094
095 public static final String PORTLET_XML_FILE_NAME_CUSTOM =
096 "portlet-custom.xml";
097
098 public static final String PORTLET_XML_FILE_NAME_STANDARD = "portlet.xml";
099
100 public static final String TEMP_OBFUSCATION_VALUE =
101 "TEMP_OBFUSCATION_VALUE";
102
103
110 public void addPageDescription(
111 String description, HttpServletRequest request);
112
113
120 public void addPageKeywords(String keywords, HttpServletRequest request);
121
122
128 public void addPageSubtitle(String subtitle, HttpServletRequest request);
129
130
136 public void addPageTitle(String title, HttpServletRequest request);
137
138 public boolean addPortalInetSocketAddressEventListener(
139 PortalInetSocketAddressEventListener
140 portalInetSocketAddressEventListener);
141
142
151 @Deprecated
152 public void addPortalPortEventListener(
153 PortalPortEventListener portalPortEventListener);
154
155
162 public void addPortletBreadcrumbEntry(
163 HttpServletRequest request, String title, String url);
164
165
173 public void addPortletBreadcrumbEntry(
174 HttpServletRequest request, String title, String url,
175 Map<String, Object> data);
176
177
184 public void addPortletDefaultResource(
185 HttpServletRequest request, Portlet portlet)
186 throws PortalException;
187
188 public void addPortletDefaultResource(
189 long companyId, Layout layout, Portlet portlet)
190 throws PortalException;
191
192
209 public String addPreservedParameters(
210 ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser);
211
212
220 public String addPreservedParameters(ThemeDisplay themeDisplay, String url);
221
222 public void addUserLocaleOptionsMessage(HttpServletRequest request);
223
224
230 public void clearRequestParameters(RenderRequest renderRequest);
231
232
239 public void copyRequestParameters(
240 ActionRequest actionRequest, ActionResponse actionResponse);
241
242
250 public String escapeRedirect(String url);
251
252
259 public String generateRandomKey(HttpServletRequest request, String input);
260
261 public String getAbsoluteURL(HttpServletRequest request, String url);
262
263 public LayoutQueryStringComposite getActualLayoutQueryStringComposite(
264 long groupId, boolean privateLayout, String friendlyURL,
265 Map<String, String[]> params, Map<String, Object> requestContext)
266 throws PortalException;
267
268 public String getActualURL(
269 long groupId, boolean privateLayout, String mainPath,
270 String friendlyURL, Map<String, String[]> params,
271 Map<String, Object> requestContext)
272 throws PortalException;
273
274
293 public String getAlternateURL(
294 String canonicalURL, ThemeDisplay themeDisplay, Locale locale,
295 Layout layout)
296 throws PortalException;
297
298 public long[] getAncestorSiteGroupIds(long groupId) throws PortalException;
299
300
309 @Deprecated
310 public Set<String> getAuthTokenIgnoreActions();
311
312
321 @Deprecated
322 public Set<String> getAuthTokenIgnorePortlets();
323
324
334 public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
335 throws PortalException;
336
337
347 public BaseModel<?> getBaseModel(String modelName, String primKey)
348 throws PortalException;
349
350
360 public long getBasicAuthUserId(HttpServletRequest request)
361 throws PortalException;
362
363
374 public long getBasicAuthUserId(HttpServletRequest request, long companyId)
375 throws PortalException;
376
377 public List<Group> getBrowsableScopeGroups(
378 long userId, long companyId, long groupId, String portletId)
379 throws PortalException;
380
381
393 public String getCanonicalURL(
394 String completeURL, ThemeDisplay themeDisplay, Layout layout)
395 throws PortalException;
396
397
411 public String getCanonicalURL(
412 String completeURL, ThemeDisplay themeDisplay, Layout layout,
413 boolean forceLayoutFriendlyURL)
414 throws PortalException;
415
416
420 @Deprecated
421 public String getCDNHost();
422
423
430 public String getCDNHost(boolean secure);
431
432 public String getCDNHost(HttpServletRequest request) throws PortalException;
433
434
441 public String getCDNHostHttp(long companyId);
442
443
450 public String getCDNHostHttps(long companyId);
451
452
458 public String getClassName(long classNameId);
459
460
466 public long getClassNameId(Class<?> clazz);
467
468
474 public long getClassNameId(String value);
475
476 public Company getCompany(HttpServletRequest request)
477 throws PortalException;
478
479 public Company getCompany(PortletRequest portletRequest)
480 throws PortalException;
481
482 public long getCompanyId(HttpServletRequest requestuest);
483
484 public long getCompanyId(PortletRequest portletRequest);
485
486 public long[] getCompanyIds();
487
488 public String getComputerAddress();
489
490 public String getComputerName();
491
492 public Map<String, List<Portlet>> getControlPanelCategoriesMap(
493 HttpServletRequest request);
494
495 public String getControlPanelCategory(
496 String portletId, ThemeDisplay themeDisplay);
497
498 public String getControlPanelFullURL(
499 long scopeGroupId, String ppid, Map<String, String[]> params)
500 throws PortalException;
501
502 public long getControlPanelPlid(long companyId) throws PortalException;
503
504 public long getControlPanelPlid(PortletRequest portletRequest)
505 throws PortalException;
506
507 public Set<Portlet> getControlPanelPortlets(
508 long companyId, String category);
509
510 public List<Portlet> getControlPanelPortlets(
511 String category, ThemeDisplay themeDisplay);
512
513 public PortletURL getControlPanelPortletURL(
514 HttpServletRequest request, String portletId, long referrerPlid,
515 String lifecycle);
516
517 public PortletURL getControlPanelPortletURL(
518 PortletRequest portletRequest, String portletId, long referrerPlid,
519 String lifecycle);
520
521 public String getCreateAccountURL(
522 HttpServletRequest request, ThemeDisplay themeDisplay)
523 throws Exception;
524
525 public long[] getCurrentAndAncestorSiteGroupIds(long groupId)
526 throws PortalException;
527
528 public long[] getCurrentAndAncestorSiteGroupIds(
529 long groupId, boolean checkContentSharingWithChildrenEnabled)
530 throws PortalException;
531
532 public long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds)
533 throws PortalException;
534
535 public long[] getCurrentAndAncestorSiteGroupIds(
536 long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
537 throws PortalException;
538
539 public List<Group> getCurrentAndAncestorSiteGroups(long groupId)
540 throws PortalException;
541
542 public List<Group> getCurrentAndAncestorSiteGroups(
543 long groupId, boolean checkContentSharingWithChildrenEnabled)
544 throws PortalException;
545
546 public List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds)
547 throws PortalException;
548
549 public List<Group> getCurrentAndAncestorSiteGroups(
550 long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
551 throws PortalException;
552
553 public String getCurrentCompleteURL(HttpServletRequest request);
554
555 public String getCurrentURL(HttpServletRequest request);
556
557 public String getCurrentURL(PortletRequest portletRequest);
558
559 public String getCustomSQLFunctionIsNotNull();
560
561 public String getCustomSQLFunctionIsNull();
562
563
572 public Date getDate(int month, int day, int year);
573
574
589 public Date getDate(
590 int month, int day, int year,
591 Class<? extends PortalException> clazz)
592 throws PortalException;
593
594
611 public Date getDate(
612 int month, int day, int year, int hour, int min,
613 Class<? extends PortalException> clazz)
614 throws PortalException;
615
616
634 public Date getDate(
635 int month, int day, int year, int hour, int min, TimeZone timeZone,
636 Class<? extends PortalException> clazz)
637 throws PortalException;
638
639
655 public Date getDate(
656 int month, int day, int year, TimeZone timeZone,
657 Class<? extends PortalException> clazz)
658 throws PortalException;
659
660 public long getDefaultCompanyId();
661
662 public long getDigestAuthUserId(HttpServletRequest request)
663 throws PortalException;
664
665 public String getEmailFromAddress(
666 PortletPreferences preferences, long companyId, String defaultValue);
667
668 public String getEmailFromName(
669 PortletPreferences preferences, long companyId, String defaultValue);
670
671 public Map<String, Serializable> getExpandoBridgeAttributes(
672 ExpandoBridge expandoBridge, HttpServletRequest request)
673 throws PortalException;
674
675 public Map<String, Serializable> getExpandoBridgeAttributes(
676 ExpandoBridge expandoBridge, PortletRequest portletRequest)
677 throws PortalException;
678
679 public Map<String, Serializable> getExpandoBridgeAttributes(
680 ExpandoBridge expandoBridge,
681 UploadPortletRequest uploadPortletRequest)
682 throws PortalException;
683
684 public Serializable getExpandoValue(
685 HttpServletRequest request, String name, int type,
686 String displayType)
687 throws PortalException;
688
689 public Serializable getExpandoValue(
690 PortletRequest portletRequest, String name, int type,
691 String displayType)
692 throws PortalException;
693
694 public Serializable getExpandoValue(
695 UploadPortletRequest uploadPortletRequest, String name, int type,
696 String displayType)
697 throws PortalException;
698
699 public String getFacebookURL(
700 Portlet portlet, String facebookCanvasPageURL,
701 ThemeDisplay themeDisplay)
702 throws PortalException;
703
704
707 @Deprecated
708 public Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay);
709
710 public String getFirstPageLayoutTypes(HttpServletRequest request);
711
712 public Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay);
713
714 public String getFullName(
715 String firstName, String middleName, String lastName);
716
717 public String getGlobalLibDir();
718
719 public String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
720 throws PortalException;
721
722 public String getGroupFriendlyURL(
723 LayoutSet layoutSet, ThemeDisplay themeDisplay)
724 throws PortalException;
725
726 public String getGroupFriendlyURL(
727 LayoutSet layoutSet, ThemeDisplay themeDisplay, Locale locale)
728 throws PortalException;
729
730 public int[] getGroupFriendlyURLIndex(String requestURI);
731
732 public String[] getGroupPermissions(HttpServletRequest request);
733
734 public String[] getGroupPermissions(
735 HttpServletRequest request, String className);
736
737 public String[] getGroupPermissions(PortletRequest portletRequest);
738
739 public String[] getGroupPermissions(
740 PortletRequest portletRequest, String className);
741
742 public String[] getGuestPermissions(HttpServletRequest request);
743
744 public String[] getGuestPermissions(
745 HttpServletRequest request, String className);
746
747 public String[] getGuestPermissions(PortletRequest portletRequest);
748
749 public String[] getGuestPermissions(
750 PortletRequest portletRequest, String className);
751
752 public String getHomeURL(HttpServletRequest request) throws PortalException;
753
754 public String getHost(HttpServletRequest request);
755
756 public String getHost(PortletRequest portletRequest);
757
758 public HttpServletRequest getHttpServletRequest(
759 PortletRequest portletRequest);
760
761 public HttpServletResponse getHttpServletResponse(
762 PortletResponse portletResponse);
763
764 public String getI18nPathLanguageId(
765 Locale locale, String defaultI18nPathLanguageId);
766
767
770 @Deprecated
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;
776
777
780 @Deprecated
781 public Layout getJournalArticleLayout(
782 long groupId, boolean privateLayout, String friendlyURL)
783 throws PortalException;
784
785 public String getJsSafePortletId(String portletId);
786
787 public String getLayoutActualURL(Layout layout);
788
789 public String getLayoutActualURL(Layout layout, String mainPath);
790
791 public String getLayoutActualURL(
792 long groupId, boolean privateLayout, String mainPath,
793 String friendlyURL)
794 throws PortalException;
795
796 public String getLayoutActualURL(
797 long groupId, boolean privateLayout, String mainPath,
798 String friendlyURL, Map<String, String[]> params,
799 Map<String, Object> requestContext)
800 throws PortalException;
801
802 public String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
803 throws PortalException;
804
805 public String getLayoutFriendlyURL(
806 Layout layout, ThemeDisplay themeDisplay, Locale locale)
807 throws PortalException;
808
809 public LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(
810 long groupId, boolean privateLayout, String friendlyURL,
811 Map<String, String[]> params, Map<String, Object> requestContext)
812 throws PortalException;
813
814 public String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
815 throws PortalException;
816
817 public String getLayoutFullURL(
818 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
819 throws PortalException;
820
821 public String getLayoutFullURL(long groupId, String portletId)
822 throws PortalException;
823
824 public String getLayoutFullURL(
825 long groupId, String portletId, boolean secure)
826 throws PortalException;
827
828 public String getLayoutFullURL(ThemeDisplay themeDisplay)
829 throws PortalException;
830
831 public String getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay)
832 throws PortalException;
833
834 public String getLayoutRelativeURL(
835 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
836 throws PortalException;
837
838 public String getLayoutSetFriendlyURL(
839 LayoutSet layoutSet, ThemeDisplay themeDisplay)
840 throws PortalException;
841
842 public String getLayoutTarget(Layout layout);
843
844 public String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
845 throws PortalException;
846
847 public String getLayoutURL(
848 Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
849 throws PortalException;
850
851 public String getLayoutURL(
852 Layout layout, ThemeDisplay themeDisplay, Locale locale)
853 throws PortalException;
854
855 public String getLayoutURL(ThemeDisplay themeDisplay)
856 throws PortalException;
857
858 public LiferayPortletRequest getLiferayPortletRequest(
859 PortletRequest portletRequest);
860
861 public LiferayPortletResponse getLiferayPortletResponse(
862 PortletResponse portletResponse);
863
864 public Locale getLocale(HttpServletRequest request);
865
866 public Locale getLocale(
867 HttpServletRequest request, HttpServletResponse response,
868 boolean initialize);
869
870 public Locale getLocale(PortletRequest portletRequest);
871
872 public String getLocalizedFriendlyURL(
873 HttpServletRequest request, Layout layout, Locale locale,
874 Locale originalLocale)
875 throws Exception;
876
877 public String getMailId(String mx, String popPortletPrefix, Object... ids);
878
879 public String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
880 throws PortalException;
881
882 public String getNewPortletTitle(
883 String portletTitle, String oldScopeName, String newScopeName);
884
885 public HttpServletRequest getOriginalServletRequest(
886 HttpServletRequest request);
887
888
891 @Deprecated
892 public long getParentGroupId(long scopeGroupId);
893
894 public String getPathContext();
895
896 public String getPathContext(HttpServletRequest request);
897
898 public String getPathContext(PortletRequest portletRequest);
899
900 public String getPathContext(String contextPath);
901
902 public String getPathFriendlyURLPrivateGroup();
903
904 public String getPathFriendlyURLPrivateUser();
905
906 public String getPathFriendlyURLPublic();
907
908 public String getPathImage();
909
910 public String getPathMain();
911
912 public String getPathModule();
913
914 public String getPathProxy();
915
916 public long getPlidFromFriendlyURL(long companyId, String friendlyURL);
917
918 public long getPlidFromPortletId(
919 long groupId, boolean privateLayout, String portletId)
920 throws PortalException;
921
922 public long getPlidFromPortletId(long groupId, String portletId)
923 throws PortalException;
924
925 public PortalInetSocketAddressEventListener[]
926 getPortalInetSocketAddressEventListeners();
927
928 public String getPortalLibDir();
929
930 public InetAddress getPortalLocalInetAddress(boolean secure);
931
932 public int getPortalLocalPort(boolean secure);
933
934
938 @Deprecated
939 public int getPortalPort();
940
941
945 @Deprecated
946 public int getPortalPort(boolean secure);
947
948 public Properties getPortalProperties();
949
950 public InetAddress getPortalServerInetAddress(boolean secure);
951
952 public int getPortalServerPort(boolean secure);
953
954 public String getPortalURL(HttpServletRequest request);
955
956 public String getPortalURL(HttpServletRequest request, boolean secure);
957
958 public String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
959 throws PortalException;
960
961 public String getPortalURL(PortletRequest portletRequest);
962
963 public String getPortalURL(PortletRequest portletRequest, boolean secure);
964
965 public String getPortalURL(
966 String serverName, int serverPort, boolean secure);
967
968 public String getPortalURL(ThemeDisplay themeDisplay)
969 throws PortalException;
970
971 public String getPortalWebDir();
972
973
977 @Deprecated
978 public Set<String> getPortletAddDefaultResourceCheckWhitelist();
979
980
984 @Deprecated
985 public Set<String> getPortletAddDefaultResourceCheckWhitelistActions();
986
987
991 @Deprecated
992 public List<BreadcrumbEntry> getPortletBreadcrumbList(
993 HttpServletRequest request);
994
995
1000 @Deprecated
1001 public List<BreadcrumbEntry> getPortletBreadcrumbs(
1002 HttpServletRequest request);
1003
1004 public PortletConfig getPortletConfig(
1005 long companyId, String portletId, ServletContext servletContext)
1006 throws PortletException;
1007
1008 public String getPortletDescription(
1009 Portlet portlet, ServletContext servletContext, Locale locale);
1010
1011 public String getPortletDescription(Portlet portlet, User user);
1012
1013 public String getPortletDescription(String portletId, Locale locale);
1014
1015 public String getPortletDescription(String portletId, String languageId);
1016
1017 public String getPortletDescription(String portletId, User user);
1018
1019 public String getPortletId(HttpServletRequest request);
1020
1021 public String getPortletId(PortletRequest portletRequest);
1022
1023 public String getPortletLongTitle(Portlet portlet, Locale locale);
1024
1025 public String getPortletLongTitle(
1026 Portlet portlet, ServletContext servletContext, Locale locale);
1027
1028 public String getPortletLongTitle(Portlet portlet, String languageId);
1029
1030 public String getPortletLongTitle(Portlet portlet, User user);
1031
1032 public String getPortletLongTitle(String portletId, Locale locale);
1033
1034 public String getPortletLongTitle(String portletId, String languageId);
1035
1036 public String getPortletLongTitle(String portletId, User user);
1037
1038 public String getPortletNamespace(String portletId);
1039
1040 public String getPortletTitle(Portlet portlet, Locale locale);
1041
1042 public String getPortletTitle(
1043 Portlet portlet, ServletContext servletContext, Locale locale);
1044
1045 public String getPortletTitle(Portlet portlet, String languageId);
1046
1047 public String getPortletTitle(Portlet portlet, User user);
1048
1049 public String getPortletTitle(PortletRequest portletRequest);
1050
1051 public String getPortletTitle(PortletResponse portletResponse);
1052
1053 public String getPortletTitle(String portletId, Locale locale);
1054
1055 public String getPortletTitle(
1056 String portletId, ResourceBundle resourceBundle);
1057
1058 public String getPortletTitle(String portletId, String languageId);
1059
1060 public String getPortletTitle(String portletId, User user);
1061
1062 public String getPortletXmlFileName();
1063
1064 public PortletPreferences getPreferences(HttpServletRequest request);
1065
1066 public PreferencesValidator getPreferencesValidator(Portlet portlet);
1067
1068 public String getRelativeHomeURL(HttpServletRequest request)
1069 throws PortalException;
1070
1071 public ResourceBundle getResourceBundle(Locale locale);
1072
1073 public long getScopeGroupId(HttpServletRequest request)
1074 throws PortalException;
1075
1076 public long getScopeGroupId(HttpServletRequest request, String portletId)
1077 throws PortalException;
1078
1079 public long getScopeGroupId(
1080 HttpServletRequest request, String portletId,
1081 boolean checkStagingGroup)
1082 throws PortalException;
1083
1084 public long getScopeGroupId(Layout layout);
1085
1086 public long getScopeGroupId(Layout layout, String portletId);
1087
1088 public long getScopeGroupId(long plid);
1089
1090 public long getScopeGroupId(PortletRequest portletRequest)
1091 throws PortalException;
1092
1093 public User getSelectedUser(HttpServletRequest request)
1094 throws PortalException;
1095
1096 public User getSelectedUser(
1097 HttpServletRequest request, boolean checkPermission)
1098 throws PortalException;
1099
1100 public User getSelectedUser(PortletRequest portletRequest)
1101 throws PortalException;
1102
1103 public User getSelectedUser(
1104 PortletRequest portletRequest, boolean checkPermission)
1105 throws PortalException;
1106
1107 public String getServletContextName();
1108
1109 public long[] getSharedContentSiteGroupIds(
1110 long companyId, long groupId, long userId)
1111 throws PortalException;
1112
1113 public Map<String, List<Portlet>> getSiteAdministrationCategoriesMap(
1114 HttpServletRequest request);
1115
1116 public PortletURL getSiteAdministrationURL(
1117 HttpServletRequest request, ThemeDisplay themeDisplay);
1118
1119 public PortletURL getSiteAdministrationURL(
1120 HttpServletRequest request, ThemeDisplay themeDisplay,
1121 String portletName);
1122
1123 public PortletURL getSiteAdministrationURL(
1124 PortletResponse portletResponse, ThemeDisplay themeDisplay);
1125
1126 public PortletURL getSiteAdministrationURL(
1127 PortletResponse portletResponse, ThemeDisplay themeDisplay,
1128 String portletName);
1129
1130
1134 @Deprecated
1135 public long[] getSiteAndCompanyGroupIds(long groupId)
1136 throws PortalException;
1137
1138
1142 @Deprecated
1143 public long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
1144 throws PortalException;
1145
1146 public Locale getSiteDefaultLocale(long groupId) throws PortalException;
1147
1148 public long getSiteGroupId(long groupId);
1149
1150
1159 public String getSiteLoginURL(ThemeDisplay themeDisplay)
1160 throws PortalException;
1161
1162 public String getStaticResourceURL(HttpServletRequest request, String uri);
1163
1164 public String getStaticResourceURL(
1165 HttpServletRequest request, String uri, long timestamp);
1166
1167 public String getStaticResourceURL(
1168 HttpServletRequest request, String uri, String queryString);
1169
1170 public String getStaticResourceURL(
1171 HttpServletRequest request, String uri, String queryString,
1172 long timestamp);
1173
1174 public String getStrutsAction(HttpServletRequest request);
1175
1176 public String[] getSystemGroups();
1177
1178 public String[] getSystemOrganizationRoles();
1179
1180 public String[] getSystemRoles();
1181
1182 public String[] getSystemSiteRoles();
1183
1184 public String getUniqueElementId(
1185 HttpServletRequest request, String namespace, String id);
1186
1187 public String getUniqueElementId(
1188 PortletRequest request, String namespace, String id);
1189
1190 public UploadPortletRequest getUploadPortletRequest(
1191 PortletRequest portletRequest);
1192
1193 public UploadServletRequest getUploadServletRequest(
1194 HttpServletRequest request);
1195
1196 public Date getUptime();
1197
1198 public String getURLWithSessionId(String url, String sessionId);
1199
1200 public User getUser(HttpServletRequest request) throws PortalException;
1201
1202 public User getUser(PortletRequest portletRequest) throws PortalException;
1203
1204 public String getUserEmailAddress(long userId);
1205
1206 public long getUserId(HttpServletRequest request);
1207
1208 public long getUserId(PortletRequest portletRequest);
1209
1210 public String getUserName(BaseModel<?> baseModel);
1211
1212 public String getUserName(long userId, String defaultUserName);
1213
1214 public String getUserName(
1215 long userId, String defaultUserName, HttpServletRequest request);
1216
1217 public String getUserName(
1218 long userId, String defaultUserName, String userAttribute);
1219
1220 public String getUserName(
1221 long userId, String defaultUserName, String userAttribute,
1222 HttpServletRequest request);
1223
1224 public String getUserPassword(HttpServletRequest request);
1225
1226 public String getUserPassword(HttpSession session);
1227
1228 public String getUserPassword(PortletRequest portletRequest);
1229
1230
1233 @Deprecated
1234 public String getUserValue(long userId, String param, String defaultValue);
1235
1236 public String getValidPortalDomain(long companyId, String domain);
1237
1238 public long getValidUserId(long companyId, long userId)
1239 throws PortalException;
1240
1241 public String getVirtualHostname(LayoutSet layoutSet);
1242
1243
1246 @Deprecated
1247 public String getVirtualLayoutActualURL(
1248 long groupId, boolean privateLayout, String mainPath,
1249 String friendlyURL, Map<String, String[]> params,
1250 Map<String, Object> requestContext)
1251 throws PortalException;
1252
1253
1256 @Deprecated
1257 public LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(
1258 boolean privateLayout, String friendlyURL,
1259 Map<String, String[]> params, Map<String, Object> requestContext)
1260 throws PortalException;
1261
1262 public String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
1263 throws PortalException;
1264
1265 public void initCustomSQL();
1266
1267 public User initUser(HttpServletRequest request) throws Exception;
1268
1269 public void invokeTaglibDiscussion(
1270 PortletConfig portletConfig, ActionRequest actionRequest,
1271 ActionResponse actionResponse)
1272 throws Exception;
1273
1274 public void invokeTaglibDiscussionPagination(
1275 PortletConfig portletConfig, ResourceRequest resourceRequest,
1276 ResourceResponse resourceResponse)
1277 throws IOException, PortletException;
1278
1279
1282 @Deprecated
1283 public boolean isAllowAddPortletDefaultResource(
1284 HttpServletRequest request, Portlet portlet)
1285 throws PortalException;
1286
1287 public boolean isCDNDynamicResourcesEnabled(HttpServletRequest request)
1288 throws PortalException;
1289
1290 public boolean isCDNDynamicResourcesEnabled(long companyId);
1291
1292
1295 @Deprecated
1296 public boolean isCommunityAdmin(User user, long groupId) throws Exception;
1297
1298
1301 @Deprecated
1302 public boolean isCommunityOwner(User user, long groupId) throws Exception;
1303
1304 public boolean isCompanyAdmin(User user) throws Exception;
1305
1306 public boolean isCompanyControlPanelPortlet(
1307 String portletId, String category, ThemeDisplay themeDisplay)
1308 throws PortalException;
1309
1310 public boolean isCompanyControlPanelPortlet(
1311 String portletId, ThemeDisplay themeDisplay)
1312 throws PortalException;
1313
1314 public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
1315 throws PortalException;
1316
1317 public boolean isControlPanelPortlet(
1318 String portletId, String category, ThemeDisplay themeDisplay);
1319
1320 public boolean isControlPanelPortlet(
1321 String portletId, ThemeDisplay themeDisplay);
1322
1323 public boolean isGroupAdmin(User user, long groupId) throws Exception;
1324
1325 public boolean isGroupFriendlyURL(
1326 String fullURL, String groupFriendlyURL, String layoutFriendlyURL);
1327
1328 public boolean isGroupOwner(User user, long groupId) throws Exception;
1329
1330 public boolean isLayoutDescendant(Layout layout, long layoutId)
1331 throws PortalException;
1332
1333 public boolean isLayoutSitemapable(Layout layout);
1334
1335 public boolean isLoginRedirectRequired(HttpServletRequest request);
1336
1337 public boolean isMethodGet(PortletRequest portletRequest);
1338
1339 public boolean isMethodPost(PortletRequest portletRequest);
1340
1341 public boolean isMultipartRequest(HttpServletRequest request);
1342
1343 public boolean isOmniadmin(long userId);
1344
1345 public boolean isOmniadmin(User user);
1346
1347 public boolean isReservedParameter(String name);
1348
1349 public boolean isRightToLeft(HttpServletRequest request);
1350
1351 public boolean isRSSFeedsEnabled();
1352
1353 public boolean isSecure(HttpServletRequest request);
1354
1355 public boolean isSystemGroup(String groupName);
1356
1357 public boolean isSystemRole(String roleName);
1358
1359 public boolean isUpdateAvailable();
1360
1361 public boolean isValidResourceId(String resourceId);
1362
1363 public boolean removePortalInetSocketAddressEventListener(
1364 PortalInetSocketAddressEventListener
1365 portalInetSocketAddressEventListener);
1366
1367
1372 @Deprecated
1373 public void removePortalPortEventListener(
1374 PortalPortEventListener portalPortEventListener);
1375
1376 public void resetCDNHosts();
1377
1378
1382 @Deprecated
1383 public Set<String> resetPortletAddDefaultResourceCheckWhitelist();
1384
1385
1389 @Deprecated
1390 public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions();
1391
1392 public String resetPortletParameters(String url, String portletId);
1393
1394 public void sendError(
1395 Exception e, ActionRequest actionRequest,
1396 ActionResponse actionResponse)
1397 throws IOException;
1398
1399 public void sendError(
1400 Exception e, HttpServletRequest request,
1401 HttpServletResponse response)
1402 throws IOException, ServletException;
1403
1404 public void sendError(
1405 int status, Exception e, ActionRequest actionRequest,
1406 ActionResponse actionResponse)
1407 throws IOException;
1408
1409 public void sendError(
1410 int status, Exception e, HttpServletRequest request,
1411 HttpServletResponse response)
1412 throws IOException, ServletException;
1413
1414 public void sendRSSFeedsDisabledError(
1415 HttpServletRequest request, HttpServletResponse response)
1416 throws IOException, ServletException;
1417
1418 public void sendRSSFeedsDisabledError(
1419 PortletRequest portletRequest, PortletResponse portletResponse)
1420 throws IOException, ServletException;
1421
1422
1426 public void setPageDescription(
1427 String description, HttpServletRequest request);
1428
1429
1432 public void setPageKeywords(String keywords, HttpServletRequest request);
1433
1434
1437 public void setPageSubtitle(String subtitle, HttpServletRequest request);
1438
1439
1443 public void setPageTitle(String title, HttpServletRequest request);
1444
1445 public void setPortalInetSocketAddresses(HttpServletRequest request);
1446
1447
1453 @Deprecated
1454 public void setPortalPort(HttpServletRequest request);
1455
1456 public void storePreferences(PortletPreferences portletPreferences)
1457 throws IOException, ValidatorException;
1458
1459 public String[] stripURLAnchor(String url, String separator);
1460
1461 public String transformCustomSQL(String sql);
1462
1463 public String transformSQL(String sql);
1464
1465 public void updateImageId(
1466 BaseModel<?> baseModel, boolean image, byte[] bytes,
1467 String fieldName, long maxSize, int maxHeight, int maxWidth)
1468 throws PortalException;
1469
1470 public PortletMode updatePortletMode(
1471 String portletId, User user, Layout layout, PortletMode portletMode,
1472 HttpServletRequest request)
1473 throws PortalException;
1474
1475 public String updateRedirect(
1476 String redirect, String oldPath, String newPath);
1477
1478 public WindowState updateWindowState(
1479 String portletId, User user, Layout layout, WindowState windowState,
1480 HttpServletRequest request);
1481
1482 }