PortalUtil (Portal 7.0.10)

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

public class PortalUtil
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

PortalUtil()

Constructors
Constructor and Description
`PortalUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest request)` Appends the description to the current meta description of the page in the request.
`static void`	`addPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest request)` Appends the keywords to the current meta keywords of the page in the request.
`static void`	`addPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request)` Appends the subtitle to the current subtitle of the page in the request.
`static void`	`addPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request)` Appends the title to the current title of the page in the request.
`static boolean`	`addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`static void`	`addPortalPortEventListener(PortalPortEventListener portalPortEventListener)` Deprecated. As of Wilberforce (7.0.x), replaced by `addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)`
`static void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url)` Adds an entry to the portlet breadcrumbs for the page in the request.
`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)` Adds an entry to the portlet breadcrumbs for the page in the request.
`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, boolean portletBreadcrumbEntry)` Adds an entry to the portlet breadcrumbs for the page in the request.
`static void`	`addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)` Adds the default resource permissions for the portlet to the page in the request.
`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 the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well.
`static java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url)` Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, and refererPlid to the URL.
`static java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url, boolean typeControlPanel, boolean doAsUser)`
`static void`	`addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)`
`static void`	`clearRequestParameters(javax.portlet.RenderRequest renderRequest)` Clears the render parameters in the request if the portlet is in the action phase.
`static void`	`copyRequestParameters(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)` Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters.
`static java.lang.String`	`escapeRedirect(java.lang.String url)` Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects.
`static java.lang.String`	`generateRandomKey(javax.servlet.http.HttpServletRequest request, java.lang.String input)` Generates a random key to identify the request based on the input string.
`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.lang.String`	`getAlternateURL(java.lang.String canonicalURL, ThemeDisplay themeDisplay, java.util.Locale locale, Layout layout)` Returns the alternate URL for the requested canonical URL in the given locale.
`static java.util.Map<java.util.Locale,java.lang.String>`	`getAlternateURLs(java.lang.String canonicalURL, ThemeDisplay themeDisplay, Layout layout)`
`static long[]`	`getAncestorSiteGroupIds(long groupId)`
`static BaseModel<?>`	`getBaseModel(ResourcePermission resourcePermission)` Returns the base model instance for the resource permission.
`static BaseModel<?>`	`getBaseModel(java.lang.String modelName, java.lang.String primKey)` Returns the base model instance for the model name and primary key.
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)`
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)`
`static java.util.List<Group>`	`getBrowsableScopeGroups(long userId, long companyId, long groupId, java.lang.String portletId)`
`static java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout)` Returns the canonical URL for the page.
`static java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL)` Returns the canonical URL of the page, optionally including the page's friendly URL.
`static java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL, boolean includeQueryString)` Returns the canonical URL of the page.
`static java.lang.String`	`getCDNHost(boolean secure)` Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.
`static java.lang.String`	`getCDNHost(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getCDNHostHttp(long companyId)` Returns the insecure (HTTP) content distribution network (CDN) host address
`static java.lang.String`	`getCDNHostHttps(long companyId)` Returns the secure (HTTPS) content distribution network (CDN) host address
`static java.lang.String`	`getClassName(long classNameId)` Returns the fully qualified name of the class from its ID.
`static long`	`getClassNameId(java.lang.Class<?> clazz)` Returns the ID of the class from its class object.
`static long`	`getClassNameId(java.lang.String value)` Returns the ID of the class from its fully qualified name.
`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.util.Set<java.lang.String>`	`getComputerAddresses()`
`static java.lang.String`	`getComputerName()`
`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 javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`static javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, java.lang.String lifecycle)`
`static javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`static javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, java.lang.String portletId, java.lang.String lifecycle)`
`static java.lang.String`	`getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`static long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId)`
`static long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds)`
`static long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`static long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`static java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId)`
`static java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds)`
`static java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`static java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`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)` Returns the date object for the specified month, day, and year, or `null` if the date is invalid.
`static java.util.Date`	`getDate(int month, int day, int year, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.
`static java.util.Date`	`getDate(int month, int day, int year, int hour, int min, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid.
`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)` Returns the date object for the specified month, day, year, hour, minute, and time zone, optionally throwing an exception if the date is invalid.
`static java.util.Date`	`getDate(int month, int day, int year, java.util.TimeZone timeZone, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid.
`static long`	`getDefaultCompanyId()`
`static long`	`getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getDigestUserId( HttpServletRequest)`
`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 java.lang.String`	`getFirstPageLayoutTypes(javax.servlet.http.HttpServletRequest request)`
`static java.lang.String`	`getForwardedHost(javax.servlet.http.HttpServletRequest request)`
`static int`	`getForwardedPort(javax.servlet.http.HttpServletRequest request)`
`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(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, 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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`static Layout`	`getJournalArticleLayout(long groupId, boolean privateLayout, java.lang.String friendlyURL)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`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`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`static java.lang.String`	`getLayoutFriendlyURL(ThemeDisplay themeDisplay)`
`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)` Deprecated. As of Judson (7.1.x), replaced by `getLayoutFriendlyURLSeparatorComposite(long, boolean, String, Map, Map)`
`static LayoutFriendlyURLSeparatorComposite`	`getLayoutFriendlyURLSeparatorComposite(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`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay)`
`static java.lang.String`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`static java.lang.String`	`getLayoutSetDisplayURL(LayoutSet layoutSet, boolean secureConnection)`
`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 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 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 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 PortalInetSocketAddressEventListener[]`	`getPortalInetSocketAddressEventListeners()`
`static java.lang.String`	`getPortalLibDir()`
`static java.net.InetAddress`	`getPortalLocalInetAddress(boolean secure)`
`static int`	`getPortalLocalPort(boolean secure)`
`static int`	`getPortalPort(boolean secure)` Deprecated. As of Wilberforce (7.0.x), replaced by `getPortalServerPort(boolean)`
`static java.util.Properties`	`getPortalProperties()`
`static java.net.InetAddress`	`getPortalServerInetAddress(boolean secure)`
`static int`	`getPortalServerPort(boolean secure)`
`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(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`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.List<BreadcrumbEntry>`	`getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `BreadcrumbUtil.getPortletBreadcrumbEntries( HttpServletRequest)`
`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(javax.portlet.PortletRequest portletRequest)`
`static java.lang.String`	`getPortletTitle(javax.portlet.PortletResponse portletResponse)`
`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(java.lang.String portletId, java.util.Locale locale)`
`static java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.ResourceBundle resourceBundle)`
`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 java.util.ResourceBundle`	`getResourceBundle(java.util.Locale locale)`
`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 javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, java.lang.String portletId)` Deprecated. As of Wilberforce (7.0.x), replaced by `#getControlPanelPortletURL(PortletRequest, Group, String, long, String)`
`static javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay, java.lang.String portletName)` Deprecated. As of Wilberforce (7.0.x), replaced by `#getControlPanelPortletURL(PortletRequest, Group, String, long, String)`
`static java.lang.String`	`getSiteAdminURL(Company company, Group group, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)` Deprecated. As of Judson (7.1.x), replaced by `getSiteAdminURL(ThemeDisplay, String, Map)`
`static java.lang.String`	`getSiteAdminURL(Group group, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)` Deprecated. As of Judson (7.1.x), replaced by `getSiteAdminURL(ThemeDisplay, String, Map)`
`static java.lang.String`	`getSiteAdminURL(ThemeDisplay themeDisplay, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`static long[]`	`getSiteAndCompanyGroupIds(long groupId)` Deprecated. As of Wilberforce (7.0.x), replaced by `getCurrentAndAncestorSiteGroupIds(long)`
`static long[]`	`getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)` Deprecated. As of Wilberforce (7.0.x), replaced by `getCurrentAndAncestorSiteGroupIds(long)`
`static java.util.Locale`	`getSiteDefaultLocale(Group group)`
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`static java.lang.String`	`getValidPortalDomain(long companyId, java.lang.String domain)`
`static long`	`getValidUserId(long companyId, long userId)`
`static java.lang.String`	`getVirtualHostname(LayoutSet layoutSet)`
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`static void`	`invokeTaglibDiscussionPagination(javax.portlet.PortletConfig portletConfig, javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`static boolean`	`isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isCDNDynamicResourcesEnabled(long companyId)`
`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`	`isControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`static boolean`	`isControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`static boolean`	`isCustomPortletMode(javax.portlet.PortletMode portletMode)`
`static boolean`	`isForwardedSecure(javax.servlet.http.HttpServletRequest request)`
`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`	`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`	`isOmniadmin(User user)`
`static boolean`	`isReservedParameter(java.lang.String name)`
`static boolean`	`isRightToLeft(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isRSSFeedsEnabled()`
`static boolean`	`isSecure(javax.servlet.http.HttpServletRequest request)`
`static boolean`	`isSkipPortletContentProcesssing(Group group, javax.servlet.http.HttpServletRequest httpServletRequest, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, java.lang.String portletName)`
`static boolean`	`isSkipPortletContentRendering(Group group, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, java.lang.String portletName)`
`static boolean`	`isSystemGroup(java.lang.String groupName)`
`static boolean`	`isSystemRole(java.lang.String roleName)`
`static boolean`	`isUpdateAvailable()`
`static boolean`	`isValidResourceId(java.lang.String resourceId)`
`static boolean`	`removePortalEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`void`	`removePortalPortEventListener(PortalPortEventListener portalPortEventListener)` Deprecated. As of Wilberforce (7.0.x), replaced by `removePortalEventListener( PortalInetSocketAddressEventListener)`
`static void`	`resetCDNHosts()`
`static java.lang.String`	`resetPortletParameters(java.lang.String url, java.lang.String portletId)`
`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`	`setPortalInetSocketAddresses(javax.servlet.http.HttpServletRequest request)`
`static void`	`setPortalPort(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `setPortalInetSocketAddresses(HttpServletRequest)`
`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 void`	`updateImageId(BaseModel<?> baseModel, boolean hasImage, byte[] bytes, java.lang.String fieldName, long maxSize, int maxHeight, int maxWidth)`
`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)
```
Appends the description to the current meta description of the page in the request.

Parameters:

description - the description to append to the current meta description

request - the servlet request for the page

addPageKeywords
```
public static void addPageKeywords(java.lang.String keywords,
                                   javax.servlet.http.HttpServletRequest request)
```
Appends the keywords to the current meta keywords of the page in the request.

Parameters:

keywords - the keywords to add to the current meta keywords (comma-separated)

request - the servlet request for the page

addPageSubtitle
```
public static void addPageSubtitle(java.lang.String subtitle,
                                   javax.servlet.http.HttpServletRequest request)
```
Appends the subtitle to the current subtitle of the page in the request.

Parameters:

subtitle - the subtitle to append to the current subtitle

request - the servlet request for the page

addPageTitle
```
public static void addPageTitle(java.lang.String title,
                                javax.servlet.http.HttpServletRequest request)
```
Appends the title to the current title of the page in the request.

Parameters:

title - the title to append to the current title

request - the servlet request for the page

addPortalInetSocketAddressEventListener

public static boolean addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

addPortalPortEventListener
```
@Deprecated
public static void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
```
Deprecated. As of Wilberforce (7.0.x), replaced by addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)

Adds the portal port event listener to the portal. The listener is notified whenever the portal port is set.

Parameters:

portalPortEventListener - the portal port event listener to add

addPortletBreadcrumbEntry

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

Adds an entry to the portlet breadcrumbs for the page in the request.

Parameters:: request - the servlet request for the page; title - the title of the new breadcrumb entry; url - the URL of the new breadcrumb entry

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)

