Portal

```
public interface Portal
```
Author:

Brian Wing Shun Chan, Eduardo Lundgren

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

Methods
Modifier and Type	Method and Description
`void`	`addPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest request)` Appends the description to the current meta description of the page.
`void`	`addPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest request)` Appends the keywords to the current meta keywords of the page.
`void`	`addPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request)` Appends the subtitle to the current subtitle of the page.
`void`	`addPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request)` Appends the title to the current title of the page.
`void`	`addPortalPortEventListener(PortalPortEventListener portalPortEventListener)` Adds the portal port event listener to the portal.
`void`	`addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)` Adds the portal port and protocol event listener to the portal.
`void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url)` Adds an entry to the portlet breadcrumbs for the page.
`void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an entry to the portlet breadcrumbs for the page.
`void`	`addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, 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, refererPlid, and controlPanelCategory to the URL.
`void`	`addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)`
`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 request, 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 request, 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.util.Locale[]`	`getAlternateLocales(javax.servlet.http.HttpServletRequest request)` Deprecated. As of 6.2.0, replaced by `LanguageUtil.getAvailableLocales()`
`java.lang.String`	`getAlternateURL(java.lang.String canonicalURL, ThemeDisplay themeDisplay, java.util.Locale locale, Layout layout)` Returns the alternate URL of the page, to distinguish it from its canonical URL.
`java.util.Set<java.lang.String>`	`getAuthTokenIgnoreActions()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions()`
`java.util.Set<java.lang.String>`	`getAuthTokenIgnorePortlets()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletCSRFWhitelist()`
`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.
`long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)` Returns the user's ID from the HTTP authentication headers after validating their credentials.
`long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)` Returns the user's ID from the HTTP authentication headers after validation their credentials.
`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`	`getCDNHost()` Deprecated. As of 6.2.0, replaced by the more general `getCDNHost(boolean)`
`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 request)`
`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.
`java.lang.String`	`getClassNamePortletId(java.lang.String className)` Returns the ID of certain portlets from the fully qualified name of one of their classes.
`Company`	`getCompany(javax.servlet.http.HttpServletRequest request)`
`Company`	`getCompany(javax.portlet.PortletRequest portletRequest)`
`long`	`getCompanyId(javax.servlet.http.HttpServletRequest requestuest)`
`long`	`getCompanyId(javax.portlet.PortletRequest portletRequest)`
`long[]`	`getCompanyIds()`
`java.lang.String`	`getComputerAddress()`
`java.lang.String`	`getComputerName()`
`java.util.Map<java.lang.String,java.util.List<Portlet>>`	`getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getControlPanelCategory(java.lang.String portletId, ThemeDisplay themeDisplay)`
`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)`
`java.util.Set<Portlet>`	`getControlPanelPortlets(long companyId, java.lang.String category)`
`java.util.List<Portlet>`	`getControlPanelPortlets(java.lang.String category, ThemeDisplay themeDisplay)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, long referrerPlid, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, java.lang.String portletId, long referrerPlid, java.lang.String lifecycle)`
`java.lang.String`	`getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`java.lang.String`	`getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getCurrentURL(javax.servlet.http.HttpServletRequest request)`
`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.
`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()`
`long`	`getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getDisplayURL(Group group, ThemeDisplay themeDisplay)`
`java.lang.String`	`getDisplayURL(Group group, ThemeDisplay themeDisplay, boolean privateLayout)`
`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 request)`
`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 request, 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`	`getFacebookURL(Portlet portlet, java.lang.String facebookCanvasPageURL, ThemeDisplay themeDisplay)`
`Portlet`	`getFirstMyAccountPortlet(ThemeDisplay themeDisplay)`
`java.lang.String`	`getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)`
`Portlet`	`getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)`
`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(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay, java.util.Locale locale)`
`int[]`	`getGroupFriendlyURLIndex(java.lang.String requestURI)`
`java.lang.String[]`	`getGroupPermissions(javax.servlet.http.HttpServletRequest request)`
`java.lang.String[]`	`getGroupPermissions(javax.servlet.http.HttpServletRequest request, java.lang.String className)`
`java.lang.String[]`	`getGroupPermissions(javax.portlet.PortletRequest portletRequest)`
`java.lang.String[]`	`getGroupPermissions(javax.portlet.PortletRequest portletRequest, java.lang.String className)`
`java.lang.String[]`	`getGuestPermissions(javax.servlet.http.HttpServletRequest request)`
`java.lang.String[]`	`getGuestPermissions(javax.servlet.http.HttpServletRequest request, java.lang.String className)`
`java.lang.String[]`	`getGuestPermissions(javax.portlet.PortletRequest portletRequest)`
`java.lang.String[]`	`getGuestPermissions(javax.portlet.PortletRequest portletRequest, java.lang.String className)`
`java.lang.String`	`getHomeURL(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getHost(javax.servlet.http.HttpServletRequest request)`
`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`	`getJournalArticleActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`Layout`	`getJournalArticleLayout(long groupId, boolean privateLayout, java.lang.String friendlyURL)`
`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`	`getLayoutEditPage(Layout layout)`
`java.lang.String`	`getLayoutEditPage(java.lang.String type)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`LayoutFriendlyURLComposite`	`getLayoutFriendlyURLComposite(long groupId, boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`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`	`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)`
`java.lang.String`	`getLayoutViewPage(Layout layout)`
`java.lang.String`	`getLayoutViewPage(java.lang.String type)`
`LiferayPortletRequest`	`getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)`
`LiferayPortletResponse`	`getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)`
`java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest request)`
`java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean initialize)`
`java.util.Locale`	`getLocale(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request, 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 request)`
`long`	`getParentGroupId(long scopeGroupId)` Deprecated. As of 6.2.0 renamed to `getSiteGroupId(long)`
`java.lang.String`	`getPathContext()`
`java.lang.String`	`getPathContext(javax.servlet.http.HttpServletRequest request)`
`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)`
`java.lang.String`	`getPortalLibDir()`
`int`	`getPortalPort()` Deprecated. As of 6.2.0, replaced by the more general `getPortalPort(boolean)`
`int`	`getPortalPort(boolean secure)`
`java.util.Properties`	`getPortalProperties()`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)`
`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()`
`java.util.Set<java.lang.String>`	`getPortletAddDefaultResourceCheckWhitelist()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletInvocationWhitelist()`
`java.util.Set<java.lang.String>`	`getPortletAddDefaultResourceCheckWhitelistActions()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions()`
`java.util.List<BreadcrumbEntry>`	`getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)` Deprecated. As of 6.2.0, replaced by `getPortletBreadcrumbs(HttpServletRequest)`
`java.util.List<BreadcrumbEntry>`	`getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)`
`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 request)`
`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(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(javax.portlet.RenderRequest renderRequest)`
`java.lang.String`	`getPortletTitle(javax.portlet.RenderResponse renderResponse)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.Locale locale)`
`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 request)`
`javax.portlet.PreferencesValidator`	`getPreferencesValidator(Portlet portlet)`
`java.lang.String`	`getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)`
`long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request, 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 request)`
`User`	`getSelectedUser(javax.servlet.http.HttpServletRequest request, 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.util.Map<java.lang.String,java.util.List<Portlet>>`	`getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, java.lang.String portletName)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay, java.lang.String portletName)`
`long[]`	`getSiteAndCompanyGroupIds(long groupId)`
`long[]`	`getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)`
`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 request, java.lang.String uri)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, long timestamp)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString)`
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString, long timestamp)`
`java.lang.String`	`getStrutsAction(javax.servlet.http.HttpServletRequest request)`
`java.lang.String[]`	`getSystemGroups()`
`java.lang.String[]`	`getSystemOrganizationRoles()`
`java.lang.String[]`	`getSystemRoles()`
`java.lang.String[]`	`getSystemSiteRoles()`
`java.lang.String`	`getUniqueElementId(javax.servlet.http.HttpServletRequest request, 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 request)`
`java.util.Date`	`getUptime()`
`java.lang.String`	`getURLWithSessionId(java.lang.String url, java.lang.String sessionId)`
`User`	`getUser(javax.servlet.http.HttpServletRequest request)`
`User`	`getUser(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getUserEmailAddress(long userId)`
`long`	`getUserId(javax.servlet.http.HttpServletRequest request)`
`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 request)`
`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 request)`
`java.lang.String`	`getUserPassword(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getUserPassword(javax.servlet.http.HttpSession session)`
`java.lang.String`	`getUserPassword(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getUserValue(long userId, java.lang.String param, java.lang.String defaultValue)`
`java.lang.String`	`getValidPortalDomain(long companyId, java.lang.String domain)`
`long`	`getValidUserId(long companyId, long userId)`
`java.lang.String`	`getVirtualLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`LayoutFriendlyURLComposite`	`getVirtualLayoutFriendlyURLComposite(boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`java.lang.String`	`getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`void`	`initCustomSQL()`
`User`	`initUser(javax.servlet.http.HttpServletRequest request)`
`void`	`invokeTaglibDiscussion(javax.portlet.PortletConfig portletConfig, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`boolean`	`isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)` Deprecated. As of 6.2.0 with no direct replacement
`boolean`	`isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isCDNDynamicResourcesEnabled(long companyId)`
`boolean`	`isCommunityAdmin(User user, long groupId)` Deprecated. As of 6.1.0, renamed to `isGroupAdmin(User, long)`
`boolean`	`isCommunityOwner(User user, long groupId)` Deprecated. As of 6.1.0, renamed to `isGroupOwner(User, long)`
`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`	`isCompanyControlPanelVisible(ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`boolean`	`isGroupAdmin(User user, long groupId)`
`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`	`isLayoutFirstPageable(Layout layout)`
`boolean`	`isLayoutFirstPageable(java.lang.String type)`
`boolean`	`isLayoutFriendliable(Layout layout)`
`boolean`	`isLayoutFriendliable(java.lang.String type)`
`boolean`	`isLayoutParentable(Layout layout)`
`boolean`	`isLayoutParentable(java.lang.String type)`
`boolean`	`isLayoutSitemapable(Layout layout)`
`boolean`	`isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isMethodGet(javax.portlet.PortletRequest portletRequest)`
`boolean`	`isMethodPost(javax.portlet.PortletRequest portletRequest)`
`boolean`	`isMultipartRequest(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isOmniadmin(long userId)`
`boolean`	`isReservedParameter(java.lang.String name)`
`boolean`	`isRSSFeedsEnabled()`
`boolean`	`isSecure(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isSystemGroup(java.lang.String groupName)`
`boolean`	`isSystemRole(java.lang.String roleName)`
`boolean`	`isUpdateAvailable()`
`boolean`	`isValidResourceId(java.lang.String resourceId)`
`void`	`removePortalPortEventListener(PortalPortEventListener portalPortEventListener)`
`void`	`resetCDNHosts()`
`java.util.Set<java.lang.String>`	`resetPortletAddDefaultResourceCheckWhitelist()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.resetPortletInvocationWhitelist()`
`java.util.Set<java.lang.String>`	`resetPortletAddDefaultResourceCheckWhitelistActions()` Deprecated. As of 6.2.0, replaced by `AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions()`
`java.lang.String`	`resetPortletParameters(java.lang.String url, java.lang.String portletId)`
`void`	`sendError(java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`void`	`sendError(java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`void`	`sendError(int status, java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)`
`void`	`sendError(int status, java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`void`	`sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`void`	`sendRSSFeedsDisabledError(javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse)`
`void`	`setPageDescription(java.lang.String description, javax.servlet.http.HttpServletRequest request)` Sets the description for the page, overriding the existing page description.
`void`	`setPageKeywords(java.lang.String keywords, javax.servlet.http.HttpServletRequest request)` Sets the keywords for the page, overriding the existing page keywords.
`void`	`setPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request)` Sets the subtitle for the page, overriding the existing page subtitle.
`void`	`setPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request)` Sets the whole title for the page, overriding the existing page whole title.
`void`	`setPortalPort(javax.servlet.http.HttpServletRequest request)` Sets the port obtained on the first request to the portal.
`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)`
`javax.portlet.PortletMode`	`updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest request)`
`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 request)`

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 request)
```
Appends the description to the current meta description of the page.

Parameters:
description - the description to append to the current meta description
request - the servlet request for the page

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

Parameters:
keywords - the keywords to add to the current meta keywords (comma-separated)
request - the servlet request for the page

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

Parameters:
subtitle - the subtitle to append to the current subtitle
request - the servlet request for the page

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

Parameters:
title - the title to append to the current title
request - the servlet request for the page

addPortalPortEventListener
```
void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
```
Adds the portal port event listener to the portal. The listener will be notified whenever the portal port is set.

Parameters:
portalPortEventListener - the portal port event listener to add

addPortalPortProtocolEventListener
```
void addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)
```
Adds the portal port and protocol event listener to the portal. The listener will be notified whenever the portal port and protocol is set.

Parameters:
portalPortEventListener - the portal port and protocol event listener to add

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

Parameters:
request - 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 request,
                             java.lang.String title,
                             java.lang.String url,
                             java.util.Map<java.lang.String,java.lang.Object> data)
```
Adds an entry to the portlet breadcrumbs for the page.

Parameters:
request - 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

addPortletDefaultResource

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

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

Parameters:: request - the servlet request for the page; portlet - the portlet
Throws:: PortalException - if adding the default resource permissions failed; SystemException - if a system exception occurred

addPortletDefaultResource

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

Throws:: PortalException; SystemException

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, refererPlid, and controlPanelCategory to the URL.

Parameters:
themeDisplay - the current theme display
url - the URL

Returns:
the URL with the preserved parameters added

addUserLocaleOptionsMessage

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

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 request,
                                 java.lang.String input)
