PortalUtil

java.lang.Object
- com.liferay.portal.util.PortalUtil

```
public class PortalUtil
extends java.lang.Object
```
Author:

Brian Wing Shun Chan, Eduardo Lundgren, Juan Fernández

Constructor Summary

Constructors
Constructor and Description

PortalUtil()

Constructors
Constructor and Description
`PortalUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest request)` Adds the description for a page.
`static void`	`addPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest request)` Adds the keywords for a page.
`static void`	`addPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request)` Adds the subtitle for a page.
`static void`	`addPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request)` Adds the whole title for a page.
`static void`	`addPortalPortEventListener(PortalPortEventListener portalPortEventListener)`
`static void`	`addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)`
`static void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url)`
`static void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> data)`
`static void`	`addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)`
`static void`	`addPortletDefaultResource(long companyId, Layout layout, Portlet portlet)`
`static java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, Layout layout, java.lang.String url, boolean doAsUser)` Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.
`static java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url)` Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.
`static void`	`addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)`
`static void`	`clearRequestParameters(javax.portlet.RenderRequest renderRequest)`
`static void`	`copyRequestParameters(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`static java.lang.String`	`escapeRedirect(java.lang.String url)`
`static java.lang.String`	`generateRandomKey(javax.servlet.http.HttpServletRequest request, java.lang.String input)`
`static java.lang.String`	`getAbsoluteURL(javax.servlet.http.HttpServletRequest request, java.lang.String url)`
`static LayoutQueryStringComposite`	`getActualLayoutQueryStringComposite(long groupId, boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static java.lang.String`	`getActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static java.util.Locale[]`	`getAlternateLocales(javax.servlet.http.HttpServletRequest request)` Deprecated. As of 6.2.0, replaced by `LanguageUtil.getAvailableLocales()`
`static java.lang.String`	`getAlternateURL(java.lang.String canonicalURL, ThemeDisplay themeDisplay, java.util.Locale locale, Layout layout)`
`static java.util.Set<java.lang.String>`	`getAuthTokenIgnoreActions()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions()`
`static java.util.Set<java.lang.String>`	`getAuthTokenIgnorePortlets()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletCSRFWhitelist()`
`static BaseModel<?>`	`getBaseModel(ResourcePermission resourcePermission)`
`static BaseModel<?>`	`getBaseModel(java.lang.String modelName, java.lang.String primKey)`
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)`
`static java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout)`
`static java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL)`
`static java.lang.String`	`getCDNHost()` Deprecated. As of 6.1.0, replaced by `getCDNHost(boolean)`
`static java.lang.String`	`getCDNHost(boolean secure)`
`static java.lang.String`	`getCDNHost(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getCDNHostHttp(long companyId)`
`static java.lang.String`	`getCDNHostHttps(long companyId)`
`static java.lang.String`	`getClassName(long classNameId)`
`static long`	`getClassNameId(java.lang.Class<?> clazz)`
`static long`	`getClassNameId(java.lang.String value)`
`static java.lang.String`	`getClassNamePortletId(java.lang.String className)`
`static Company`	`getCompany(javax.servlet.http.HttpServletRequest request)`
`static Company`	`getCompany(javax.portlet.PortletRequest portletRequest)`
`static long`	`getCompanyId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getCompanyId(javax.portlet.PortletRequest portletRequest)`
`static long[]`	`getCompanyIds()`
`static java.lang.String`	`getComputerAddress()`
`static java.lang.String`	`getComputerName()`
`static java.util.Map<java.lang.String,java.util.List<Portlet>>`	`getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getControlPanelCategory(java.lang.String portletId, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getControlPanelFullURL(long scopeGroupId, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`static long`	`getControlPanelPlid(long companyId)`
`static long`	`getControlPanelPlid(javax.portlet.PortletRequest portletRequest)`
`static java.util.Set<Portlet>`	`getControlPanelPortlets(long companyId, java.lang.String category)`
`static java.util.List<Portlet>`	`getControlPanelPortlets(java.lang.String category, ThemeDisplay themeDisplay)`
`static javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, long referrerPlid, java.lang.String lifecycle)`
`static javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, java.lang.String portletId, long referrerPlid, java.lang.String lifecycle)`
`static java.lang.String`	`getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getCurrentURL(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getCurrentURL(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getCustomSQLFunctionIsNotNull()`
`static java.lang.String`	`getCustomSQLFunctionIsNull()`
`static java.util.Date`	`getDate(int month, int day, int year)`
`static java.util.Date`	`getDate(int month, int day, int year, java.lang.Class<? extends PortalException> clazz)`
`static java.util.Date`	`getDate(int month, int day, int year, int hour, int min, java.lang.Class<? extends PortalException> clazz)`
`static java.util.Date`	`getDate(int month, int day, int year, int hour, int min, java.util.TimeZone timeZone, java.lang.Class<? extends PortalException> clazz)`
`static java.util.Date`	`getDate(int month, int day, int year, java.util.TimeZone timeZone, java.lang.Class<? extends PortalException> clazz)`
`static DB`	`getDB()` Deprecated. As of 6.1.0, replaced by `DBFactoryUtil.getDB()`
`static long`	`getDefaultCompanyId()`
`static long`	`getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getDisplayURL(Group group, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getDisplayURL(Group group, ThemeDisplay themeDisplay, boolean privateLayout)`
`static java.lang.String`	`getEmailFromAddress(javax.portlet.PortletPreferences preferences, long companyId, java.lang.String defaultValue)`
`static java.lang.String`	`getEmailFromName(javax.portlet.PortletPreferences preferences, long companyId, java.lang.String defaultValue)`
`static java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.servlet.http.HttpServletRequest request)`
`static java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.portlet.PortletRequest portletRequest)`
`static java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, UploadPortletRequest uploadPortletRequest)`
`static java.io.Serializable`	`getExpandoValue(javax.servlet.http.HttpServletRequest request, java.lang.String name, int type, java.lang.String displayType)`
`static java.io.Serializable`	`getExpandoValue(javax.portlet.PortletRequest portletRequest, java.lang.String name, int type, java.lang.String displayType)`
`static java.io.Serializable`	`getExpandoValue(UploadPortletRequest uploadPortletRequest, java.lang.String name, int type, java.lang.String displayType)`
`static java.lang.String`	`getFacebookURL(Portlet portlet, java.lang.String facebookCanvasPageURL, ThemeDisplay themeDisplay)`
`static Portlet`	`getFirstMyAccountPortlet(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)`
`static Portlet`	`getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getFullName(java.lang.String firstName, java.lang.String middleName, java.lang.String lastName)`
`static java.lang.String`	`getGlobalLibDir()`
`static java.lang.String`	`getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay, java.util.Locale locale)`
`static int[]`	`getGroupFriendlyURLIndex(java.lang.String requestURI)`
`static java.lang.String[]`	`getGroupPermissions(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String[]`	`getGroupPermissions(javax.servlet.http.HttpServletRequest request, java.lang.String className)`
`static java.lang.String[]`	`getGroupPermissions(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String[]`	`getGroupPermissions(javax.portlet.PortletRequest portletRequest, java.lang.String className)`
`static java.lang.String[]`	`getGuestPermissions(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String[]`	`getGuestPermissions(javax.servlet.http.HttpServletRequest request, java.lang.String className)`
`static java.lang.String[]`	`getGuestPermissions(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String[]`	`getGuestPermissions(javax.portlet.PortletRequest portletRequest, java.lang.String className)`
`static java.lang.String`	`getHomeURL(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getHost(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getHost(javax.portlet.PortletRequest portletRequest)`
`static javax.servlet.http.HttpServletRequest`	`getHttpServletRequest(javax.portlet.PortletRequest portletRequest)`
`static javax.servlet.http.HttpServletResponse`	`getHttpServletResponse(javax.portlet.PortletResponse portletResponse)`
`static java.lang.String`	`getI18nPathLanguageId(java.util.Locale locale, java.lang.String defaultI18nPathLanguageId)`
`static java.lang.String`	`getJournalArticleActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static Layout`	`getJournalArticleLayout(long groupId, boolean privateLayout, java.lang.String friendlyURL)`
`static java.lang.String`	`getJsSafePortletId(java.lang.String portletId)`
`static java.lang.String`	`getLayoutActualURL(Layout layout)`
`static java.lang.String`	`getLayoutActualURL(Layout layout, java.lang.String mainPath)`
`static java.lang.String`	`getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL)`
`static java.lang.String`	`getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static java.lang.String`	`getLayoutEditPage(Layout layout)`
`static java.lang.String`	`getLayoutEditPage(java.lang.String type)`
`static java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`static LayoutFriendlyURLComposite`	`getLayoutFriendlyURLComposite(long groupId, boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`static java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId)`
`static java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId, boolean secure)`
`static java.lang.String`	`getLayoutFullURL(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutTarget(Layout layout)`
`static java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`static java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`static java.lang.String`	`getLayoutURL(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutViewPage(Layout layout)`
`static java.lang.String`	`getLayoutViewPage(java.lang.String type)`
`static LiferayPortletRequest`	`getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)`
`static LiferayPortletResponse`	`getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)`
`static java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest request)`
`static java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean initialize)`
`static java.util.Locale`	`getLocale(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request, Layout layout, java.util.Locale locale, java.util.Locale originalLocale)`
`static java.lang.String`	`getMailId(java.lang.String mx, java.lang.String popPortletPrefix, java.lang.Object... ids)`
`static BaseModel<?>`	`getModel(ResourcePermission resourcePermission)` Deprecated. As of 6.1.0, replaced by `getBaseModel(ResourcePermission)`
`static BaseModel<?>`	`getModel(java.lang.String modelName, java.lang.String primKey)` Deprecated. As of 6.1.0, replaced by `getBaseModel(String, String)`
`static java.lang.String`	`getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getNewPortletTitle(java.lang.String portletTitle, java.lang.String oldScopeName, java.lang.String newScopeName)`
`static javax.servlet.http.HttpServletRequest`	`getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)`
`static long`	`getParentGroupId(long scopeGroupId)` Deprecated. As of 6.2.0 renamed to `getSiteGroupId(long)`
`static java.lang.String`	`getPathContext()`
`static java.lang.String`	`getPathContext(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getPathContext(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getPathContext(java.lang.String contextPath)`
`static java.lang.String`	`getPathFriendlyURLPrivateGroup()`
`static java.lang.String`	`getPathFriendlyURLPrivateUser()`
`static java.lang.String`	`getPathFriendlyURLPublic()`
`static java.lang.String`	`getPathImage()`
`static java.lang.String`	`getPathMain()`
`static java.lang.String`	`getPathModule()`
`static java.lang.String`	`getPathProxy()`
`static long`	`getPlidFromFriendlyURL(long companyId, java.lang.String friendlyURL)`
`static long`	`getPlidFromPortletId(long groupId, boolean privateLayout, java.lang.String portletId)`
`static long`	`getPlidFromPortletId(long groupId, java.lang.String portletId)`
`static Portal`	`getPortal()`
`static java.lang.String`	`getPortalLibDir()`
`static int`	`getPortalPort()` Deprecated. As of 6.1.0, replaced by `getPortalPort(boolean)`
`static int`	`getPortalPort(boolean secure)`
`static java.util.Properties`	`getPortalProperties()`
`static java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)`
`static java.lang.String`	`getPortalURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest, boolean secure)`
`static java.lang.String`	`getPortalURL(java.lang.String serverName, int serverPort, boolean secure)`
`static java.lang.String`	`getPortalURL(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getPortalWebDir()`
`static java.util.Set<java.lang.String>`	`getPortletAddDefaultResourceCheckWhitelist()` Deprecated. As of 6.2.0 replaced by `AuthTokenWhitelistUtil.getPortletInvocationWhitelist()`
`static java.util.Set<java.lang.String>`	`getPortletAddDefaultResourceCheckWhitelistActions()` Deprecated. As of 6.2.0 replaced by `AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions()`
`static java.util.List<BreadcrumbEntry>`	`getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)` Deprecated. As of 6.1.0, replaced by `getPortletBreadcrumbs(HttpServletRequest)`
`static java.util.List<BreadcrumbEntry>`	`getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)`
`static javax.portlet.PortletConfig`	`getPortletConfig(long companyId, java.lang.String portletId, javax.servlet.ServletContext servletContext)`
`static java.lang.String`	`getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`static java.lang.String`	`getPortletDescription(Portlet portlet, User user)`
`static java.lang.String`	`getPortletDescription(java.lang.String portletId, java.util.Locale locale)`
`static java.lang.String`	`getPortletDescription(java.lang.String portletId, java.lang.String languageId)`
`static java.lang.String`	`getPortletDescription(java.lang.String portletId, User user)`
`static java.lang.String`	`getPortletId(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getPortletId(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getPortletLongTitle(Portlet portlet, java.util.Locale locale)`
`static java.lang.String`	`getPortletLongTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`static java.lang.String`	`getPortletLongTitle(Portlet portlet, java.lang.String languageId)`
`static java.lang.String`	`getPortletLongTitle(Portlet portlet, User user)`
`static java.lang.String`	`getPortletLongTitle(java.lang.String portletId, java.util.Locale locale)`
`static java.lang.String`	`getPortletLongTitle(java.lang.String portletId, java.lang.String languageId)`
`static java.lang.String`	`getPortletLongTitle(java.lang.String portletId, User user)`
`static java.lang.String`	`getPortletNamespace(java.lang.String portletId)`
`static java.lang.String`	`getPortletTitle(Portlet portlet, java.util.Locale locale)`
`static java.lang.String`	`getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`static java.lang.String`	`getPortletTitle(Portlet portlet, java.lang.String languageId)`
`static java.lang.String`	`getPortletTitle(Portlet portlet, User user)`
`static java.lang.String`	`getPortletTitle(javax.portlet.RenderRequest renderRequest)`
`static java.lang.String`	`getPortletTitle(javax.portlet.RenderResponse renderResponse)`
`static java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.Locale locale)`
`static java.lang.String`	`getPortletTitle(java.lang.String portletId, java.lang.String languageId)`
`static java.lang.String`	`getPortletTitle(java.lang.String portletId, User user)`
`static java.lang.String`	`getPortletXmlFileName()`
`static javax.portlet.PortletPreferences`	`getPreferences(javax.servlet.http.HttpServletRequest request)`
`static javax.portlet.PreferencesValidator`	`getPreferencesValidator(Portlet portlet)`
`static java.lang.String`	`getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)`
`static long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)`
`static long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, boolean checkStagingGroup)`
`static long`	`getScopeGroupId(Layout layout)`
`static long`	`getScopeGroupId(Layout layout, java.lang.String portletId)`
`static long`	`getScopeGroupId(long plid)`
`static long`	`getScopeGroupId(javax.portlet.PortletRequest portletRequest)`
`static User`	`getSelectedUser(javax.servlet.http.HttpServletRequest request)`
`static User`	`getSelectedUser(javax.servlet.http.HttpServletRequest request, boolean checkPermission)`
`static User`	`getSelectedUser(javax.portlet.PortletRequest portletRequest)`
`static User`	`getSelectedUser(javax.portlet.PortletRequest portletRequest, boolean checkPermission)`
`static java.lang.String`	`getServletContextName()`
`static long[]`	`getSharedContentSiteGroupIds(long companyId, long groupId, long userId)`
`static java.util.Map<java.lang.String,java.util.List<Portlet>>`	`getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request)`
`static javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`static javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, java.lang.String portletName)`
`static javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay)`
`static javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay, java.lang.String portletName)`
`static long[]`	`getSiteAndCompanyGroupIds(long groupId)`
`static long[]`	`getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)`
`static java.util.Locale`	`getSiteDefaultLocale(long groupId)`
`static long`	`getSiteGroupId(long scopeGroupId)`
`static java.lang.String`	`getSiteLoginURL(ThemeDisplay themeDisplay)`
`static java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri)`
`static java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, long timestamp)`
`static java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString)`
`static java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString, long timestamp)`
`static java.lang.String`	`getStrutsAction(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String[]`	`getSystemGroups()`
`static java.lang.String[]`	`getSystemOrganizationRoles()`
`static java.lang.String[]`	`getSystemRoles()`
`static java.lang.String[]`	`getSystemSiteRoles()`
`static java.lang.String`	`getUniqueElementId(javax.servlet.http.HttpServletRequest request, java.lang.String namespace, java.lang.String id)`
`static java.lang.String`	`getUniqueElementId(javax.portlet.PortletRequest request, java.lang.String namespace, java.lang.String id)`
`static UploadPortletRequest`	`getUploadPortletRequest(javax.portlet.PortletRequest portletRequest)`
`static UploadServletRequest`	`getUploadServletRequest(javax.servlet.http.HttpServletRequest request)`
`static java.util.Date`	`getUptime()`
`static java.lang.String`	`getURLWithSessionId(java.lang.String url, java.lang.String sessionId)`
`static User`	`getUser(javax.servlet.http.HttpServletRequest request)`
`static User`	`getUser(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getUserEmailAddress(long userId)`
`static long`	`getUserId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getUserId(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getUserName(BaseModel<?> baseModel)`
`static java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName)`
`static java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute)`
`static java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute, javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getUserPassword(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getUserPassword(javax.servlet.http.HttpSession session)`
`static java.lang.String`	`getUserPassword(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getUserValue(long userId, java.lang.String param, java.lang.String defaultValue)`
`static java.lang.String`	`getValidPortalDomain(long companyId, java.lang.String domain)`
`static long`	`getValidUserId(long companyId, long userId)`
`static java.lang.String`	`getVirtualLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static LayoutFriendlyURLComposite`	`getVirtualLayoutFriendlyURLComposite(boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`static java.lang.String`	`getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static void`	`initCustomSQL()`
`static User`	`initUser(javax.servlet.http.HttpServletRequest request)`
`static void`	`invokeTaglibDiscussion(javax.portlet.PortletConfig portletConfig, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`static boolean`	`isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)` Deprecated. As of 6.2.0 with no direct replacement
`static boolean`	`isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isCDNDynamicResourcesEnabled(long companyId)`
`static boolean`	`isCommunityAdmin(User user, long groupId)` Deprecated. As of 6.1.0, renamed to `isGroupAdmin(User, long)`
`static boolean`	`isCommunityOwner(User user, long groupId)` Deprecated. As of 6.1.0, renamed to `isGroupOwner(User, long)`
`static boolean`	`isCompanyAdmin(User user)`
`static boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`static boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`static boolean`	`isCompanyControlPanelVisible(ThemeDisplay themeDisplay)`
`static boolean`	`isControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`static boolean`	`isControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`static boolean`	`isGroupAdmin(User user, long groupId)`
`static boolean`	`isGroupFriendlyURL(java.lang.String fullURL, java.lang.String groupFriendlyURL, java.lang.String layoutFriendlyURL)`
`static boolean`	`isGroupOwner(User user, long groupId)`
`static boolean`	`isLayoutDescendant(Layout layout, long layoutId)`
`static boolean`	`isLayoutFirstPageable(Layout layout)`
`static boolean`	`isLayoutFirstPageable(java.lang.String type)`
`static boolean`	`isLayoutFriendliable(Layout layout)`
`static boolean`	`isLayoutFriendliable(java.lang.String type)`
`static boolean`	`isLayoutParentable(Layout layout)`
`static boolean`	`isLayoutParentable(java.lang.String type)`
`static boolean`	`isLayoutSitemapable(Layout layout)`
`static boolean`	`isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isMethodGet(javax.portlet.PortletRequest portletRequest)`
`static boolean`	`isMethodPost(javax.portlet.PortletRequest portletRequest)`
`static boolean`	`isMultipartRequest(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isOmniadmin(long userId)`
`static boolean`	`isReservedParameter(java.lang.String name)`
`static boolean`	`isRSSFeedsEnabled()`
`static boolean`	`isSecure(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isSystemGroup(java.lang.String groupName)`
`static boolean`	`isSystemRole(java.lang.String roleName)`
`static boolean`	`isUpdateAvailable()`
`static boolean`	`isValidResourceId(java.lang.String resourceId)`
`void`	`removePortalPortEventListener(PortalPortEventListener portalPortEventListener)`
`static void`	`resetCDNHosts()`
`static java.util.Set<java.lang.String>`	`resetPortletAddDefaultResourceCheckWhitelist()` Deprecated. As of 6.2.0 replaced by `AuthTokenWhitelistUtil.resetPortletInvocationWhitelist()`
`static java.util.Set<java.lang.String>`	`resetPortletAddDefaultResourceCheckWhitelistActions()` Deprecated. As of 6.2.0 replaced by `AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions()`
`static java.lang.String`	`resetPortletParameters(java.lang.String url, java.lang.String portletId)`
`static void`	`runSQL(java.lang.String sql)` Deprecated. As of 6.1.0, replaced by `DB.runSQL(String)`
`static void`	`sendError(java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`static void`	`sendError(java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`sendError(int status, java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`static void`	`sendError(int status, java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`sendRSSFeedsDisabledError(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)`
`static void`	`setPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest request)` Sets the description for a page.
`static void`	`setPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest request)` Sets the keywords for a page.
`static void`	`setPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request)` Sets the subtitle for a page.
`static void`	`setPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request)` Sets the whole title for a page.
`void`	`setPortal(Portal portal)`
`static void`	`setPortalPort(javax.servlet.http.HttpServletRequest request)` Sets the port obtained on the first request to the portal.
`static void`	`storePreferences(javax.portlet.PortletPreferences portletPreferences)`
`static java.lang.String[]`	`stripURLAnchor(java.lang.String url, java.lang.String separator)`
`static java.lang.String`	`transformCustomSQL(java.lang.String sql)`
`static java.lang.String`	`transformSQL(java.lang.String sql)`
`static javax.portlet.PortletMode`	`updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`updateRedirect(java.lang.String redirect, java.lang.String oldPath, java.lang.String newPath)`
`static javax.portlet.WindowState`	`updateWindowState(java.lang.String portletId, User user, Layout layout, javax.portlet.WindowState windowState, javax.servlet.http.HttpServletRequest request)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PortalUtil
```
public PortalUtil()
```

Method Detail

addPageDescription

public static void addPageDescription(java.lang.String description,
                      javax.servlet.http.HttpServletRequest request)

Adds the description for a page. This appends to the existing page description.

addPageKeywords

public static void addPageKeywords(java.lang.String keywords,
                   javax.servlet.http.HttpServletRequest request)

Adds the keywords for a page. This appends to the existing page keywords.

addPageSubtitle

public static void addPageSubtitle(java.lang.String subtitle,
                   javax.servlet.http.HttpServletRequest request)

Adds the subtitle for a page. This appends to the existing page subtitle.

addPageTitle

public static void addPageTitle(java.lang.String title,
                javax.servlet.http.HttpServletRequest request)

Adds the whole title for a page. This appends to the existing page whole title.

addPortalPortEventListener

public static void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)

addPortalPortProtocolEventListener

public static void addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)

addPortletBreadcrumbEntry

public static void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                             java.lang.String title,
                             java.lang.String url)

addPortletBreadcrumbEntry

public static void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                             java.lang.String title,
                             java.lang.String url,
                             java.util.Map<java.lang.String,java.lang.Object> data)

addPortletDefaultResource

public static void addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
                             Portlet portlet)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

addPortletDefaultResource

public static void addPortletDefaultResource(long companyId,
                             Layout layout,
                             Portlet portlet)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

addPreservedParameters

public static java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                      Layout layout,
                                      java.lang.String url,
                                      boolean doAsUser)

Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal. If doAsUser is false, then doAsUserId and doAsUserLanguageId will never be added.

addPreservedParameters
```
public static java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                      java.lang.String url)
```
Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.

addUserLocaleOptionsMessage

public static void addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)

clearRequestParameters

public static void clearRequestParameters(javax.portlet.RenderRequest renderRequest)

copyRequestParameters

public static void copyRequestParameters(javax.portlet.ActionRequest actionRequest,
                         javax.portlet.ActionResponse actionResponse)

escapeRedirect

public static java.lang.String escapeRedirect(java.lang.String url)

generateRandomKey

public static java.lang.String generateRandomKey(javax.servlet.http.HttpServletRequest request,
                                 java.lang.String input)

getAbsoluteURL

public static java.lang.String getAbsoluteURL(javax.servlet.http.HttpServletRequest request,
                              java.lang.String url)

getActualLayoutQueryStringComposite

public static LayoutQueryStringComposite getActualLayoutQueryStringComposite(long groupId,
                                                             boolean privateLayout,
                                                             java.lang.String friendlyURL,
                                                             java.util.Map<java.lang.String,java.lang.String[]> params,
                                                             java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                                                      throws PortalException,
                                                                             SystemException

Throws:: PortalException; SystemException

getActualURL

public static java.lang.String getActualURL(long groupId,
                            boolean privateLayout,
                            java.lang.String mainPath,
                            java.lang.String friendlyURL,
                            java.util.Map<java.lang.String,java.lang.String[]> params,
                            java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getAlternateLocales

public static java.util.Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request)
                                              throws PortalException,
                                                     SystemException

Deprecated. As of 6.2.0, replaced by LanguageUtil.getAvailableLocales()

Throws:: PortalException; SystemException

getAlternateURL

public static java.lang.String getAlternateURL(java.lang.String canonicalURL,
                               ThemeDisplay themeDisplay,
                               java.util.Locale locale,
                               Layout layout)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getAuthTokenIgnoreActions
```
public static java.util.Set<java.lang.String> getAuthTokenIgnoreActions()
```
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions()

getAuthTokenIgnorePortlets
```
public static java.util.Set<java.lang.String> getAuthTokenIgnorePortlets()
```
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelist()

getBaseModel

public static BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getBaseModel

public static BaseModel<?> getBaseModel(java.lang.String modelName,
                        java.lang.String primKey)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getBasicAuthUserId

public static long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getBasicAuthUserId

public static long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
                      long companyId)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getCanonicalURL

public static java.lang.String getCanonicalURL(java.lang.String completeURL,
                               ThemeDisplay themeDisplay,
                               Layout layout)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getCanonicalURL

public static java.lang.String getCanonicalURL(java.lang.String completeURL,
                               ThemeDisplay themeDisplay,
                               Layout layout,
                               boolean forceLayoutFriendlyURL)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getCDNHost
```
public static java.lang.String getCDNHost()
```
Deprecated. As of 6.1.0, replaced by getCDNHost(boolean)

getCDNHost

public static java.lang.String getCDNHost(boolean secure)

getCDNHost

public static java.lang.String getCDNHost(javax.servlet.http.HttpServletRequest request)
                                   throws PortalException,
                                          SystemException

Throws:: PortalException; SystemException

getCDNHostHttp

public static java.lang.String getCDNHostHttp(long companyId)

getCDNHostHttps

public static java.lang.String getCDNHostHttps(long companyId)

getClassName

public static java.lang.String getClassName(long classNameId)

getClassNameId

public static long getClassNameId(java.lang.Class<?> clazz)

getClassNameId

public static long getClassNameId(java.lang.String value)

getClassNamePortletId

public static java.lang.String getClassNamePortletId(java.lang.String className)

getCompany

public static Company getCompany(javax.servlet.http.HttpServletRequest request)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

getCompany

public static Company getCompany(javax.portlet.PortletRequest portletRequest)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

getCompanyId

public static long getCompanyId(javax.servlet.http.HttpServletRequest request)

getCompanyId

public static long getCompanyId(javax.portlet.PortletRequest portletRequest)

getCompanyIds
```
public static long[] getCompanyIds()
```

getComputerAddress

public static java.lang.String getComputerAddress()

getComputerName

public static java.lang.String getComputerName()

getControlPanelCategoriesMap

public static java.util.Map<java.lang.String,java.util.List<Portlet>> getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request)
                                                                                            throws SystemException

Throws:: SystemException

getControlPanelCategory

public static java.lang.String getControlPanelCategory(java.lang.String portletId,
                                       ThemeDisplay themeDisplay)
                                                throws SystemException

Throws:: SystemException

getControlPanelFullURL

public static java.lang.String getControlPanelFullURL(long scopeGroupId,
                                      java.lang.String ppid,
                                      java.util.Map<java.lang.String,java.lang.String[]> params)
                                               throws PortalException,
                                                      SystemException

Throws:: PortalException; SystemException

getControlPanelPlid

public static long getControlPanelPlid(long companyId)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException

getControlPanelPlid

public static long getControlPanelPlid(javax.portlet.PortletRequest portletRequest)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException

getControlPanelPortlets

public static java.util.Set<Portlet> getControlPanelPortlets(long companyId,
                                             java.lang.String category)
                                                      throws SystemException

Throws:: SystemException

getControlPanelPortlets

public static java.util.List<Portlet> getControlPanelPortlets(java.lang.String category,
                                              ThemeDisplay themeDisplay)
                                                       throws SystemException

Throws:: SystemException

getControlPanelPortletURL

public static javax.portlet.PortletURL getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String portletId,
                                                 long referrerPlid,
                                                 java.lang.String lifecycle)

getControlPanelPortletURL

public static javax.portlet.PortletURL getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest,
                                                 java.lang.String portletId,
                                                 long referrerPlid,
                                                 java.lang.String lifecycle)

getCreateAccountURL

public static java.lang.String getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
                                   ThemeDisplay themeDisplay)
                                            throws java.lang.Exception

Throws:: java.lang.Exception

getCurrentCompleteURL

public static java.lang.String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)

getCurrentURL

public static java.lang.String getCurrentURL(javax.servlet.http.HttpServletRequest request)

getCurrentURL

public static java.lang.String getCurrentURL(javax.portlet.PortletRequest portletRequest)

getCustomSQLFunctionIsNotNull

public static java.lang.String getCustomSQLFunctionIsNotNull()

getCustomSQLFunctionIsNull

public static java.lang.String getCustomSQLFunctionIsNull()

getDate

public static java.util.Date getDate(int month,
                     int day,
                     int year)

getDate

public static java.util.Date getDate(int month,
                     int day,
                     int year,
                     java.lang.Class<? extends PortalException> clazz)
                              throws PortalException

Throws:: PortalException

getDate

public static java.util.Date getDate(int month,
                     int day,
                     int year,
                     int hour,
                     int min,
                     java.lang.Class<? extends PortalException> clazz)
                              throws PortalException

Throws:: PortalException

getDate

public static java.util.Date getDate(int month,
                     int day,
                     int year,
                     int hour,
                     int min,
                     java.util.TimeZone timeZone,
                     java.lang.Class<? extends PortalException> clazz)
                              throws PortalException

Throws:: PortalException

getDate

public static java.util.Date getDate(int month,
                     int day,
                     int year,
                     java.util.TimeZone timeZone,
                     java.lang.Class<? extends PortalException> clazz)
                              throws PortalException

Throws:: PortalException

getDB
```
public static DB getDB()
```
Deprecated. As of 6.1.0, replaced by DBFactoryUtil.getDB()

getDefaultCompanyId

public static long getDefaultCompanyId()

getDigestAuthUserId

public static long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
                                throws PortalException,
                                       SystemException

Throws:: PortalException; SystemException

getDisplayURL

public static java.lang.String getDisplayURL(Group group,
                             ThemeDisplay themeDisplay)
                                      throws PortalException

Throws:: PortalException

getDisplayURL

public static java.lang.String getDisplayURL(Group group,
                             ThemeDisplay themeDisplay,
                             boolean privateLayout)
                                      throws PortalException

Throws:: PortalException

getEmailFromAddress

public static java.lang.String getEmailFromAddress(javax.portlet.PortletPreferences preferences,
                                   long companyId,
                                   java.lang.String defaultValue)
                                            throws SystemException

Throws:: SystemException

getEmailFromName

public static java.lang.String getEmailFromName(javax.portlet.PortletPreferences preferences,
                                long companyId,
                                java.lang.String defaultValue)
                                         throws SystemException

Throws:: SystemException

getExpandoBridgeAttributes

public static java.util.Map<java.lang.String,java.io.Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                       throws PortalException,
                                                                                              SystemException

Throws:: PortalException; SystemException

getExpandoBridgeAttributes

public static java.util.Map<java.lang.String,java.io.Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                                              javax.portlet.PortletRequest portletRequest)
                                                                                       throws PortalException,
                                                                                              SystemException

Throws:: PortalException; SystemException

getExpandoBridgeAttributes

public static java.util.Map<java.lang.String,java.io.Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                                              UploadPortletRequest uploadPortletRequest)
                                                                                       throws PortalException,
                                                                                              SystemException

Throws:: PortalException; SystemException

getExpandoValue

public static java.io.Serializable getExpandoValue(javax.servlet.http.HttpServletRequest request,
                                   java.lang.String name,
                                   int type,
                                   java.lang.String displayType)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

getExpandoValue

public static java.io.Serializable getExpandoValue(javax.portlet.PortletRequest portletRequest,
                                   java.lang.String name,
                                   int type,
                                   java.lang.String displayType)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

getExpandoValue

public static java.io.Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest,
                                   java.lang.String name,
                                   int type,
                                   java.lang.String displayType)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

getFacebookURL

public static java.lang.String getFacebookURL(Portlet portlet,
                              java.lang.String facebookCanvasPageURL,
                              ThemeDisplay themeDisplay)
                                       throws PortalException,
                                              SystemException

Throws:: PortalException; SystemException

getFirstMyAccountPortlet

public static Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
                                        throws SystemException

Throws:: SystemException

getFirstPageLayoutTypes

public static java.lang.String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)

getFirstSiteAdministrationPortlet

public static Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
                                                 throws SystemException

Throws:: SystemException

getFullName

public static java.lang.String getFullName(java.lang.String firstName,
                           java.lang.String middleName,
                           java.lang.String lastName)

getGlobalLibDir

public static java.lang.String getGlobalLibDir()

getGoogleGadgetURL

public static java.lang.String getGoogleGadgetURL(Portlet portlet,
                                  ThemeDisplay themeDisplay)
                                           throws PortalException,
                                                  SystemException

Throws:: PortalException; SystemException

getGroupFriendlyURL

public static java.lang.String getGroupFriendlyURL(Group group,
                                   boolean privateLayoutSet,
                                   ThemeDisplay themeDisplay)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

getGroupFriendlyURL

public static java.lang.String getGroupFriendlyURL(Group group,
                                   boolean privateLayoutSet,
                                   ThemeDisplay themeDisplay,
                                   java.util.Locale locale)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

getGroupFriendlyURLIndex

public static int[] getGroupFriendlyURLIndex(java.lang.String requestURI)

getGroupPermissions

public static java.lang.String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request)

getGroupPermissions

public static java.lang.String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request,
                                     java.lang.String className)

getGroupPermissions

public static java.lang.String[] getGroupPermissions(javax.portlet.PortletRequest portletRequest)

getGroupPermissions

public static java.lang.String[] getGroupPermissions(javax.portlet.PortletRequest portletRequest,
                                     java.lang.String className)

getGuestPermissions

public static java.lang.String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request)

getGuestPermissions

public static java.lang.String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request,
                                     java.lang.String className)

getGuestPermissions

public static java.lang.String[] getGuestPermissions(javax.portlet.PortletRequest portletRequest)

getGuestPermissions

public static java.lang.String[] getGuestPermissions(javax.portlet.PortletRequest portletRequest,
                                     java.lang.String className)

getHomeURL

public static java.lang.String getHomeURL(javax.servlet.http.HttpServletRequest request)
                                   throws PortalException,
                                          SystemException

Throws:: PortalException; SystemException

getHost

public static java.lang.String getHost(javax.servlet.http.HttpServletRequest request)

getHost

public static java.lang.String getHost(javax.portlet.PortletRequest portletRequest)

getHttpServletRequest

public static javax.servlet.http.HttpServletRequest getHttpServletRequest(javax.portlet.PortletRequest portletRequest)

getHttpServletResponse

public static javax.servlet.http.HttpServletResponse getHttpServletResponse(javax.portlet.PortletResponse portletResponse)

getI18nPathLanguageId

public static java.lang.String getI18nPathLanguageId(java.util.Locale locale,
                                     java.lang.String defaultI18nPathLanguageId)

getJournalArticleActualURL

public static java.lang.String getJournalArticleActualURL(long groupId,
                                          boolean privateLayout,
                                          java.lang.String mainPath,
                                          java.lang.String friendlyURL,
                                          java.util.Map<java.lang.String,java.lang.String[]> params,
                                          java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                                   throws PortalException,
                                                          SystemException

Throws:: PortalException; SystemException

getJournalArticleLayout

public static Layout getJournalArticleLayout(long groupId,
                             boolean privateLayout,
                             java.lang.String friendlyURL)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getJsSafePortletId

public static java.lang.String getJsSafePortletId(java.lang.String portletId)

getLayoutActualURL

public static java.lang.String getLayoutActualURL(Layout layout)

getLayoutActualURL

public static java.lang.String getLayoutActualURL(Layout layout,
                                  java.lang.String mainPath)

getLayoutActualURL

public static java.lang.String getLayoutActualURL(long groupId,
                                  boolean privateLayout,
                                  java.lang.String mainPath,
                                  java.lang.String friendlyURL)
                                           throws PortalException,
                                                  SystemException

Throws:: PortalException; SystemException

getLayoutActualURL

public static java.lang.String getLayoutActualURL(long groupId,
                                  boolean privateLayout,
                                  java.lang.String mainPath,
                                  java.lang.String friendlyURL,
                                  java.util.Map<java.lang.String,java.lang.String[]> params,
                                  java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                           throws PortalException,
                                                  SystemException

Throws:: PortalException; SystemException

getLayoutEditPage

public static java.lang.String getLayoutEditPage(Layout layout)

getLayoutEditPage

public static java.lang.String getLayoutEditPage(java.lang.String type)

getLayoutFriendlyURL

public static java.lang.String getLayoutFriendlyURL(Layout layout,
                                    ThemeDisplay themeDisplay)
                                             throws PortalException,
                                                    SystemException

Throws:: PortalException; SystemException

getLayoutFriendlyURL

public static java.lang.String getLayoutFriendlyURL(Layout layout,
                                    ThemeDisplay themeDisplay,
                                    java.util.Locale locale)
                                             throws PortalException,
                                                    SystemException

Throws:: PortalException; SystemException

getLayoutFriendlyURLComposite

public static LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(long groupId,
                                                       boolean privateLayout,
                                                       java.lang.String friendlyURL,
                                                       java.util.Map<java.lang.String,java.lang.String[]> params,
                                                       java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                                                throws PortalException,
                                                                       SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static java.lang.String getLayoutFullURL(Layout layout,
                                ThemeDisplay themeDisplay)
                                         throws PortalException,
                                                SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static java.lang.String getLayoutFullURL(Layout layout,
                                ThemeDisplay themeDisplay,
                                boolean doAsUser)
                                         throws PortalException,
                                                SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static java.lang.String getLayoutFullURL(long groupId,
                                java.lang.String portletId)
                                         throws PortalException,
                                                SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static java.lang.String getLayoutFullURL(long groupId,
                                java.lang.String portletId,
                                boolean secure)
                                         throws PortalException,
                                                SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static java.lang.String getLayoutFullURL(ThemeDisplay themeDisplay)
                                         throws PortalException,
                                                SystemException

Throws:: PortalException; SystemException

getLayoutSetFriendlyURL

public static java.lang.String getLayoutSetFriendlyURL(LayoutSet layoutSet,
                                       ThemeDisplay themeDisplay)
                                                throws PortalException,
                                                       SystemException

Throws:: PortalException; SystemException

getLayoutTarget

public static java.lang.String getLayoutTarget(Layout layout)

getLayoutURL

public static java.lang.String getLayoutURL(Layout layout,
                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getLayoutURL

public static java.lang.String getLayoutURL(Layout layout,
                            ThemeDisplay themeDisplay,
                            boolean doAsUser)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getLayoutURL

public static java.lang.String getLayoutURL(Layout layout,
                            ThemeDisplay themeDisplay,
                            java.util.Locale locale)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getLayoutURL

public static java.lang.String getLayoutURL(ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getLayoutViewPage

public static java.lang.String getLayoutViewPage(Layout layout)

getLayoutViewPage

public static java.lang.String getLayoutViewPage(java.lang.String type)

getLiferayPortletRequest

public static LiferayPortletRequest getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)

getLiferayPortletResponse

public static LiferayPortletResponse getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)

getLocale

public static java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request)

getLocale

public static java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         boolean initialize)

getLocale

public static java.util.Locale getLocale(javax.portlet.PortletRequest portletRequest)

getLocalizedFriendlyURL

public static java.lang.String getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request,
                                       Layout layout,
                                       java.util.Locale locale,
                                       java.util.Locale originalLocale)
                                                throws java.lang.Exception

Throws:: java.lang.Exception

getMailId

public static java.lang.String getMailId(java.lang.String mx,
                         java.lang.String popPortletPrefix,
                         java.lang.Object... ids)

getModel

public static BaseModel<?> getModel(ResourcePermission resourcePermission)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by getBaseModel(ResourcePermission)

Throws:: PortalException; SystemException

getModel

public static BaseModel<?> getModel(java.lang.String modelName,
                    java.lang.String primKey)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.1.0, replaced by getBaseModel(String, String)

Throws:: PortalException; SystemException

getNetvibesURL

public static java.lang.String getNetvibesURL(Portlet portlet,
                              ThemeDisplay themeDisplay)
                                       throws PortalException,
                                              SystemException

Throws:: PortalException; SystemException

getNewPortletTitle

public static java.lang.String getNewPortletTitle(java.lang.String portletTitle,
                                  java.lang.String oldScopeName,
                                  java.lang.String newScopeName)

getOriginalServletRequest

public static javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)

getParentGroupId

public static long getParentGroupId(long scopeGroupId)
                             throws PortalException,
                                    SystemException

Deprecated. As of 6.2.0 renamed to getSiteGroupId(long)

Throws:: PortalException; SystemException

getPathContext

public static java.lang.String getPathContext()

getPathContext

public static java.lang.String getPathContext(javax.servlet.http.HttpServletRequest request)

getPathContext

public static java.lang.String getPathContext(javax.portlet.PortletRequest portletRequest)

getPathContext

public static java.lang.String getPathContext(java.lang.String contextPath)

getPathFriendlyURLPrivateGroup

public static java.lang.String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

public static java.lang.String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

public static java.lang.String getPathFriendlyURLPublic()

getPathImage

public static java.lang.String getPathImage()

getPathMain

public static java.lang.String getPathMain()

getPathModule

public static java.lang.String getPathModule()

getPathProxy

public static java.lang.String getPathProxy()

getPlidFromFriendlyURL

public static long getPlidFromFriendlyURL(long companyId,
                          java.lang.String friendlyURL)

getPlidFromPortletId

public static long getPlidFromPortletId(long groupId,
                        boolean privateLayout,
                        java.lang.String portletId)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getPlidFromPortletId

public static long getPlidFromPortletId(long groupId,
                        java.lang.String portletId)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getPortal
```
public static Portal getPortal()
```

getPortalLibDir

public static java.lang.String getPortalLibDir()

getPortalPort
```
public static int getPortalPort()
```
Deprecated. As of 6.1.0, replaced by getPortalPort(boolean)

getPortalPort

public static int getPortalPort(boolean secure)

getPortalProperties

public static java.util.Properties getPortalProperties()

getPortalURL

public static java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest request)

getPortalURL

public static java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest request,
                            boolean secure)

getPortalURL

public static java.lang.String getPortalURL(Layout layout,
                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getPortalURL

public static java.lang.String getPortalURL(javax.portlet.PortletRequest portletRequest)

getPortalURL

public static java.lang.String getPortalURL(javax.portlet.PortletRequest portletRequest,
                            boolean secure)

getPortalURL

public static java.lang.String getPortalURL(java.lang.String serverName,
                            int serverPort,
                            boolean secure)

getPortalURL

public static java.lang.String getPortalURL(ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getPortalWebDir

public static java.lang.String getPortalWebDir()

getPortletAddDefaultResourceCheckWhitelist
```
public static java.util.Set<java.lang.String> getPortletAddDefaultResourceCheckWhitelist()
```
Deprecated. As of 6.2.0 replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelist()

getPortletAddDefaultResourceCheckWhitelistActions
```
public static java.util.Set<java.lang.String> getPortletAddDefaultResourceCheckWhitelistActions()
```
Deprecated. As of 6.2.0 replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions()

getPortletBreadcrumbList

public static java.util.List<BreadcrumbEntry> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)

Deprecated. As of 6.1.0, replaced by getPortletBreadcrumbs(HttpServletRequest)

getPortletBreadcrumbs

public static java.util.List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)

getPortletConfig

public static javax.portlet.PortletConfig getPortletConfig(long companyId,
                                           java.lang.String portletId,
                                           javax.servlet.ServletContext servletContext)
                                                    throws javax.portlet.PortletException,
                                                           SystemException

Throws:: javax.portlet.PortletException; SystemException

getPortletDescription

public static java.lang.String getPortletDescription(Portlet portlet,
                                     javax.servlet.ServletContext servletContext,
                                     java.util.Locale locale)

getPortletDescription

public static java.lang.String getPortletDescription(Portlet portlet,
                                     User user)

getPortletDescription

public static java.lang.String getPortletDescription(java.lang.String portletId,
                                     java.util.Locale locale)

getPortletDescription

public static java.lang.String getPortletDescription(java.lang.String portletId,
                                     java.lang.String languageId)

getPortletDescription

public static java.lang.String getPortletDescription(java.lang.String portletId,
                                     User user)

getPortletId

public static java.lang.String getPortletId(javax.servlet.http.HttpServletRequest request)

getPortletId

public static java.lang.String getPortletId(javax.portlet.PortletRequest portletRequest)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(Portlet portlet,
                                   java.util.Locale locale)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(Portlet portlet,
                                   javax.servlet.ServletContext servletContext,
                                   java.util.Locale locale)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(Portlet portlet,
                                   java.lang.String languageId)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(Portlet portlet,
                                   User user)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(java.lang.String portletId,
                                   java.util.Locale locale)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(java.lang.String portletId,
                                   java.lang.String languageId)

getPortletLongTitle

public static java.lang.String getPortletLongTitle(java.lang.String portletId,
                                   User user)

getPortletNamespace

public static java.lang.String getPortletNamespace(java.lang.String portletId)

getPortletTitle

public static java.lang.String getPortletTitle(Portlet portlet,
                               java.util.Locale locale)

getPortletTitle

public static java.lang.String getPortletTitle(Portlet portlet,
                               javax.servlet.ServletContext servletContext,
                               java.util.Locale locale)

getPortletTitle

public static java.lang.String getPortletTitle(Portlet portlet,
                               java.lang.String languageId)

getPortletTitle

public static java.lang.String getPortletTitle(Portlet portlet,
                               User user)

getPortletTitle

public static java.lang.String getPortletTitle(javax.portlet.RenderRequest renderRequest)

getPortletTitle

public static java.lang.String getPortletTitle(javax.portlet.RenderResponse renderResponse)

getPortletTitle

public static java.lang.String getPortletTitle(java.lang.String portletId,
                               java.util.Locale locale)

getPortletTitle

public static java.lang.String getPortletTitle(java.lang.String portletId,
                               java.lang.String languageId)

getPortletTitle

public static java.lang.String getPortletTitle(java.lang.String portletId,
                               User user)

getPortletXmlFileName

public static java.lang.String getPortletXmlFileName()
                                              throws SystemException

Throws:: SystemException

getPreferences

public static javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)

getPreferencesValidator

public static javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getRelativeHomeURL

public static java.lang.String getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
                                           throws PortalException,
                                                  SystemException

Throws:: PortalException; SystemException

getScopeGroupId

public static long getScopeGroupId(javax.servlet.http.HttpServletRequest request)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getScopeGroupId

public static long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
                   java.lang.String portletId)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getScopeGroupId

public static long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
                   java.lang.String portletId,
                   boolean checkStagingGroup)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getScopeGroupId

public static long getScopeGroupId(Layout layout)

getScopeGroupId

public static long getScopeGroupId(Layout layout,
                   java.lang.String portletId)

getScopeGroupId

public static long getScopeGroupId(long plid)

getScopeGroupId

public static long getScopeGroupId(javax.portlet.PortletRequest portletRequest)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(javax.servlet.http.HttpServletRequest request)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(javax.servlet.http.HttpServletRequest request,
                   boolean checkPermission)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(javax.portlet.PortletRequest portletRequest)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(javax.portlet.PortletRequest portletRequest,
                   boolean checkPermission)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getServletContextName

public static java.lang.String getServletContextName()

getSharedContentSiteGroupIds

public static long[] getSharedContentSiteGroupIds(long companyId,
                                  long groupId,
                                  long userId)
                                           throws PortalException,
                                                  SystemException

Throws:: PortalException; SystemException

getSiteAdministrationCategoriesMap

public static java.util.Map<java.lang.String,java.util.List<Portlet>> getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request)
                                                                                                  throws SystemException

Throws:: SystemException

getSiteAdministrationURL

public static javax.portlet.PortletURL getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
                                                ThemeDisplay themeDisplay)
                                                         throws SystemException

Throws:: SystemException

getSiteAdministrationURL

public static javax.portlet.PortletURL getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
                                                ThemeDisplay themeDisplay,
                                                java.lang.String portletName)

getSiteAdministrationURL

public static javax.portlet.PortletURL getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse,
                                                ThemeDisplay themeDisplay)
                                                         throws SystemException

Throws:: SystemException

getSiteAdministrationURL

public static javax.portlet.PortletURL getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse,
                                                ThemeDisplay themeDisplay,
                                                java.lang.String portletName)

getSiteAndCompanyGroupIds

public static long[] getSiteAndCompanyGroupIds(long groupId)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getSiteAndCompanyGroupIds

public static long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getSiteDefaultLocale

public static java.util.Locale getSiteDefaultLocale(long groupId)
                                             throws PortalException,
                                                    SystemException

Throws:: PortalException; SystemException

getSiteGroupId

public static long getSiteGroupId(long scopeGroupId)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getSiteLoginURL

public static java.lang.String getSiteLoginURL(ThemeDisplay themeDisplay)
                                        throws PortalException,
                                               SystemException

Throws:: PortalException; SystemException

getStaticResourceURL

public static java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String uri)

getStaticResourceURL

public static java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String uri,
                                    long timestamp)

getStaticResourceURL

public static java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String uri,
                                    java.lang.String queryString)

getStaticResourceURL

public static java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String uri,
                                    java.lang.String queryString,
                                    long timestamp)

getStrutsAction

public static java.lang.String getStrutsAction(javax.servlet.http.HttpServletRequest request)

getSystemGroups

public static java.lang.String[] getSystemGroups()

getSystemOrganizationRoles

public static java.lang.String[] getSystemOrganizationRoles()

getSystemRoles

public static java.lang.String[] getSystemRoles()

getSystemSiteRoles

public static java.lang.String[] getSystemSiteRoles()

getUniqueElementId

public static java.lang.String getUniqueElementId(javax.servlet.http.HttpServletRequest request,
                                  java.lang.String namespace,
                                  java.lang.String id)

getUniqueElementId

public static java.lang.String getUniqueElementId(javax.portlet.PortletRequest request,
                                  java.lang.String namespace,
                                  java.lang.String id)

getUploadPortletRequest

public static UploadPortletRequest getUploadPortletRequest(javax.portlet.PortletRequest portletRequest)

getUploadServletRequest

public static UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest request)

getUptime

public static java.util.Date getUptime()

getURLWithSessionId

public static java.lang.String getURLWithSessionId(java.lang.String url,
                                   java.lang.String sessionId)

getUser

public static User getUser(javax.servlet.http.HttpServletRequest request)
                    throws PortalException,
                           SystemException

Throws:: PortalException; SystemException

getUser

public static User getUser(javax.portlet.PortletRequest portletRequest)
                    throws PortalException,
                           SystemException

Throws:: PortalException; SystemException

getUserEmailAddress

public static java.lang.String getUserEmailAddress(long userId)
                                            throws SystemException

Throws:: SystemException

getUserId

public static long getUserId(javax.servlet.http.HttpServletRequest request)

getUserId

public static long getUserId(javax.portlet.PortletRequest portletRequest)

getUserName

public static java.lang.String getUserName(BaseModel<?> baseModel)

getUserName

public static java.lang.String getUserName(long userId,
                           java.lang.String defaultUserName)

getUserName

public static java.lang.String getUserName(long userId,
                           java.lang.String defaultUserName,
                           javax.servlet.http.HttpServletRequest request)

getUserName

public static java.lang.String getUserName(long userId,
                           java.lang.String defaultUserName,
                           java.lang.String userAttribute)

getUserName

public static java.lang.String getUserName(long userId,
                           java.lang.String defaultUserName,
                           java.lang.String userAttribute,
                           javax.servlet.http.HttpServletRequest request)

getUserPassword

public static java.lang.String getUserPassword(javax.servlet.http.HttpServletRequest request)

getUserPassword

public static java.lang.String getUserPassword(javax.servlet.http.HttpSession session)

getUserPassword

public static java.lang.String getUserPassword(javax.portlet.PortletRequest portletRequest)

getUserValue

public static java.lang.String getUserValue(long userId,
                            java.lang.String param,
                            java.lang.String defaultValue)
                                     throws SystemException

Throws:: SystemException

getValidPortalDomain

public static java.lang.String getValidPortalDomain(long companyId,
                                    java.lang.String domain)

getValidUserId

public static long getValidUserId(long companyId,
                  long userId)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getVirtualLayoutActualURL

public static java.lang.String getVirtualLayoutActualURL(long groupId,
                                         boolean privateLayout,
                                         java.lang.String mainPath,
                                         java.lang.String friendlyURL,
                                         java.util.Map<java.lang.String,java.lang.String[]> params,
                                         java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                                  throws PortalException,
                                                         SystemException

Throws:: PortalException; SystemException

getVirtualLayoutFriendlyURLComposite

public static LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(boolean privateLayout,
                                                              java.lang.String friendlyURL,
                                                              java.util.Map<java.lang.String,java.lang.String[]> params,
                                                              java.util.Map<java.lang.String,java.lang.Object> requestContext)
                                                                       throws PortalException,
                                                                              SystemException

Throws:: PortalException; SystemException

getWidgetURL

public static java.lang.String getWidgetURL(Portlet portlet,
                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

initCustomSQL
```
public static void initCustomSQL()
```

initUser

public static User initUser(javax.servlet.http.HttpServletRequest request)
                     throws java.lang.Exception

Throws:: java.lang.Exception

invokeTaglibDiscussion

public static void invokeTaglibDiscussion(javax.portlet.PortletConfig portletConfig,
                          javax.portlet.ActionRequest actionRequest,
                          javax.portlet.ActionResponse actionResponse)
                                   throws java.lang.Exception

Throws:: java.lang.Exception

isAllowAddPortletDefaultResource

public static boolean isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
                                       Portlet portlet)
                                                throws PortalException,
                                                       SystemException

Deprecated. As of 6.2.0 with no direct replacement

Throws:: PortalException; SystemException

isCDNDynamicResourcesEnabled

public static boolean isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

isCDNDynamicResourcesEnabled

public static boolean isCDNDynamicResourcesEnabled(long companyId)

isCommunityAdmin

public static boolean isCommunityAdmin(User user,
                       long groupId)
                                throws java.lang.Exception

Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long)

Throws:: java.lang.Exception

isCommunityOwner

public static boolean isCommunityOwner(User user,
                       long groupId)
                                throws java.lang.Exception

Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long)

Throws:: java.lang.Exception

isCompanyAdmin

public static boolean isCompanyAdmin(User user)
                              throws java.lang.Exception

Throws:: java.lang.Exception

isCompanyControlPanelPortlet

public static boolean isCompanyControlPanelPortlet(java.lang.String portletId,
                                   java.lang.String category,
                                   ThemeDisplay themeDisplay)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

isCompanyControlPanelPortlet

public static boolean isCompanyControlPanelPortlet(java.lang.String portletId,
                                   ThemeDisplay themeDisplay)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

isCompanyControlPanelVisible

public static boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
                                            throws PortalException,
                                                   SystemException

Throws:: PortalException; SystemException

isControlPanelPortlet

public static boolean isControlPanelPortlet(java.lang.String portletId,
                            java.lang.String category,
                            ThemeDisplay themeDisplay)
                                     throws SystemException

Throws:: SystemException

isControlPanelPortlet

public static boolean isControlPanelPortlet(java.lang.String portletId,
                            ThemeDisplay themeDisplay)
                                     throws SystemException

Throws:: SystemException

isGroupAdmin

public static boolean isGroupAdmin(User user,
                   long groupId)
                            throws java.lang.Exception

Throws:: java.lang.Exception

isGroupFriendlyURL

public static boolean isGroupFriendlyURL(java.lang.String fullURL,
                         java.lang.String groupFriendlyURL,
                         java.lang.String layoutFriendlyURL)

isGroupOwner

public static boolean isGroupOwner(User user,
                   long groupId)
                            throws java.lang.Exception

Throws:: java.lang.Exception

isLayoutDescendant

public static boolean isLayoutDescendant(Layout layout,
                         long layoutId)
                                  throws PortalException,
                                         SystemException

Throws:: PortalException; SystemException

isLayoutFirstPageable

public static boolean isLayoutFirstPageable(Layout layout)

isLayoutFirstPageable

public static boolean isLayoutFirstPageable(java.lang.String type)

isLayoutFriendliable

public static boolean isLayoutFriendliable(Layout layout)

isLayoutFriendliable

public static boolean isLayoutFriendliable(java.lang.String type)

isLayoutParentable

public static boolean isLayoutParentable(Layout layout)

isLayoutParentable

public static boolean isLayoutParentable(java.lang.String type)

isLayoutSitemapable

public static boolean isLayoutSitemapable(Layout layout)

isLoginRedirectRequired

public static boolean isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request)
                                       throws SystemException

Throws:: SystemException

isMethodGet

public static boolean isMethodGet(javax.portlet.PortletRequest portletRequest)

isMethodPost

public static boolean isMethodPost(javax.portlet.PortletRequest portletRequest)

isMultipartRequest

public static boolean isMultipartRequest(javax.servlet.http.HttpServletRequest request)

isOmniadmin

public static boolean isOmniadmin(long userId)

isReservedParameter

public static boolean isReservedParameter(java.lang.String name)

isRSSFeedsEnabled

public static boolean isRSSFeedsEnabled()

isSecure

public static boolean isSecure(javax.servlet.http.HttpServletRequest request)

isSystemGroup

public static boolean isSystemGroup(java.lang.String groupName)

isSystemRole

public static boolean isSystemRole(java.lang.String roleName)

isUpdateAvailable

public static boolean isUpdateAvailable()
                                 throws SystemException

Throws:: SystemException

isValidResourceId

public static boolean isValidResourceId(java.lang.String resourceId)

resetCDNHosts
```
public static void resetCDNHosts()
```

resetPortletAddDefaultResourceCheckWhitelist
```
public static java.util.Set<java.lang.String> resetPortletAddDefaultResourceCheckWhitelist()
```
Deprecated. As of 6.2.0 replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelist()

resetPortletAddDefaultResourceCheckWhitelistActions
```
public static java.util.Set<java.lang.String> resetPortletAddDefaultResourceCheckWhitelistActions()
```
Deprecated. As of 6.2.0 replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions()

resetPortletParameters

public static java.lang.String resetPortletParameters(java.lang.String url,
                                      java.lang.String portletId)

runSQL

public static void runSQL(java.lang.String sql)
                   throws java.io.IOException,
                          java.sql.SQLException

Deprecated. As of 6.1.0, replaced by DB.runSQL(String)

Throws:: java.io.IOException; java.sql.SQLException

sendError

public static void sendError(java.lang.Exception e,
             javax.portlet.ActionRequest actionRequest,
             javax.portlet.ActionResponse actionResponse)
                      throws java.io.IOException

Throws:: java.io.IOException

sendError

public static void sendError(java.lang.Exception e,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                      throws java.io.IOException,
                             javax.servlet.ServletException

Throws:: java.io.IOException; javax.servlet.ServletException

sendError

public static void sendError(int status,
             java.lang.Exception e,
             javax.portlet.ActionRequest actionRequest,
             javax.portlet.ActionResponse actionResponse)
                      throws java.io.IOException

Throws:: java.io.IOException

sendError

public static void sendError(int status,
             java.lang.Exception e,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
                      throws java.io.IOException,
                             javax.servlet.ServletException

Throws:: java.io.IOException; javax.servlet.ServletException

sendRSSFeedsDisabledError

public static void sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                                      throws java.io.IOException,
                                             javax.servlet.ServletException

Throws:: java.io.IOException; javax.servlet.ServletException

sendRSSFeedsDisabledError

public static void sendRSSFeedsDisabledError(javax.portlet.PortletRequest portletRequest,
                             javax.portlet.PortletResponse portletResponse)
                                      throws java.io.IOException,
                                             javax.servlet.ServletException

Throws:: java.io.IOException; javax.servlet.ServletException

setPageDescription

public static void setPageDescription(java.lang.String description,
                      javax.servlet.http.HttpServletRequest request)

Sets the description for a page. This overrides the existing page description.

setPageKeywords

public static void setPageKeywords(java.lang.String keywords,
                   javax.servlet.http.HttpServletRequest request)

Sets the keywords for a page. This overrides the existing page keywords.

setPageSubtitle

public static void setPageSubtitle(java.lang.String subtitle,
                   javax.servlet.http.HttpServletRequest request)

Sets the subtitle for a page. This overrides the existing page subtitle.

setPageTitle

public static void setPageTitle(java.lang.String title,
                javax.servlet.http.HttpServletRequest request)

Sets the whole title for a page. This overrides the existing page whole title.

setPortalPort

public static void setPortalPort(javax.servlet.http.HttpServletRequest request)

Sets the port obtained on the first request to the portal.

storePreferences

public static void storePreferences(javax.portlet.PortletPreferences portletPreferences)
                             throws java.io.IOException,
                                    javax.portlet.ValidatorException

Throws:: java.io.IOException; javax.portlet.ValidatorException

stripURLAnchor

public static java.lang.String[] stripURLAnchor(java.lang.String url,
                                java.lang.String separator)

transformCustomSQL

public static java.lang.String transformCustomSQL(java.lang.String sql)

transformSQL

public static java.lang.String transformSQL(java.lang.String sql)

updatePortletMode

public static javax.portlet.PortletMode updatePortletMode(java.lang.String portletId,
                                          User user,
                                          Layout layout,
                                          javax.portlet.PortletMode portletMode,
                                          javax.servlet.http.HttpServletRequest request)

updateRedirect

public static java.lang.String updateRedirect(java.lang.String redirect,
                              java.lang.String oldPath,
                              java.lang.String newPath)

updateWindowState

public static javax.portlet.WindowState updateWindowState(java.lang.String portletId,
                                          User user,
                                          Layout layout,
                                          javax.portlet.WindowState windowState,
                                          javax.servlet.http.HttpServletRequest request)

removePortalPortEventListener

public void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)

setPortal
```
public void setPortal(Portal portal)
```

Class PortalUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortalUtil

Method Detail

addPageDescription

addPageKeywords

addPageSubtitle

addPageTitle

addPortalPortEventListener

addPortalPortProtocolEventListener

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletDefaultResource

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

addUserLocaleOptionsMessage

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getAbsoluteURL

getActualLayoutQueryStringComposite

getActualURL

getAlternateLocales

getAlternateURL

getAuthTokenIgnoreActions

getAuthTokenIgnorePortlets

getBaseModel

getBaseModel

getBasicAuthUserId

getBasicAuthUserId

getCanonicalURL

getCanonicalURL

getCDNHost

getCDNHost

getCDNHost

getCDNHostHttp

getCDNHostHttps

getClassName

getClassNameId

getClassNameId

getClassNamePortletId

getCompany

getCompany

getCompanyId

getCompanyId

getCompanyIds

getComputerAddress

getComputerName

getControlPanelCategoriesMap

getControlPanelCategory

getControlPanelFullURL

getControlPanelPlid

getControlPanelPlid

getControlPanelPortlets

getControlPanelPortlets

getControlPanelPortletURL

getControlPanelPortletURL

getCreateAccountURL

getCurrentCompleteURL

getCurrentURL

getCurrentURL

getCustomSQLFunctionIsNotNull

getCustomSQLFunctionIsNull

getDate

getDate

getDate

getDate

getDate

getDB

getDefaultCompanyId

getDigestAuthUserId

getDisplayURL

getDisplayURL

getEmailFromAddress

getEmailFromName