Portal

```
@ProviderType
public interface Portal
```
Author:

Brian Wing Shun Chan, Eduardo Lundgren, Marco Leo

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`FRIENDLY_URL_SEPARATOR`
`static java.lang.String`	`JSESSIONID`
`static java.lang.String`	`PATH_IMAGE`
`static java.lang.String`	`PATH_MAIN`
`static java.lang.String`	`PATH_MODULE`
`static java.lang.String`	`PATH_PORTAL_LAYOUT`
`static java.lang.String`	`PORTAL_REALM`
`static java.lang.String`	`PORTLET_XML_FILE_NAME_CUSTOM`
`static java.lang.String`	`PORTLET_XML_FILE_NAME_STANDARD`
`static java.lang.String`	`TEMP_OBFUSCATION_VALUE`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest httpServletRequest)` Appends the description to the current meta description of the page.
`void`	`addPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest httpServletRequest)` Appends the keywords to the current meta keywords of the page.
`void`	`addPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest httpServletRequest)` Appends the subtitle to the current subtitle of the page.
`void`	`addPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest httpServletRequest)` Appends the title to the current title of the page.
`boolean`	`addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String title, java.lang.String url)` Adds an entry to the portlet breadcrumbs for the page.
`void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, 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.
`void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, 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.
`void`	`addPortletDefaultResource(javax.servlet.http.HttpServletRequest httpServletRequest, Portlet portlet)` Adds the default resource permissions for the portlet to the page.
`void`	`addPortletDefaultResource(long companyId, Layout layout, Portlet portlet)`
`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.
`java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url)` Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, and refererPlid to the URL.
`java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url, boolean typeControlPanel, boolean doAsUser)`
`void`	`addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest httpServletRequest)` Deprecated. As of Athanasius (7.3.x), with no direct replacement
`void`	`clearRequestParameters(javax.portlet.RenderRequest renderRequest)` Clears the render parameters in the request if the portlet is in the action phase.
`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.
`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.
`java.lang.String`	`generateRandomKey(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String input)` Generates a random key to identify the request based on the input string.
`java.lang.String`	`getAbsoluteURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String url)`
`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)`
`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)`
`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.
`java.util.Map<java.util.Locale,java.lang.String>`	`getAlternateURLs(java.lang.String canonicalURL, ThemeDisplay themeDisplay, Layout layout)`
`long[]`	`getAncestorSiteGroupIds(long groupId)`
`BaseModel<?>`	`getBaseModel(ResourcePermission resourcePermission)` Returns the base model instance for the resource permission.
`BaseModel<?>`	`getBaseModel(java.lang.String modelName, java.lang.String primKey)` Returns the base model instance for the model name and primary key.
`java.util.List<Group>`	`getBrowsableScopeGroups(long userId, long companyId, long groupId, java.lang.String portletId)`
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout)` Returns the canonical URL of the page, to distinguish it among its translations.
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL)` Returns the canonical URL of the page, to distinguish it among its translations.
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL, boolean includeQueryString)` Returns the canonical URL of the page.
`java.lang.String`	`getCDNHost(boolean secure)` Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.
`java.lang.String`	`getCDNHost(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getCDNHostHttp(long companyId)` Returns the insecure (HTTP) content distribution network (CDN) host address
`java.lang.String`	`getCDNHostHttps(long companyId)` Returns the secure (HTTPS) content distribution network (CDN) host address
`java.lang.String`	`getClassName(long classNameId)` Returns the fully qualified name of the class from its ID.
`long`	`getClassNameId(java.lang.Class<?> clazz)` Returns the ID of the class from its class object.
`long`	`getClassNameId(java.lang.String value)` Returns the ID of the class from its fully qualified name.
`Company`	`getCompany(javax.servlet.http.HttpServletRequest httpServletRequest)`
`Company`	`getCompany(javax.portlet.PortletRequest portletRequest)`
`long`	`getCompanyId(javax.servlet.http.HttpServletRequest httpServletRequest)`
`long`	`getCompanyId(javax.portlet.PortletRequest portletRequest)`
`long[]`	`getCompanyIds()`
`java.util.Set<java.lang.String>`	`getComputerAddresses()`
`java.lang.String`	`getComputerName()`
`java.lang.String`	`getControlPanelFullURL(long scopeGroupId, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`long`	`getControlPanelPlid(long companyId)`
`long`	`getControlPanelPlid(javax.portlet.PortletRequest portletRequest)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, java.lang.String portletId, java.lang.String lifecycle)`
`java.lang.String`	`getCreateAccountURL(javax.servlet.http.HttpServletRequest httpServletRequest, ThemeDisplay themeDisplay)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`java.lang.String`	`getCurrentCompleteURL(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getCurrentURL(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getCurrentURL(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getCustomSQLFunctionIsNotNull()`
`java.lang.String`	`getCustomSQLFunctionIsNull()`
`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.
`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.
`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.
`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.
`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.
`long`	`getDefaultCompanyId()`
`java.lang.String`	`getEmailFromAddress(javax.portlet.PortletPreferences preferences, long companyId, java.lang.String defaultValue)`
`java.lang.String`	`getEmailFromName(javax.portlet.PortletPreferences preferences, long companyId, java.lang.String defaultValue)`
`java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.portlet.PortletRequest portletRequest)`
`java.util.Map<java.lang.String,java.io.Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, UploadPortletRequest uploadPortletRequest)`
`java.io.Serializable`	`getExpandoValue(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String name, int type, java.lang.String displayType)`
`java.io.Serializable`	`getExpandoValue(javax.portlet.PortletRequest portletRequest, java.lang.String name, int type, java.lang.String displayType)`
`java.io.Serializable`	`getExpandoValue(UploadPortletRequest uploadPortletRequest, java.lang.String name, int type, java.lang.String displayType)`
`java.lang.String`	`getFirstPageLayoutTypes(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getForwardedHost(javax.servlet.http.HttpServletRequest httpServletRequest)`
`int`	`getForwardedPort(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getFullName(java.lang.String firstName, java.lang.String middleName, java.lang.String lastName)`
`java.lang.String`	`getGlobalLibDir()`
`java.lang.String`	`getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, java.util.Locale locale)`
`int[]`	`getGroupFriendlyURLIndex(java.lang.String requestURI)`
`java.lang.String`	`getHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getHost(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getHost(javax.portlet.PortletRequest portletRequest)`
`javax.servlet.http.HttpServletRequest`	`getHttpServletRequest(javax.portlet.PortletRequest portletRequest)`
`javax.servlet.http.HttpServletResponse`	`getHttpServletResponse(javax.portlet.PortletResponse portletResponse)`
`java.lang.String`	`getI18nPathLanguageId(java.util.Locale locale, java.lang.String defaultI18nPathLanguageId)`
`java.lang.String`	`getJsSafePortletId(java.lang.String portletId)`
`java.lang.String`	`getLayoutActualURL(Layout layout)`
`java.lang.String`	`getLayoutActualURL(Layout layout, java.lang.String mainPath)`
`java.lang.String`	`getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL)`
`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)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`java.lang.String`	`getLayoutFriendlyURL(ThemeDisplay themeDisplay)`
`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)`
`java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId)`
`java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId, boolean secure)`
`java.lang.String`	`getLayoutFullURL(ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutSetDisplayURL(LayoutSet layoutSet, boolean secureConnection)`
`java.lang.String`	`getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutTarget(Layout layout)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`java.lang.String`	`getLayoutURL(ThemeDisplay themeDisplay)`
`LiferayPortletRequest`	`getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)`
`LiferayPortletResponse`	`getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)`
`java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, boolean initialize)`
`java.util.Locale`	`getLocale(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest httpServletRequest, Layout layout, java.util.Locale locale, java.util.Locale originalLocale)`
`java.lang.String`	`getMailId(java.lang.String mx, java.lang.String popPortletPrefix, java.lang.Object... ids)`
`java.lang.String`	`getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getNewPortletTitle(java.lang.String portletTitle, java.lang.String oldScopeName, java.lang.String newScopeName)`
`javax.servlet.http.HttpServletRequest`	`getOriginalServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getPathContext()`
`java.lang.String`	`getPathContext(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getPathContext(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPathContext(java.lang.String contextPath)`
`java.lang.String`	`getPathFriendlyURLPrivateGroup()`
`java.lang.String`	`getPathFriendlyURLPrivateUser()`
`java.lang.String`	`getPathFriendlyURLPublic()`
`java.lang.String`	`getPathImage()`
`java.lang.String`	`getPathMain()`
`java.lang.String`	`getPathModule()`
`java.lang.String`	`getPathProxy()`
`long`	`getPlidFromFriendlyURL(long companyId, java.lang.String friendlyURL)`
`long`	`getPlidFromPortletId(long groupId, boolean privateLayout, java.lang.String portletId)`
`long`	`getPlidFromPortletId(long groupId, java.lang.String portletId)`
`PortalInetSocketAddressEventListener[]`	`getPortalInetSocketAddressEventListeners()`
`java.lang.String`	`getPortalLibDir()`
`java.net.InetAddress`	`getPortalLocalInetAddress(boolean secure)`
`int`	`getPortalLocalPort(boolean secure)`
`java.util.Properties`	`getPortalProperties()`
`java.net.InetAddress`	`getPortalServerInetAddress(boolean secure)`
`int`	`getPortalServerPort(boolean secure)`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest httpServletRequest, boolean secure)`
`java.lang.String`	`getPortalURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest, boolean secure)`
`java.lang.String`	`getPortalURL(java.lang.String serverName, int serverPort, boolean secure)`
`java.lang.String`	`getPortalURL(ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalWebDir()`
`javax.portlet.PortletConfig`	`getPortletConfig(long companyId, java.lang.String portletId, javax.servlet.ServletContext servletContext)`
`java.lang.String`	`getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`java.lang.String`	`getPortletDescription(Portlet portlet, User user)`
`java.lang.String`	`getPortletDescription(java.lang.String portletId, java.util.Locale locale)`
`java.lang.String`	`getPortletDescription(java.lang.String portletId, java.lang.String languageId)`
`java.lang.String`	`getPortletDescription(java.lang.String portletId, User user)`
`java.lang.String`	`getPortletId(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getPortletId(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPortletLongTitle(Portlet portlet, java.util.Locale locale)`
`java.lang.String`	`getPortletLongTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`java.lang.String`	`getPortletLongTitle(Portlet portlet, java.lang.String languageId)`
`java.lang.String`	`getPortletLongTitle(Portlet portlet, User user)`
`java.lang.String`	`getPortletLongTitle(java.lang.String portletId, java.util.Locale locale)`
`java.lang.String`	`getPortletLongTitle(java.lang.String portletId, java.lang.String languageId)`
`java.lang.String`	`getPortletLongTitle(java.lang.String portletId, User user)`
`java.lang.String`	`getPortletNamespace(java.lang.String portletId)`
`java.lang.String`	`getPortletTitle(Portlet portlet, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPortletTitle(javax.portlet.PortletResponse portletResponse)`
`java.lang.String`	`getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(Portlet portlet, java.lang.String languageId)`
`java.lang.String`	`getPortletTitle(Portlet portlet, User user)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.ResourceBundle resourceBundle)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.lang.String languageId)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, User user)`
`java.lang.String`	`getPortletXmlFileName()`
`javax.portlet.PortletPreferences`	`getPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)`
`javax.portlet.PreferencesValidator`	`getPreferencesValidator(Portlet portlet)`
`java.lang.String`	`getRelativeHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.util.ResourceBundle`	`getResourceBundle(java.util.Locale locale)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String portletId, boolean checkStagingGroup)`
`long`	`getScopeGroupId(Layout layout)`
`long`	`getScopeGroupId(Layout layout, java.lang.String portletId)`
`long`	`getScopeGroupId(long plid)`
`long`	`getScopeGroupId(javax.portlet.PortletRequest portletRequest)`
`User`	`getSelectedUser(javax.servlet.http.HttpServletRequest httpServletRequest)`
`User`	`getSelectedUser(javax.servlet.http.HttpServletRequest httpServletRequest, boolean checkPermission)`
`User`	`getSelectedUser(javax.portlet.PortletRequest portletRequest)`
`User`	`getSelectedUser(javax.portlet.PortletRequest portletRequest, boolean checkPermission)`
`java.lang.String`	`getServletContextName()`
`long[]`	`getSharedContentSiteGroupIds(long companyId, long groupId, long userId)`
`java.lang.String`	`getSiteAdminURL(java.lang.String portalURL, Group group, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`java.lang.String`	`getSiteAdminURL(ThemeDisplay themeDisplay, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`java.util.Locale`	`getSiteDefaultLocale(Group group)`
`java.util.Locale`	`getSiteDefaultLocale(long groupId)`
`long`	`getSiteGroupId(long groupId)`
`java.lang.String`	`getSiteLoginURL(ThemeDisplay themeDisplay)` Returns the URL of the login page for the current site if one is available.
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String uri)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String uri, long timestamp)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String uri, java.lang.String queryString)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String uri, java.lang.String queryString, long timestamp)`
`java.lang.String`	`getStrutsAction(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String[]`	`getSystemGroups()`
`java.lang.String[]`	`getSystemOrganizationRoles()`
`java.lang.String[]`	`getSystemRoles()`
`java.lang.String[]`	`getSystemSiteRoles()`
`java.lang.String`	`getUniqueElementId(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String namespace, java.lang.String id)`
`java.lang.String`	`getUniqueElementId(javax.portlet.PortletRequest request, java.lang.String namespace, java.lang.String id)`
`UploadPortletRequest`	`getUploadPortletRequest(javax.portlet.PortletRequest portletRequest)`
`UploadServletRequest`	`getUploadServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)`
`UploadServletRequest`	`getUploadServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest, int fileSizeThreshold, java.lang.String location, long maxRequestSize, long maxFileSize)`
`java.util.Date`	`getUptime()`
`java.lang.String`	`getURLWithSessionId(java.lang.String url, java.lang.String sessionId)`
`User`	`getUser(javax.servlet.http.HttpServletRequest httpServletRequest)`
`User`	`getUser(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getUserEmailAddress(long userId)`
`long`	`getUserId(javax.servlet.http.HttpServletRequest httpServletRequest)`
`long`	`getUserId(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getUserName(BaseModel<?> baseModel)`
`java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName)`
`java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute)`
`java.lang.String`	`getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute, javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getUserPassword(javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`getUserPassword(javax.servlet.http.HttpSession session)`
`java.lang.String`	`getUserPassword(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getValidPortalDomain(long companyId, java.lang.String domain)`
`long`	`getValidUserId(long companyId, long userId)`
`java.lang.String`	`getVirtualHostname(LayoutSet layoutSet)` Deprecated. As of Mueller (7.2.x), replaced by `getVirtualHostnames(LayoutSet)`
`java.util.TreeMap<java.lang.String,java.lang.String>`	`getVirtualHostnames(LayoutSet layoutSet)`
`java.lang.String`	`getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`void`	`initCustomSQL()`
`User`	`initUser(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isCDNDynamicResourcesEnabled(long companyId)`
`boolean`	`isCompanyAdmin(User user)`
`boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`boolean`	`isCustomPortletMode(javax.portlet.PortletMode portletMode)`
`boolean`	`isForwardedSecure(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isGroupAdmin(User user, long groupId)`
`boolean`	`isGroupControlPanelPath(java.lang.String path)`
`boolean`	`isGroupFriendlyURL(java.lang.String fullURL, java.lang.String groupFriendlyURL, java.lang.String layoutFriendlyURL)`
`boolean`	`isGroupOwner(User user, long groupId)`
`boolean`	`isLayoutDescendant(Layout layout, long layoutId)`
`boolean`	`isLayoutSitemapable(Layout layout)`
`boolean`	`isLoginRedirectRequired(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isMethodGet(javax.portlet.PortletRequest portletRequest)`
`boolean`	`isMethodPost(javax.portlet.PortletRequest portletRequest)`
`boolean`	`isMultipartRequest(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isOmniadmin(long userId)`
`boolean`	`isOmniadmin(User user)`
`boolean`	`isReservedParameter(java.lang.String name)`
`boolean`	`isRightToLeft(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isRSSFeedsEnabled()`
`boolean`	`isSecure(javax.servlet.http.HttpServletRequest httpServletRequest)`
`boolean`	`isSkipPortletContentRendering(Group group, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, java.lang.String portletName)`
`boolean`	`isSystemGroup(java.lang.String groupName)`
`boolean`	`isSystemRole(java.lang.String roleName)`
`boolean`	`isUpdateAvailable()`
`boolean`	`isValidResourceId(java.lang.String resourceId)`
`boolean`	`removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`void`	`resetCDNHosts()`
`java.lang.String`	`resetPortletParameters(java.lang.String url, java.lang.String portletId)`
`void`	`sendError(java.lang.Exception exception, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`void`	`sendError(java.lang.Exception exception, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)`
`void`	`sendError(int status, java.lang.Exception exception, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`void`	`sendError(int status, java.lang.Exception exception, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)`
`void`	`sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse)`
`void`	`sendRSSFeedsDisabledError(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)`
`void`	`setPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest httpServletRequest)` Sets the description for the page, overriding the existing page description.
`void`	`setPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest httpServletRequest)` Sets the keywords for the page, overriding the existing page keywords.
`void`	`setPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest httpServletRequest)` Sets the subtitle for the page, overriding the existing page subtitle.
`void`	`setPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest httpServletRequest)` Sets the whole title for the page, overriding the existing page whole title.
`void`	`setPortalInetSocketAddresses(javax.servlet.http.HttpServletRequest httpServletRequest)`
`void`	`storePreferences(javax.portlet.PortletPreferences portletPreferences)`
`java.lang.String[]`	`stripURLAnchor(java.lang.String url, java.lang.String separator)`
`java.lang.String`	`transformCustomSQL(java.lang.String sql)`
`java.lang.String`	`transformSQL(java.lang.String sql)`
`void`	`updateImageId(BaseModel<?> baseModel, boolean image, byte[] bytes, java.lang.String fieldName, long maxSize, int maxHeight, int maxWidth)`
`javax.portlet.PortletMode`	`updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest httpServletRequest)`
`java.lang.String`	`updateRedirect(java.lang.String redirect, java.lang.String oldPath, java.lang.String newPath)`
`javax.portlet.WindowState`	`updateWindowState(java.lang.String portletId, User user, Layout layout, javax.portlet.WindowState windowState, javax.servlet.http.HttpServletRequest httpServletRequest)`

Field Detail
- FRIENDLY_URL_SEPARATOR
```
static final java.lang.String FRIENDLY_URL_SEPARATOR
```
  See Also:
  
  Constant Field Values
- JSESSIONID
```
static final java.lang.String JSESSIONID
```
  See Also:
  
  Constant Field Values
- PATH_IMAGE
```
static final java.lang.String PATH_IMAGE
```
  See Also:
  
  Constant Field Values
- PATH_MAIN
```
static final java.lang.String PATH_MAIN
```
  See Also:
  
  Constant Field Values
- PATH_MODULE
```
static final java.lang.String PATH_MODULE
```
  See Also:
  
  Constant Field Values
- PATH_PORTAL_LAYOUT
```
static final java.lang.String PATH_PORTAL_LAYOUT
```
  See Also:
  
  Constant Field Values
- PORTAL_REALM
```
static final java.lang.String PORTAL_REALM
```
  See Also:
  
  Constant Field Values
- PORTLET_XML_FILE_NAME_CUSTOM
```
static final java.lang.String PORTLET_XML_FILE_NAME_CUSTOM
```
  See Also:
  
  Constant Field Values
- PORTLET_XML_FILE_NAME_STANDARD
```
static final java.lang.String PORTLET_XML_FILE_NAME_STANDARD
```
  See Also:
  
  Constant Field Values
- TEMP_OBFUSCATION_VALUE
```
static final java.lang.String TEMP_OBFUSCATION_VALUE
```
  See Also:
  
  Constant Field Values

Method Detail

addPageDescription
```
void addPageDescription(java.lang.String description,
                        javax.servlet.http.HttpServletRequest httpServletRequest)