```
Generates a random key to identify the request based on the input string.

Parameters:
request - the servlet request for the page
input - the input string

Returns:
the generated key

getAbsoluteURL

java.lang.String getAbsoluteURL(javax.servlet.http.HttpServletRequest request,
                              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,
                                                                      SystemException

Throws:: PortalException; SystemException

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,
                                     SystemException

Throws:: PortalException; SystemException

getAlternateLocales
```
java.util.Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request)
                                       throws PortalException,
                                              SystemException
```
Deprecated. As of 6.2.0, replaced by LanguageUtil.getAvailableLocales()

Returns an array with the alternate locales, considering if the page is showing just a content and the translations of this content.

Parameters:
request - the servlet request for the page

Returns:
the array of alternate locales

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getAlternateURL

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

Returns the alternate URL of the page, to distinguish it from its canonical URL.

Parameters:: canonicalURL - the canonical URL previously obtained; themeDisplay - the theme display; locale - the locale of the translated page; layout - the layout
Returns:: the alternate URL
Throws:: PortalException - if a portal exception occurred; SystemException - if a system exception occurred

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

Returns the set of struts actions that should not be checked for an authentication token.

Returns:
the set of struts actions that should not be checked for an authentication token

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

Returns the set of IDs of portlets that should not be checked for an authentication token.

Returns:
the set of IDs of portlets that should not be checked for an authentication token

getBaseModel
```
BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                          throws PortalException,
                                 SystemException