Adds an entry to the portlet breadcrumbs for the page in the request.

Parameters:: request - the servlet request for the page; title - the title of the new breadcrumb entry; url - the URL of the new breadcrumb entry; data - the HTML5 data parameters of the new breadcrumb entry

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,
                                             boolean portletBreadcrumbEntry)

Adds an entry to the portlet breadcrumbs for the page in the request.

Parameters:: request - the servlet request for the page; title - the title of the new breadcrumb entry; url - the URL of the new breadcrumb entry; data - the HTML5 data parameters of the new breadcrumb entry; portletBreadcrumbEntry - whether the entry is a portlet breadcrumb entry

addPortletDefaultResource

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

Adds the default resource permissions for the portlet to the page in the request.

Parameters:: request - the servlet request for the page; portlet - the portlet
Throws:: PortalException - if a portal exception occurred

addPortletDefaultResource

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

Throws:: PortalException

addPreservedParameters
```
public static java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                                      Layout layout,
                                                      java.lang.String url,
                                                      boolean doAsUser)
```
Adds the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well.
Preserved parameters are parameters that should be sent with every request as the user navigates the portal.

Parameters:

themeDisplay - the current theme display

layout - the current page

url - the URL

doAsUser - whether to include doAsUserId and doAsLanguageId in the URL if they are available. If false, doAsUserId and doAsUserLanguageId will never be added.