```
Appends the description to the current meta description of the page.

Parameters:

description - the description to append to the current meta description

httpServletRequest - the servlet request for the page

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

Parameters:

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

httpServletRequest - the servlet request for the page

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

Parameters:

subtitle - the subtitle to append to the current subtitle

httpServletRequest - the servlet request for the page

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

Parameters:

title - the title to append to the current title

httpServletRequest - the servlet request for the page

addPortalInetSocketAddressEventListener

boolean addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

addPortletBreadcrumbEntry
```
void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest,
                               java.lang.String title,
                               java.lang.String url)
```
Adds an entry to the portlet breadcrumbs for the page.

Parameters:

httpServletRequest - the servlet request for the page

title - the title of the new breakcrumb entry

url - the URL of the new breadcrumb entry

addPortletBreadcrumbEntry

void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest,
                               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.

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

addPortletBreadcrumbEntry
```
void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest,
                               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.

Parameters:

httpServletRequest - the servlet request for the page

title - the title of the new breakcrumb 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
```
void addPortletDefaultResource(javax.servlet.http.HttpServletRequest httpServletRequest,
                               Portlet portlet)
                        throws PortalException
```
Adds the default resource permissions for the portlet to the page.

Parameters:

httpServletRequest - the servlet request for the page

portlet - the portlet