```
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 base model instance for the resource permission could not be found

SystemException - if a system exception occurred

getBaseModel
```
BaseModel<?> getBaseModel(java.lang.String modelName,
                        java.lang.String primKey)
                          throws PortalException,
                                 SystemException
```
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 base model instance with the primary key could not be found

SystemException - if a system exception occurred

getBasicAuthUserId
```
long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                        throws PortalException,
                               SystemException
```
Returns the user's ID from the HTTP authentication headers after validating their credentials.

Parameters:
request - the servlet request from which to retrieve the HTTP authentication headers

Returns:
the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise

Throws:

PortalException - if an authentication exception occurred

SystemException - if a system exception occurred

getBasicAuthUserId
```
long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
                      long companyId)
                        throws PortalException,
                               SystemException
```
Returns the user's ID from the HTTP authentication headers after validation their credentials.

Parameters:
request - the servlet request to retrieve the HTTP authentication headers from
companyId - unused

Returns:
the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise

Throws:

PortalException - if an authentication exception occurred

SystemException - if a system exception occurred

getCanonicalURL
```
java.lang.String getCanonicalURL(java.lang.String completeURL,
                               ThemeDisplay themeDisplay,
                               Layout layout)
                                 throws PortalException,
                                        SystemException
```
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 friendly URL or the group could not be retrieved

SystemException - if a system exception occurred

getCanonicalURL
```
java.lang.String getCanonicalURL(java.lang.String completeURL,
                               ThemeDisplay themeDisplay,
                               Layout layout,
                               boolean forceLayoutFriendlyURL)
                                 throws PortalException,
                                        SystemException