Returns:

the URL with the preserved parameters added

addPreservedParameters
```
public static java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                                      java.lang.String url)
```
Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, and refererPlid to the URL.

Parameters:

themeDisplay - the current theme display

url - the URL

Returns:

the URL with the preserved parameters added

addPreservedParameters

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

addUserLocaleOptionsMessage

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

clearRequestParameters
```
public static void clearRequestParameters(javax.portlet.RenderRequest renderRequest)
```
Clears the render parameters in the request if the portlet is in the action phase.

Parameters:

renderRequest - the render request

copyRequestParameters
```
public static void copyRequestParameters(javax.portlet.ActionRequest actionRequest,
                                         javax.portlet.ActionResponse actionResponse)
```
Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters.

Parameters:

actionRequest - the request from which to get the request parameters

actionResponse - the response to receive the render parameters

escapeRedirect
```
public static java.lang.String escapeRedirect(java.lang.String url)
```
Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects.

Parameters:

url - the URL to escape

Returns:

the escaped URL, or null if the URL is not allowed for redirects

generateRandomKey
```
public static java.lang.String generateRandomKey(javax.servlet.http.HttpServletRequest request,
                                                 java.lang.String input)
```
Generates a random key to identify the request based on the input string.

Parameters:

request - the servlet request for the page