Throws:

PortalException - if a portal exception occurred

addPortletDefaultResource

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

Throws:: PortalException

addPreservedParameters
```
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 layout

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
```
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

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

addUserLocaleOptionsMessage

@Deprecated
void addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest httpServletRequest)

Deprecated. As of Athanasius (7.3.x), with no direct replacement

clearRequestParameters
```
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
```
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
```
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 an allowed for redirects

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

Parameters:

httpServletRequest - the servlet request for the page

input - the input string

Returns:

the generated key

getAbsoluteURL

java.lang.String getAbsoluteURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                java.lang.String url)

getActualLayoutQueryStringComposite

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

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
```
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 (translated) page

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

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

Throws:: PortalException

getAncestorSiteGroupIds

long[] getAncestorSiteGroupIds(long groupId)

getBaseModel
```
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 its a portlet)

Throws:

PortalException - if a portal exception occurred

getBaseModel
```
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 its a portlet)

Throws:

PortalException - if a portal exception occurred

getBrowsableScopeGroups

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

Throws:: PortalException

getCanonicalURL
```
java.lang.String getCanonicalURL(java.lang.String completeURL,
                                 ThemeDisplay themeDisplay,
                                 Layout layout)
                          throws PortalException
```
Returns the canonical URL of the page, to distinguish it among its translations.

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
java.lang.String getCanonicalURL(java.lang.String completeURL,
                                 ThemeDisplay themeDisplay,
                                 Layout layout,
                                 boolean forceLayoutFriendlyURL)
                          throws PortalException