```
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 friendly URL or the group could not be retrieved

SystemException - if a system exception occurred

getCDNHost
```
java.lang.String getCDNHost()
```
Deprecated. As of 6.2.0, replaced by the more general getCDNHost(boolean)

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 request)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

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

getClassNamePortletId
```
java.lang.String getClassNamePortletId(java.lang.String className)
```
Returns the ID of certain portlets from the fully qualified name of one of their classes. The portlets this method supports are: blogs, bookmarks, calendar, document library, image gallery, journal, message boards, and wiki.

Parameters:
className - the fully qualified name of a class in a portlet

Returns:
the ID of the portlet the class is a part of, or an empty string if the class is not supported

getCompany

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

Throws:: PortalException; SystemException

getCompany

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

Throws:: PortalException; SystemException

getCompanyId

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

getCompanyId

long getCompanyId(javax.portlet.PortletRequest portletRequest)

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

getComputerAddress
```
java.lang.String getComputerAddress()
```

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

getControlPanelCategoriesMap

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

Throws:: SystemException

getControlPanelCategory

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

Throws:: SystemException

getControlPanelFullURL

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

Throws:: PortalException; SystemException

getControlPanelPlid

long getControlPanelPlid(long companyId)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException

getControlPanelPlid

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

Throws:: PortalException; SystemException

getControlPanelPortlets

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

Throws:: SystemException

getControlPanelPortlets

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

Throws:: SystemException

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getCreateAccountURL

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

Throws:: java.lang.Exception

getCurrentCompleteURL

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

getCurrentURL

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

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.

Parameters:
month - the month (0-based, meaning 0 for January)
day - the day of the month
year - the year

Returns:
the date object

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 the date was invalid and pe was not null

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 the date was invalid and pe was not null

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 the date was invalid and pe was not null

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 the date was invalid and pe was not null

getDefaultCompanyId
```
long getDefaultCompanyId()
```

getDigestAuthUserId

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

Throws:: PortalException; SystemException

getDisplayURL

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

Throws:: PortalException

getDisplayURL

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

Throws:: PortalException

getEmailFromAddress

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

Throws:: SystemException

getEmailFromName

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

Throws:: SystemException

getExpandoBridgeAttributes

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

Throws:: PortalException; SystemException

getExpandoBridgeAttributes

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

Throws:: PortalException; SystemException

getExpandoBridgeAttributes

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

Throws:: PortalException; SystemException

getExpandoValue

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

Throws:: PortalException; SystemException

getExpandoValue

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

Throws:: PortalException; SystemException

getExpandoValue

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

Throws:: PortalException; SystemException

getFacebookURL

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

Throws:: PortalException; SystemException

getFirstMyAccountPortlet

Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
                                 throws SystemException

Throws:: SystemException

getFirstPageLayoutTypes

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

getFirstSiteAdministrationPortlet

Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
                                          throws SystemException

Throws:: SystemException

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,
                                           SystemException

Throws:: PortalException; SystemException

getGroupFriendlyURL

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

Throws:: PortalException; SystemException

getGroupFriendlyURL

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

Throws:: PortalException; SystemException

getGroupFriendlyURLIndex

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

getGroupPermissions

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

getGroupPermissions

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

getGroupPermissions

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

getGroupPermissions

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

getGuestPermissions

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

getGuestPermissions

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

getGuestPermissions

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

getGuestPermissions

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

getHomeURL

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

Throws:: PortalException; SystemException

getHost

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

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)

getJournalArticleActualURL

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

Throws:: PortalException; SystemException

getJournalArticleLayout

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

Throws:: PortalException; SystemException

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,
                                           SystemException

Throws:: PortalException; SystemException

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,
                                           SystemException

Throws:: PortalException; SystemException

getLayoutEditPage

java.lang.String getLayoutEditPage(Layout layout)

getLayoutEditPage

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

getLayoutFriendlyURL

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

Throws:: PortalException; SystemException

getLayoutFriendlyURL

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

Throws:: PortalException; SystemException

getLayoutFriendlyURLComposite

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

Throws:: PortalException; SystemException

getLayoutFullURL

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

Throws:: PortalException; SystemException

getLayoutFullURL

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

Throws:: PortalException; SystemException

getLayoutFullURL

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

Throws:: PortalException; SystemException

getLayoutFullURL

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

Throws:: PortalException; SystemException

getLayoutFullURL

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

Throws:: PortalException; SystemException

getLayoutSetFriendlyURL

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

Throws:: PortalException; SystemException

getLayoutTarget

java.lang.String getLayoutTarget(Layout layout)

getLayoutURL

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

Throws:: PortalException; SystemException

getLayoutURL

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

Throws:: PortalException; SystemException

getLayoutURL

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

Throws:: PortalException; SystemException

getLayoutURL

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

Throws:: PortalException; SystemException

getLayoutViewPage

java.lang.String getLayoutViewPage(Layout layout)

getLayoutViewPage

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

getLiferayPortletRequest

LiferayPortletRequest getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)

getLiferayPortletResponse

LiferayPortletResponse getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)

getLocale

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

getLocale

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

getLocale

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

getLocalizedFriendlyURL

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

Throws:: java.lang.Exception

getMailId

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,
                                       SystemException

Throws:: PortalException; SystemException

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

getParentGroupId

long getParentGroupId(long scopeGroupId)
                      throws PortalException,
                             SystemException

Deprecated. As of 6.2.0 renamed to getSiteGroupId(long)

Throws:: PortalException; SystemException

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

getPathContext

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

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,
                                 SystemException

Throws:: PortalException; SystemException

getPlidFromPortletId

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

Throws:: PortalException; SystemException

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

getPortalPort
```
int getPortalPort()
```
Deprecated. As of 6.2.0, replaced by the more general getPortalPort(boolean)

getPortalPort
```
int getPortalPort(boolean secure)
```

getPortalProperties

java.util.Properties getPortalProperties()

getPortalURL

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

getPortalURL

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

getPortalURL

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

Throws:: PortalException; SystemException

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,
                                     SystemException

Throws:: PortalException; SystemException

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

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

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

getPortletBreadcrumbList

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

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

getPortletBreadcrumbs

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

getPortletConfig

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

Throws:: javax.portlet.PortletException; SystemException

getPortletDescription

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

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.RenderRequest renderRequest)

getPortletTitle

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

getPortletTitle

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

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

Throws:: SystemException

getPreferences

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

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getRelativeHomeURL

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

Throws:: PortalException; SystemException

getScopeGroupId

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

Throws:: PortalException; SystemException

getScopeGroupId

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

Throws:: PortalException; SystemException

getScopeGroupId

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

Throws:: PortalException; SystemException

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,
                            SystemException

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getServletContextName

java.lang.String getServletContextName()

getSharedContentSiteGroupIds

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

Throws:: PortalException; SystemException

getSiteAdministrationCategoriesMap

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

Throws:: SystemException

getSiteAdministrationURL

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

Throws:: SystemException

getSiteAdministrationURL

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

getSiteAdministrationURL

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

Throws:: SystemException

getSiteAdministrationURL

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

getSiteAndCompanyGroupIds

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

Throws:: PortalException; SystemException

getSiteAndCompanyGroupIds

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

Throws:: PortalException; SystemException

getSiteDefaultLocale

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

Throws:: PortalException; SystemException

getSiteGroupId

long getSiteGroupId(long groupId)
                    throws PortalException,
                           SystemException

Throws:: PortalException; SystemException

getSiteLoginURL
```
java.lang.String getSiteLoginURL(ThemeDisplay themeDisplay)
                                 throws PortalException,
                                        SystemException