input - the input string

Returns:

the generated key

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

Throws:: PortalException

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

Throws:: PortalException

getAlternateURL
```
public static java.lang.String getAlternateURL(java.lang.String canonicalURL,
                                               ThemeDisplay themeDisplay,
                                               java.util.Locale locale,
                                               Layout layout)
                                        throws PortalException
```
Returns the alternate URL for the requested canonical URL in the given locale.
The alternate URL lets search engines know that an equivalent page is available for the given locale. For more information, see https://support.google.com/webmasters/answer/189077?hl=en.

Parameters:

canonicalURL - the canonical URL being requested. For more information, see getCanonicalURL(java.lang.String, com.liferay.portal.kernel.theme.ThemeDisplay, com.liferay.portal.kernel.model.Layout).

themeDisplay - the theme display

locale - the locale of the alternate URL being generated

layout - the page being requested

Returns:

the alternate URL for the requested canonical URL in the given locale

Throws:

PortalException - if a portal exception occurred

getAlternateURLs

public static java.util.Map<java.util.Locale,java.lang.String> getAlternateURLs(java.lang.String canonicalURL,
                                                                                ThemeDisplay themeDisplay,
                                                                                Layout layout)
                                                                         throws PortalException

Throws:: PortalException

getAncestorSiteGroupIds

public static long[] getAncestorSiteGroupIds(long groupId)
                                      throws PortalException

Throws:: PortalException

getBaseModel
```
public static BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                                 throws PortalException
```
Returns the base model instance for the resource permission.

Parameters:

resourcePermission - the resource permission

Returns:

the base model instance, or null if the resource permission does not have a base model instance (such as if it's a portlet)

Throws:

PortalException - if a portal exception occurred

getBaseModel
```
public static BaseModel<?> getBaseModel(java.lang.String modelName,
                                        java.lang.String primKey)
                                 throws PortalException
```
Returns the base model instance for the model name and primary key.

Parameters:

modelName - the fully qualified class name of the model

primKey - the primary key of the model instance to get

Returns:

the base model instance, or null if the model does not have a base model instance (such as if it's a portlet)

Throws:

PortalException - if a portal exception occurred

getBasicAuthUserId

@Deprecated
public static long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                                           throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

HttpAuthManagerUtil.getBasicUserId(
             HttpServletRequest)

Throws:: PortalException

getBasicAuthUserId

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

Deprecated. As of Wilberforce (7.0.x), replaced by

HttpAuthManagerUtil.getBasicUserId(
             HttpServletRequest)

Throws:: PortalException

getBrowsableScopeGroups

public static java.util.List<Group> getBrowsableScopeGroups(long userId,
                                                            long companyId,
                                                            long groupId,
                                                            java.lang.String portletId)
                                                     throws PortalException

Throws:: PortalException

getCanonicalURL
```
public static java.lang.String getCanonicalURL(java.lang.String completeURL,
                                               ThemeDisplay themeDisplay,
                                               Layout layout)
                                        throws PortalException
```
Returns the canonical URL for the page. The canonical URL is often used to distinguish a preferred page from its translations.
A canonical URL for the page is the preferred URL to specify for a set of pages with similar or identical content. The canonical URL is used to inform search engines that several URLs point to the same page. It is also used to generate the URLs for site maps, the URLs that social bookmarks publish (Twitter, Facebook links, etc.), and the URLs in sent email. For more information, see https://support.google.com/webmasters/answer/139394?hl=en.

Parameters:

completeURL - the complete URL of the page

themeDisplay - the theme display

layout - the page being requested (optionally null). If null is specified, the current page is used.

Returns:

the canonical URL for the page

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
public static java.lang.String getCanonicalURL(java.lang.String completeURL,
                                               ThemeDisplay themeDisplay,
                                               Layout layout,
                                               boolean forceLayoutFriendlyURL)
                                        throws PortalException
```
Returns the canonical URL of the page, optionally including the page's friendly URL. The canonical URL is often used to distinguish a preferred page from its translations.
A canonical URL for the page is the preferred URL to specify for a set of pages with similar or identical content. The canonical URL is used to inform search engines that several URLs point to the same page. It is also used to generate the URLs for site maps, the URLs that social bookmarks publish (Twitter, Facebook links, etc.), and the URLs in sent email. For more information, see https://support.google.com/webmasters/answer/139394?hl=en.

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

layout - the page. If it is null, then it is generated for the current page.

forceLayoutFriendlyURL - whether to add the page's friendly URL to the canonical URL

Returns:

the canonical URL of the page

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
public static java.lang.String getCanonicalURL(java.lang.String completeURL,
                                               ThemeDisplay themeDisplay,
                                               Layout layout,
                                               boolean forceLayoutFriendlyURL,
                                               boolean includeQueryString)
                                        throws PortalException
```
Returns the canonical URL of the page. The canonical URL is often used to distinguish a preferred page from its translations.
A page's canonical URL is the preferred URL to specify for a set of pages with similar or identical content. The canonical URL is used to inform search engines that several URLs point to the same page. It is also used to generate the URLs for site maps, the URLs that social bookmarks publish (Twitter, Facebook links, etc.), and the URLs in sent email. For more information, see https://support.google.com/webmasters/answer/139394?hl=en.

Parameters:

completeURL - the complete URL of the page

themeDisplay - the theme display

layout - the page being requested (optionally null). If null is specified, the current page is used.

forceLayoutFriendlyURL - whether to add the page's friendly URL to the canonical URL

includeQueryString - whether to add the URL query string to the canonical URL

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCDNHost
```
public static java.lang.String getCDNHost(boolean secure)
```
Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.

Parameters:

secure - whether to get the secure CDN host address

Returns:

the CDN host address

getCDNHost

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

Throws:: PortalException

getCDNHostHttp
```
public static java.lang.String getCDNHostHttp(long companyId)
```
Returns the insecure (HTTP) content distribution network (CDN) host address

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getCDNHostHttps
```
public static java.lang.String getCDNHostHttps(long companyId)
```
Returns the secure (HTTPS) content distribution network (CDN) host address

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getClassName
```
public static java.lang.String getClassName(long classNameId)
```
Returns the fully qualified name of the class from its ID.

Parameters:

classNameId - the ID of the class

Returns:

the fully qualified name of the class

getClassNameId
```
public static long getClassNameId(java.lang.Class<?> clazz)
```
Returns the ID of the class from its class object.

Parameters:

clazz - the class object

Returns:

the ID of the class

getClassNameId
```
public static long getClassNameId(java.lang.String value)
```
Returns the ID of the class from its fully qualified name.

Parameters:

value - the fully qualified name of the class

Returns:

the ID of the class

getCompany

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

Throws:: PortalException

getCompany

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

Throws:: PortalException

getCompanyId

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

getCompanyId

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

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

getComputerAddresses

public static java.util.Set<java.lang.String> getComputerAddresses()

getComputerName

public static java.lang.String getComputerName()

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

Throws:: PortalException

getControlPanelPlid

public static long getControlPanelPlid(long companyId)
                                throws PortalException

Throws:: PortalException

getControlPanelPlid

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

Throws:: PortalException

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getControlPanelPortletURL

public static javax.portlet.PortletURL getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest,
                                                                 Group group,
                                                                 java.lang.String portletId,
                                                                 long refererGroupId,
                                                                 long refererPlid,
                                                                 java.lang.String lifecycle)

getControlPanelPortletURL

public static javax.portlet.PortletURL getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest,
                                                                 java.lang.String portletId,
                                                                 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

getCurrentAndAncestorSiteGroupIds

public static long[] getCurrentAndAncestorSiteGroupIds(long groupId)
                                                throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

public static long[] getCurrentAndAncestorSiteGroupIds(long groupId,
                                                       boolean checkContentSharingWithChildrenEnabled)
                                                throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

public static long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds)
                                                throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