```
Returns the canonical URL of the page, to distinguish it among its translations.

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

forceLayoutFriendlyURL - adds the page friendly URL to the canonical URL even if it is not needed

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
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
```
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 or insecure CDN host address

Returns:

the CDN host address

getCDNHost

java.lang.String getCDNHost(javax.servlet.http.HttpServletRequest httpServletRequest)
                     throws PortalException

Throws:: PortalException

getCDNHostHttp
```
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
```
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
```
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
```
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
```
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

Company getCompany(javax.servlet.http.HttpServletRequest httpServletRequest)
            throws PortalException

Throws:: PortalException

getCompany

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

Throws:: PortalException

getCompanyId

long getCompanyId(javax.servlet.http.HttpServletRequest httpServletRequest)

getCompanyId

long getCompanyId(javax.portlet.PortletRequest portletRequest)

getCompanyIds
```
long[] getCompanyIds()
```

getComputerAddresses

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

getComputerName
```
java.lang.String getComputerName()
```

getControlPanelFullURL

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

long getControlPanelPlid(long companyId)
                  throws PortalException

Throws:: PortalException

getControlPanelPlid

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

Throws:: PortalException

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getControlPanelPortletURL

javax.portlet.PortletURL getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest,
                                                   java.lang.String portletId,
                                                   java.lang.String lifecycle)

getCreateAccountURL

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

Throws:: java.lang.Exception

getCurrentAndAncestorSiteGroupIds

long[] getCurrentAndAncestorSiteGroupIds(long groupId)
                                  throws PortalException

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Throws:: PortalException

getCurrentCompleteURL

java.lang.String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest httpServletRequest)

getCurrentURL

java.lang.String getCurrentURL(javax.servlet.http.HttpServletRequest httpServletRequest)

getCurrentURL

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

getCustomSQLFunctionIsNotNull

java.lang.String getCustomSQLFunctionIsNotNull()

getCustomSQLFunctionIsNull

java.lang.String getCustomSQLFunctionIsNull()

getDate
```
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
```
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
```
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
```
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
```
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
```
long getDefaultCompanyId()
```