```
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

SystemException - if a system exception occurred

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStrutsAction

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

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 request,
                                  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 request)

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 request)
             throws PortalException,
                    SystemException

Throws:: PortalException; SystemException

getUser

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

Throws:: PortalException; SystemException

getUserEmailAddress

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

Throws:: SystemException

getUserId

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

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

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

getUserPassword

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

getUserPassword

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

getUserPassword

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

getUserValue

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

Throws:: SystemException

getValidPortalDomain

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

getValidUserId

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

Throws:: PortalException; SystemException

getVirtualLayoutActualURL

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

Throws:: PortalException; SystemException

getVirtualLayoutFriendlyURLComposite

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

Throws:: PortalException; SystemException

getWidgetURL

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

Throws:: PortalException; SystemException

initCustomSQL
```
void initCustomSQL()
```

initUser

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

Throws:: java.lang.Exception

invokeTaglibDiscussion

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

Throws:: java.lang.Exception

isAllowAddPortletDefaultResource

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

Deprecated. As of 6.2.0 with no direct replacement

Throws:: PortalException; SystemException

isCDNDynamicResourcesEnabled

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

Throws:: PortalException; SystemException

isCDNDynamicResourcesEnabled

boolean isCDNDynamicResourcesEnabled(long companyId)

isCommunityAdmin

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

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

Throws:: java.lang.Exception

isCommunityOwner

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

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

Throws:: java.lang.Exception

isCompanyAdmin

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,
                                            SystemException

Throws:: PortalException; SystemException

isCompanyControlPanelPortlet

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

Throws:: PortalException; SystemException

isCompanyControlPanelVisible

boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

isControlPanelPortlet

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

Throws:: SystemException

isControlPanelPortlet

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

Throws:: SystemException

isGroupAdmin

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

Throws:: java.lang.Exception

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,
                                  SystemException

Throws:: PortalException; SystemException

isLayoutFirstPageable

boolean isLayoutFirstPageable(Layout layout)

isLayoutFirstPageable

boolean isLayoutFirstPageable(java.lang.String type)

isLayoutFriendliable

boolean isLayoutFriendliable(Layout layout)

isLayoutFriendliable

boolean isLayoutFriendliable(java.lang.String type)

isLayoutParentable

boolean isLayoutParentable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(java.lang.String type)

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

isLoginRedirectRequired

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

Throws:: SystemException

isMethodGet

boolean isMethodGet(javax.portlet.PortletRequest portletRequest)

isMethodPost

boolean isMethodPost(javax.portlet.PortletRequest portletRequest)

isMultipartRequest

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

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

isReservedParameter

boolean isReservedParameter(java.lang.String name)

isRSSFeedsEnabled
```
boolean isRSSFeedsEnabled()
```

isSecure

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

isSystemGroup

boolean isSystemGroup(java.lang.String groupName)

isSystemRole

boolean isSystemRole(java.lang.String roleName)

isUpdateAvailable

boolean isUpdateAvailable()
                          throws SystemException

Throws:: SystemException

isValidResourceId

boolean isValidResourceId(java.lang.String resourceId)

removePortalPortEventListener

void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)

resetCDNHosts
```
void resetCDNHosts()
```

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

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

resetPortletParameters

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

sendError

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

Throws:: java.io.IOException

sendError

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

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

sendError

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

Throws:: java.io.IOException

sendError

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

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

sendRSSFeedsDisabledError

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

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

sendRSSFeedsDisabledError

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

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

setPageKeywords

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

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

setPageSubtitle

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

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

setPageTitle

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

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

setPortalPort
```
void setPortalPort(javax.servlet.http.HttpServletRequest request)
```
Sets the port obtained on the first request to the portal.

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)

updatePortletMode

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

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

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

addPortalPortEventListener

addPortalPortProtocolEventListener

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletDefaultResource

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

addUserLocaleOptionsMessage

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getAbsoluteURL

getActualLayoutQueryStringComposite

getActualURL

getAlternateLocales

getAlternateURL

getAuthTokenIgnoreActions

getAuthTokenIgnorePortlets

getBaseModel

getBaseModel

getBasicAuthUserId

getBasicAuthUserId

getCanonicalURL

getCanonicalURL

getCDNHost

getCDNHost

getCDNHost

getCDNHostHttp

getCDNHostHttps

getClassName

getClassNameId

getClassNameId

getClassNamePortletId

getCompany

getCompany

getCompanyId

getCompanyId

getCompanyIds

getComputerAddress

getComputerName

getControlPanelCategoriesMap

getControlPanelCategory

getControlPanelFullURL

getControlPanelPlid

getControlPanelPlid

getControlPanelPortlets

getControlPanelPortlets

getControlPanelPortletURL

getControlPanelPortletURL

getCreateAccountURL

getCurrentCompleteURL

getCurrentURL

getCurrentURL

getCustomSQLFunctionIsNotNull

getCustomSQLFunctionIsNull

getDate

getDate

getDate

getDate