public static long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds,
                                                       boolean checkContentSharingWithChildrenEnabled)
                                                throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroups

public static java.util.List<Group> getCurrentAndAncestorSiteGroups(long groupId)
                                                             throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroups

public static java.util.List<Group> getCurrentAndAncestorSiteGroups(long groupId,
                                                                    boolean checkContentSharingWithChildrenEnabled)
                                                             throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroups

public static java.util.List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds)
                                                             throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroups

public static java.util.List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds,
                                                                    boolean checkContentSharingWithChildrenEnabled)
                                                             throws PortalException

Throws:: PortalException

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)
```
Returns the date object for the specified month, day, and year, or null if the date is invalid.

Parameters:

month - the month (0-based, meaning 0 for January)

day - the day of the month

year - the year

Returns:

the date object, or null if the date is invalid

getDate
```
public static java.util.Date getDate(int month,
                                     int day,
                                     int year,
                                     java.lang.Class<? extends PortalException> clazz)
                              throws PortalException
```
Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.

Parameters:

month - the month (0-based, meaning 0 for January)

day - the day of the month

year - the year

clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.

Returns:

the date object, or null if the date is invalid and no exception to throw was provided

Throws:

PortalException - if a portal exception occurred

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
```
Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid.

Parameters:

month - the month (0-based, meaning 0 for January)

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.

Returns:

the date object, or null if the date is invalid and no exception to throw was provided

Throws:

PortalException - if a portal exception occurred

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
```
Returns the date object for the specified month, day, year, hour, minute, and time zone, optionally throwing an exception if the date is invalid.

Parameters:

month - the month (0-based, meaning 0 for January)

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

timeZone - the time zone of the date

clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.

Returns:

the date object, or null if the date is invalid and no exception to throw was provided

Throws:

PortalException - if a portal exception occurred

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
```
Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid.

Parameters:

month - the month (0-based, meaning 0 for January)

day - the day of the month

year - the year

timeZone - the time zone of the date

clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.

Returns:

the date object, or null if the date is invalid and no exception to throw was provided

Throws:

PortalException - if a portal exception occurred

getDefaultCompanyId

public static long getDefaultCompanyId()

getDigestAuthUserId

@Deprecated
public static long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
                                            throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

HttpAuthManagerUtil.getDigestUserId(
             HttpServletRequest)

Throws:: PortalException

getEmailFromAddress

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

getEmailFromName

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

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getFacebookURL

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

Throws:: PortalException

getFirstPageLayoutTypes

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

getForwardedHost

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

getForwardedPort

public static int getForwardedPort(javax.servlet.http.HttpServletRequest request)

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

Throws:: PortalException

getGroupFriendlyURL

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

Throws:: PortalException

getGroupFriendlyURL

public static java.lang.String getGroupFriendlyURL(LayoutSet layoutSet,
                                                   ThemeDisplay themeDisplay,
                                                   java.util.Locale locale)
                                            throws PortalException

Throws:: PortalException

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

Throws:: PortalException

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

@Deprecated
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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: PortalException

getJournalArticleLayout

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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: PortalException

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

Throws:: PortalException

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

Throws:: PortalException

getLayoutFriendlyURL

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

Throws:: PortalException

getLayoutFriendlyURL

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

Throws:: PortalException

getLayoutFriendlyURL

public static java.lang.String getLayoutFriendlyURL(ThemeDisplay themeDisplay)
                                             throws PortalException

Throws:: PortalException

getLayoutFriendlyURLComposite

@Deprecated
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

Deprecated. As of Judson (7.1.x), replaced by

getLayoutFriendlyURLSeparatorComposite(long, boolean,
             String, Map, Map)

Throws:: PortalException

getLayoutFriendlyURLSeparatorComposite

public static LayoutFriendlyURLSeparatorComposite getLayoutFriendlyURLSeparatorComposite(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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutRelativeURL

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

Throws:: PortalException

getLayoutRelativeURL

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

Throws:: PortalException

getLayoutSetDisplayURL

public static java.lang.String getLayoutSetDisplayURL(LayoutSet layoutSet,
                                                      boolean secureConnection)
                                               throws PortalException

Throws:: PortalException

getLayoutSetFriendlyURL

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

Throws:: PortalException

getLayoutTarget

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

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

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)