getEmailFromAddress

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

getEmailFromName

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

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoBridgeAttributes

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getExpandoValue

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

Throws:: PortalException

getFirstPageLayoutTypes

java.lang.String getFirstPageLayoutTypes(javax.servlet.http.HttpServletRequest httpServletRequest)

getForwardedHost

java.lang.String getForwardedHost(javax.servlet.http.HttpServletRequest httpServletRequest)

getForwardedPort

int getForwardedPort(javax.servlet.http.HttpServletRequest httpServletRequest)

getFullName

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

getGlobalLibDir
```
java.lang.String getGlobalLibDir()
```

getGoogleGadgetURL

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

Throws:: PortalException

getGroupFriendlyURL

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

Throws:: PortalException

getGroupFriendlyURL

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

Throws:: PortalException

getGroupFriendlyURLIndex

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

getHomeURL

java.lang.String getHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                     throws PortalException

Throws:: PortalException

getHost

java.lang.String getHost(javax.servlet.http.HttpServletRequest httpServletRequest)

getHost

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

getHttpServletRequest

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

getHttpServletResponse

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

getI18nPathLanguageId

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

getJsSafePortletId

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

getLayoutActualURL

java.lang.String getLayoutActualURL(Layout layout)

getLayoutActualURL

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

getLayoutActualURL

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

Throws:: PortalException

getLayoutActualURL

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

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

Throws:: PortalException

getLayoutFriendlyURL

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

Throws:: PortalException

getLayoutFriendlyURL

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

Throws:: PortalException

getLayoutFriendlyURLSeparatorComposite

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

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutFullURL

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

Throws:: PortalException

getLayoutRelativeURL

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

Throws:: PortalException

getLayoutRelativeURL

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

Throws:: PortalException

getLayoutSetDisplayURL

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

Throws:: PortalException

getLayoutSetFriendlyURL

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

Throws:: PortalException

getLayoutTarget

java.lang.String getLayoutTarget(Layout layout)

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

getLayoutURL

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

Throws:: PortalException

getLiferayPortletRequest

LiferayPortletRequest getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)

getLiferayPortletResponse

LiferayPortletResponse getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)

getLocale

java.util.Locale getLocale(javax.servlet.http.HttpServletRequest httpServletRequest)

getLocale

java.util.Locale getLocale(javax.servlet.http.HttpServletRequest httpServletRequest,
                           javax.servlet.http.HttpServletResponse httpServletResponse,
                           boolean initialize)

getLocale

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

getLocalizedFriendlyURL

java.lang.String getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                         Layout layout,
                                         java.util.Locale locale,
                                         java.util.Locale originalLocale)

getMailId

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

getNetvibesURL

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

Throws:: PortalException

getNewPortletTitle

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

getOriginalServletRequest

javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

getPathContext
```
java.lang.String getPathContext()
```

getPathContext

java.lang.String getPathContext(javax.servlet.http.HttpServletRequest httpServletRequest)

getPathContext

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

getPathContext

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

getPathFriendlyURLPrivateGroup

java.lang.String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

java.lang.String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

java.lang.String getPathFriendlyURLPublic()

getPathImage
```
java.lang.String getPathImage()
```

getPathMain
```
java.lang.String getPathMain()
```

getPathModule
```
java.lang.String getPathModule()
```

getPathProxy
```
java.lang.String getPathProxy()
```

getPlidFromFriendlyURL

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

getPlidFromPortletId

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

Throws:: PortalException

getPlidFromPortletId

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

Throws:: PortalException

getPortalInetSocketAddressEventListeners

PortalInetSocketAddressEventListener[] getPortalInetSocketAddressEventListeners()

getPortalLibDir
```
java.lang.String getPortalLibDir()
```

getPortalLocalInetAddress

java.net.InetAddress getPortalLocalInetAddress(boolean secure)

getPortalLocalPort

int getPortalLocalPort(boolean secure)

getPortalProperties

java.util.Properties getPortalProperties()

getPortalServerInetAddress

java.net.InetAddress getPortalServerInetAddress(boolean secure)

getPortalServerPort

int getPortalServerPort(boolean secure)

getPortalURL

java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest httpServletRequest)

getPortalURL

java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                              boolean secure)

getPortalURL

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

Throws:: PortalException

getPortalURL

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

getPortalURL

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

getPortalURL

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

getPortalURL

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

getPortalURL

java.lang.String getPortalURL(ThemeDisplay themeDisplay)
                       throws PortalException

Throws:: PortalException

getPortalWebDir
```
java.lang.String getPortalWebDir()
```

getPortletConfig

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

Throws:: javax.portlet.PortletException

getPortletDescription

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

getPortletDescription

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

getPortletDescription

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

getPortletDescription

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

getPortletDescription

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

getPortletId

java.lang.String getPortletId(javax.servlet.http.HttpServletRequest httpServletRequest)

getPortletId

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletLongTitle

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

getPortletNamespace

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

getPortletTitle

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

getPortletTitle

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

getPortletTitle

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

getPortletTitle

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

getPortletTitle

java.lang.String getPortletTitle(javax.portlet.PortletRequest portletRequest)