getNetvibesURL

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

Throws:: PortalException

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)

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

Throws:: PortalException

getPlidFromPortletId

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

Throws:: PortalException

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

getPortalInetSocketAddressEventListeners

public static PortalInetSocketAddressEventListener[] getPortalInetSocketAddressEventListeners()

getPortalLibDir

public static java.lang.String getPortalLibDir()

getPortalLocalInetAddress

public static java.net.InetAddress getPortalLocalInetAddress(boolean secure)

getPortalLocalPort

public static int getPortalLocalPort(boolean secure)

getPortalPort
```
@Deprecated
public static int getPortalPort(boolean secure)
```
Deprecated. As of Wilberforce (7.0.x), replaced by getPortalServerPort(boolean)

getPortalProperties

public static java.util.Properties getPortalProperties()

getPortalServerInetAddress

public static java.net.InetAddress getPortalServerInetAddress(boolean secure)

getPortalServerPort

public static int getPortalServerPort(boolean secure)

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

Throws:: PortalException

getPortalURL

public static java.lang.String getPortalURL(LayoutSet layoutSet,
                                            ThemeDisplay themeDisplay)

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

Throws:: PortalException

getPortalWebDir

public static java.lang.String getPortalWebDir()

getPortletBreadcrumbs
```
@Deprecated
public static java.util.List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
```
Deprecated. As of Wilberforce (7.0.x), replaced by BreadcrumbUtil.getPortletBreadcrumbEntries( HttpServletRequest)

getPortletConfig

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

Throws:: javax.portlet.PortletException

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.PortletRequest portletRequest)

getPortletTitle

public static java.lang.String getPortletTitle(javax.portlet.PortletResponse portletResponse)

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.util.ResourceBundle resourceBundle)

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()

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

Throws:: PortalException

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.util.Locale locale)

getScopeGroupId

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

Throws:: PortalException

getScopeGroupId

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

Throws:: PortalException

getScopeGroupId

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

Throws:: PortalException

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

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getServletContextName

public static java.lang.String getServletContextName()

getSharedContentSiteGroupIds

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

Throws:: PortalException

getSiteAdministrationURL

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

Deprecated. As of Wilberforce (7.0.x), replaced by

#getControlPanelPortletURL(PortletRequest, Group, String,
             long, String)

getSiteAdministrationURL

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

Deprecated. As of Wilberforce (7.0.x), replaced by

#getControlPanelPortletURL(PortletRequest, Group, String,
             long, String)

getSiteAdminURL

@Deprecated
public static java.lang.String getSiteAdminURL(Company company,
                                                           Group group,
                                                           java.lang.String ppid,
                                                           java.util.Map<java.lang.String,java.lang.String[]> params)
                                                    throws PortalException

Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)

Throws:: PortalException

getSiteAdminURL

@Deprecated
public static java.lang.String getSiteAdminURL(Group group,
                                                           java.lang.String ppid,
                                                           java.util.Map<java.lang.String,java.lang.String[]> params)
                                                    throws PortalException

Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)

Throws:: PortalException

getSiteAdminURL

public static java.lang.String getSiteAdminURL(ThemeDisplay themeDisplay,
                                               java.lang.String ppid,
                                               java.util.Map<java.lang.String,java.lang.String[]> params)
                                        throws PortalException

Throws:: PortalException

getSiteAndCompanyGroupIds

@Deprecated
public static long[] getSiteAndCompanyGroupIds(long groupId)
                                                    throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Throws:: PortalException

getSiteAndCompanyGroupIds

@Deprecated
public static long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
                                                    throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Throws:: PortalException

getSiteDefaultLocale

public static java.util.Locale getSiteDefaultLocale(Group group)
                                             throws PortalException

Throws:: PortalException

getSiteDefaultLocale

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

Throws:: PortalException

getSiteGroupId

public static long getSiteGroupId(long scopeGroupId)

getSiteLoginURL

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

Throws:: PortalException

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

Throws:: PortalException

getUser

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

Throws:: PortalException

getUserEmailAddress

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

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

@Deprecated
public static java.lang.String getUserValue(long userId,
                                                        java.lang.String param,
                                                        java.lang.String defaultValue)

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

getValidPortalDomain

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

getValidUserId

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

Throws:: PortalException

getVirtualHostname

public static java.lang.String getVirtualHostname(LayoutSet layoutSet)