getPortletTitle

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

getPortletTitle

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

getPortletTitle

java.lang.String getPortletTitle(java.lang.String portletId,
                                 java.util.ResourceBundle resourceBundle)

getPortletTitle

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

getPortletTitle

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

getPortletXmlFileName

java.lang.String getPortletXmlFileName()

getPreferences

javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getRelativeHomeURL

java.lang.String getRelativeHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest)
                             throws PortalException

Throws:: PortalException

getResourceBundle

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

getScopeGroupId

long getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest)
              throws PortalException

Throws:: PortalException

getScopeGroupId

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

Throws:: PortalException

getScopeGroupId

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

Throws:: PortalException

getScopeGroupId
```
long getScopeGroupId(Layout layout)
```

getScopeGroupId

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

getScopeGroupId
```
long getScopeGroupId(long plid)
```

getScopeGroupId

long getScopeGroupId(javax.portlet.PortletRequest portletRequest)
              throws PortalException

Throws:: PortalException

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest httpServletRequest)
              throws PortalException

Throws:: PortalException

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest httpServletRequest,
                     boolean checkPermission)
              throws PortalException

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getSelectedUser

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

Throws:: PortalException

getServletContextName

java.lang.String getServletContextName()

getSharedContentSiteGroupIds

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

Throws:: PortalException

getSiteAdminURL

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

Throws:: PortalException

getSiteAdminURL

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

Throws:: PortalException

getSiteDefaultLocale

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

Throws:: PortalException

getSiteDefaultLocale

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

Throws:: PortalException

getSiteGroupId
```
long getSiteGroupId(long groupId)
```

getSiteLoginURL
```
java.lang.String getSiteLoginURL(ThemeDisplay themeDisplay)
                          throws PortalException
```
Returns the URL of the login page for the current site if one is available.

Parameters:

themeDisplay - the theme display for the current page

Returns:

the URL of the login page for the current site, or null if one is not available

Throws:

PortalException - if a portal exception occurred

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                      java.lang.String uri)

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                      java.lang.String uri,
                                      long timestamp)

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest,
                                      java.lang.String uri,
                                      java.lang.String queryString)

getStaticResourceURL

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

getStrutsAction

java.lang.String getStrutsAction(javax.servlet.http.HttpServletRequest httpServletRequest)

getSystemGroups
```
java.lang.String[] getSystemGroups()
```

getSystemOrganizationRoles

java.lang.String[] getSystemOrganizationRoles()

getSystemRoles
```
java.lang.String[] getSystemRoles()
```

getSystemSiteRoles

java.lang.String[] getSystemSiteRoles()

getUniqueElementId

java.lang.String getUniqueElementId(javax.servlet.http.HttpServletRequest httpServletRequest,
                                    java.lang.String namespace,
                                    java.lang.String id)

getUniqueElementId

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

getUploadPortletRequest

UploadPortletRequest getUploadPortletRequest(javax.portlet.PortletRequest portletRequest)

getUploadServletRequest

UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

getUploadServletRequest

UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest,
                                             int fileSizeThreshold,
                                             java.lang.String location,
                                             long maxRequestSize,
                                             long maxFileSize)

getUptime
```
java.util.Date getUptime()
```

getURLWithSessionId

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

getUser

User getUser(javax.servlet.http.HttpServletRequest httpServletRequest)
      throws PortalException

Throws:: PortalException

getUser

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

Throws:: PortalException

getUserEmailAddress

java.lang.String getUserEmailAddress(long userId)

getUserId

long getUserId(javax.servlet.http.HttpServletRequest httpServletRequest)

getUserId

long getUserId(javax.portlet.PortletRequest portletRequest)

getUserName

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

getUserName

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

getUserName

java.lang.String getUserName(long userId,
                             java.lang.String defaultUserName,
                             javax.servlet.http.HttpServletRequest httpServletRequest)

getUserName

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

getUserName

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

getUserPassword

java.lang.String getUserPassword(javax.servlet.http.HttpServletRequest httpServletRequest)

getUserPassword

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

getUserPassword

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

getValidPortalDomain

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

getValidUserId

long getValidUserId(long companyId,
                    long userId)
             throws PortalException

Throws:: PortalException

getVirtualHostname
```
@Deprecated
java.lang.String getVirtualHostname(LayoutSet layoutSet)
```
Deprecated. As of Mueller (7.2.x), replaced by getVirtualHostnames(LayoutSet)

getVirtualHostnames

java.util.TreeMap<java.lang.String,java.lang.String> getVirtualHostnames(LayoutSet layoutSet)

getWidgetURL

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

Throws:: PortalException

initCustomSQL
```
void initCustomSQL()
```

initUser

User initUser(javax.servlet.http.HttpServletRequest httpServletRequest)
       throws java.lang.Exception

Throws:: java.lang.Exception

isCDNDynamicResourcesEnabled

boolean isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest httpServletRequest)
                              throws PortalException

Throws:: PortalException

isCDNDynamicResourcesEnabled

boolean isCDNDynamicResourcesEnabled(long companyId)

isCompanyAdmin

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

Throws:: java.lang.Exception