getVirtualLayoutActualURL

@Deprecated
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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: PortalException

getVirtualLayoutFriendlyURLComposite

@Deprecated
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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: PortalException

getWidgetURL

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

Throws:: PortalException

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

initUser

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

Throws:: java.lang.Exception

invokeTaglibDiscussion

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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: java.lang.Exception

invokeTaglibDiscussionPagination

@Deprecated
public static void invokeTaglibDiscussionPagination(javax.portlet.PortletConfig portletConfig,
                                                                javax.portlet.ResourceRequest resourceRequest,
                                                                javax.portlet.ResourceResponse resourceResponse)
                                                         throws java.io.IOException,
                                                                javax.portlet.PortletException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

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

isCDNDynamicResourcesEnabled

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

Throws:: PortalException

isCDNDynamicResourcesEnabled

public static boolean isCDNDynamicResourcesEnabled(long companyId)

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

Throws:: PortalException

isCompanyControlPanelPortlet

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

Throws:: PortalException

isControlPanelPortlet

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

isControlPanelPortlet

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

isCustomPortletMode

public static boolean isCustomPortletMode(javax.portlet.PortletMode portletMode)

isForwardedSecure

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

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

Throws:: PortalException

isLayoutSitemapable

public static boolean isLayoutSitemapable(Layout layout)

isLoginRedirectRequired

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

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)

isOmniadmin

public static boolean isOmniadmin(User user)

isReservedParameter

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

isRightToLeft

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

isRSSFeedsEnabled

public static boolean isRSSFeedsEnabled()

isSecure

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

isSkipPortletContentProcesssing

public static boolean isSkipPortletContentProcesssing(Group group,
                                                      javax.servlet.http.HttpServletRequest httpServletRequest,
                                                      LayoutTypePortlet layoutTypePortlet,
                                                      PortletDisplay portletDisplay,
                                                      java.lang.String portletName)
                                               throws java.lang.Exception

Throws:: java.lang.Exception

isSkipPortletContentRendering

public static boolean isSkipPortletContentRendering(Group group,
                                                    LayoutTypePortlet layoutTypePortlet,
                                                    PortletDisplay portletDisplay,
                                                    java.lang.String portletName)

isSystemGroup

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

isSystemRole

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

isUpdateAvailable

public static boolean isUpdateAvailable()

isValidResourceId

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

removePortalEventListener

public static boolean removePortalEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

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

resetPortletParameters

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

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.

setPortalInetSocketAddresses

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

setPortalPort
```
@Deprecated
public static void setPortalPort(javax.servlet.http.HttpServletRequest request)
```
Deprecated. As of Wilberforce (7.0.x), replaced by setPortalInetSocketAddresses(HttpServletRequest)

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)

updateImageId

public static void updateImageId(BaseModel<?> baseModel,
                                 boolean hasImage,
                                 byte[] bytes,
                                 java.lang.String fieldName,
                                 long maxSize,
                                 int maxHeight,
                                 int maxWidth)
                          throws PortalException

Throws:: PortalException

updatePortletMode

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

Throws:: PortalException

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
```
@Deprecated
public void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
```
Deprecated. As of Wilberforce (7.0.x), replaced by removePortalEventListener( PortalInetSocketAddressEventListener)

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

addPortalInetSocketAddressEventListener

addPortalPortEventListener

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletDefaultResource

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

addPreservedParameters

addUserLocaleOptionsMessage

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getAbsoluteURL

getActualLayoutQueryStringComposite

getActualURL

getAlternateURL

getAlternateURLs

getAncestorSiteGroupIds

getBaseModel

getBaseModel

getBasicAuthUserId

getBasicAuthUserId

getBrowsableScopeGroups

getCanonicalURL

getCanonicalURL

getCanonicalURL

getCDNHost

getCDNHost

getCDNHostHttp

getCDNHostHttps

getClassName

getClassNameId

getClassNameId

getCompany

getCompany

getCompanyId

getCompanyId

getCompanyIds

getComputerAddresses

getComputerName

getControlPanelFullURL

getControlPanelPlid

getControlPanelPlid

getControlPanelPortletURL

getControlPanelPortletURL

getControlPanelPortletURL

getControlPanelPortletURL

getCreateAccountURL

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentCompleteURL

getCurrentURL

getCurrentURL

getCustomSQLFunctionIsNotNull

getCustomSQLFunctionIsNull

getDate

getDate

getDate

getDate

getDate