isCompanyControlPanelPortlet

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

Throws:: PortalException

isCompanyControlPanelPortlet

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

Throws:: PortalException

isControlPanelPortlet

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

isControlPanelPortlet

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

isCustomPortletMode

boolean isCustomPortletMode(javax.portlet.PortletMode portletMode)

isForwardedSecure

boolean isForwardedSecure(javax.servlet.http.HttpServletRequest httpServletRequest)

isGroupAdmin

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

Throws:: java.lang.Exception

isGroupControlPanelPath

boolean isGroupControlPanelPath(java.lang.String path)

isGroupFriendlyURL

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

isGroupOwner

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

Throws:: java.lang.Exception

isLayoutDescendant

boolean isLayoutDescendant(Layout layout,
                           long layoutId)
                    throws PortalException

Throws:: PortalException

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

isLoginRedirectRequired

boolean isLoginRedirectRequired(javax.servlet.http.HttpServletRequest httpServletRequest)

isMethodGet

boolean isMethodGet(javax.portlet.PortletRequest portletRequest)

isMethodPost

boolean isMethodPost(javax.portlet.PortletRequest portletRequest)

isMultipartRequest

boolean isMultipartRequest(javax.servlet.http.HttpServletRequest httpServletRequest)

isOmniadmin
```
boolean isOmniadmin(long userId)
```

isOmniadmin
```
boolean isOmniadmin(User user)
```

isReservedParameter

boolean isReservedParameter(java.lang.String name)

isRightToLeft

boolean isRightToLeft(javax.servlet.http.HttpServletRequest httpServletRequest)

isRSSFeedsEnabled
```
boolean isRSSFeedsEnabled()
```

isSecure

boolean isSecure(javax.servlet.http.HttpServletRequest httpServletRequest)

isSkipPortletContentRendering

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

isSystemGroup

boolean isSystemGroup(java.lang.String groupName)

isSystemRole

boolean isSystemRole(java.lang.String roleName)

isUpdateAvailable
```
boolean isUpdateAvailable()
```

isValidResourceId

boolean isValidResourceId(java.lang.String resourceId)

removePortalInetSocketAddressEventListener

boolean removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

resetCDNHosts
```
void resetCDNHosts()
```

resetPortletParameters

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

sendError

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

Throws:: java.io.IOException

sendError

void sendError(java.lang.Exception exception,
               javax.servlet.http.HttpServletRequest httpServletRequest,
               javax.servlet.http.HttpServletResponse httpServletResponse)
        throws java.io.IOException,
               javax.servlet.ServletException

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

sendError

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

Throws:: java.io.IOException

sendError

void sendError(int status,
               java.lang.Exception exception,
               javax.servlet.http.HttpServletRequest httpServletRequest,
               javax.servlet.http.HttpServletResponse httpServletResponse)
        throws java.io.IOException,
               javax.servlet.ServletException

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

sendRSSFeedsDisabledError

void sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest httpServletRequest,
                               javax.servlet.http.HttpServletResponse httpServletResponse)
                        throws java.io.IOException,
                               javax.servlet.ServletException

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

sendRSSFeedsDisabledError

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

void setPageDescription(java.lang.String description,
                        javax.servlet.http.HttpServletRequest httpServletRequest)

Sets the description for the page, overriding the existing page description.

setPageKeywords

void setPageKeywords(java.lang.String keywords,
                     javax.servlet.http.HttpServletRequest httpServletRequest)

Sets the keywords for the page, overriding the existing page keywords.

setPageSubtitle

void setPageSubtitle(java.lang.String subtitle,
                     javax.servlet.http.HttpServletRequest httpServletRequest)

Sets the subtitle for the page, overriding the existing page subtitle.

setPageTitle

void setPageTitle(java.lang.String title,
                  javax.servlet.http.HttpServletRequest httpServletRequest)

Sets the whole title for the page, overriding the existing page whole title.

setPortalInetSocketAddresses

void setPortalInetSocketAddresses(javax.servlet.http.HttpServletRequest httpServletRequest)

storePreferences

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

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

stripURLAnchor

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

transformCustomSQL

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

transformSQL

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

updateImageId

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

Throws:: PortalException

updatePortletMode

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

Throws:: PortalException

updateRedirect

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

updateWindowState

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

Interface Portal

Field Summary

Method Summary

Field Detail

FRIENDLY_URL_SEPARATOR

JSESSIONID

PATH_IMAGE

PATH_MAIN

PATH_MODULE

PATH_PORTAL_LAYOUT

PORTAL_REALM

PORTLET_XML_FILE_NAME_CUSTOM

PORTLET_XML_FILE_NAME_STANDARD

TEMP_OBFUSCATION_VALUE

Method Detail

addPageDescription

addPageKeywords

addPageSubtitle

addPageTitle

addPortalInetSocketAddressEventListener

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletDefaultResource

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

addPreservedParameters

addUserLocaleOptionsMessage

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getAbsoluteURL

getActualLayoutQueryStringComposite

getActualURL

getAlternateURL

getAlternateURLs

getAncestorSiteGroupIds

getBaseModel

getBaseModel

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