PortalImpl (Portal 7.0.10)

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

All Implemented Interfaces:: Portal

public class PortalImpl
extends java.lang.Object
implements Portal

Field Summary
- Fields inherited from interface com.liferay.portal.kernel.util.Portal
  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

Constructor Summary

Constructors
Constructor and Description

PortalImpl()

Constructors
Constructor and Description
`PortalImpl()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addDefaultResource(long companyId, Layout layout, Portlet portlet, boolean portletActions)` Deprecated. As of Wilberforce (7.0.x)
`protected void`	`addDefaultResource(long companyId, long groupId, Layout layout, Portlet portlet, boolean portletActions)` Deprecated. As of Wilberforce (7.0.x)
`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.
`boolean`	`addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`void`	`addPortalPortEventListener(PortalPortEventListener portalPortEventListener)` Deprecated. As of Judson (7.1.x), replaced by `addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)`
`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`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, java.lang.String title, java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> data, boolean portletBreadcrumbEntry)` Adds an entry to the portlet breadcrumbs for the page.
`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, and refererPlid to the URL.
`java.lang.String`	`addPreservedParameters(ThemeDisplay themeDisplay, java.lang.String url, boolean typeControlPanel, boolean doAsUser)`
`protected void`	`addRootModelResource(long companyId, long groupId, Portlet portlet)` Deprecated. As of Judson (7.1.x), replaced by `addRootModelResource(long, long, String)`
`protected void`	`addRootModelResource(long companyId, long groupId, java.lang.String name)`
`void`	`addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)`
`protected java.lang.String`	`buildI18NPath(java.util.Locale locale)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`clearRequestParameters(javax.portlet.RenderRequest renderRequest)` Clears the render parameters in the request if the portlet is in the action phase.
`void`	`copyRequestParameters(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)` Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters.
`protected java.util.Set<Group>`	`doGetAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`protected Group`	`doGetCurrentSiteGroup(long groupId)`
`protected long`	`doGetPlidFromPortletId(long groupId, boolean privateLayout, java.lang.String portletId)`
`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.
`protected java.util.List<Portlet>`	`filterControlPanelPortlets(java.util.Set<Portlet> portlets, ThemeDisplay themeDisplay)`
`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.lang.String`	`getAlternateURL(java.lang.String canonicalURL, ThemeDisplay themeDisplay, java.util.Locale locale, Layout layout)` Returns the alternate URL for the requested canonical URL in the given locale.
`java.util.Map<java.util.Locale,java.lang.String>`	`getAlternateURLs(java.lang.String canonicalURL, ThemeDisplay themeDisplay, Layout layout)`
`long[]`	`getAncestorSiteGroupIds(long groupId)`
`protected java.util.Locale`	`getAvailableLocale(long groupId, java.util.Locale locale)`
`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)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getBasicUserId(HttpServletRequest)`
`long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getBasicUserId(HttpServletRequest)`
`protected Layout`	`getBrowsableLayout(Layout layout)`
`java.util.List<Group>`	`getBrowsableScopeGroups(long userId, long companyId, long groupId, java.lang.String portletId)`
`protected java.lang.String`	`getCanonicalDomain(java.lang.String virtualHostname, java.lang.String portalDomain)`
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout)` Returns the canonical URL of the page, to distinguish it among its translations.
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL)` Returns the canonical URL of the page, to distinguish it among its translations.
`java.lang.String`	`getCanonicalURL(java.lang.String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL, boolean includeQueryString)` Returns the canonical URL of the page.
`java.lang.String`	`getCDNHost(boolean secure)` Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.
`java.lang.String`	`getCDNHost(javax.servlet.http.HttpServletRequest 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.
`Company`	`getCompany(javax.servlet.http.HttpServletRequest request)`
`Company`	`getCompany(javax.portlet.PortletRequest portletRequest)`
`long`	`getCompanyId(javax.servlet.http.HttpServletRequest request)`
`long`	`getCompanyId(javax.portlet.PortletRequest portletRequest)`
`long[]`	`getCompanyIds()`
`java.util.Set<java.lang.String>`	`getComputerAddresses()`
`java.lang.String`	`getComputerName()`
`protected java.lang.String`	`getContextPath(java.lang.String contextPath)`
`protected Group`	`getControlPanelDisplayGroup(Group controlPanelGroup, Group scopeGroup, long doAsGroupId, java.lang.String portletId)`
`protected Group`	`getControlPanelDisplayGroup(long companyId, long scopeGroupId, long doAsGroupId, java.lang.String portletId)`
`java.lang.String`	`getControlPanelFullURL(long scopeGroupId, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`long`	`getControlPanelPlid(long companyId)`
`long`	`getControlPanelPlid(javax.portlet.PortletRequest portletRequest)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, java.lang.String portletId, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, Group group, java.lang.String portletId, long refererGroupId, long refererPlid, java.lang.String lifecycle)`
`javax.portlet.PortletURL`	`getControlPanelPortletURL(javax.portlet.PortletRequest portletRequest, java.lang.String portletId, java.lang.String lifecycle)`
`java.lang.String`	`getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`long[]`	`getCurrentAndAncestorSiteGroupIds(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)`
`java.util.List<Group>`	`getCurrentAndAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)`
`java.lang.String`	`getCurrentCompleteURL(javax.servlet.http.HttpServletRequest 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, or `null` if the date is invalid.
`java.util.Date`	`getDate(int month, int day, int year, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.
`java.util.Date`	`getDate(int month, int day, int year, int hour, int min, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid.
`java.util.Date`	`getDate(int month, int day, int year, int hour, int min, java.util.TimeZone timeZone, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, year, hour, minute, and time zone, optionally throwing an exception if the date is invalid.
`java.util.Date`	`getDate(int month, int day, int year, java.util.TimeZone timeZone, java.lang.Class<? extends PortalException> clazz)` Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid.
`long`	`getDefaultCompanyId()`
`long`	`getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `HttpAuthManagerUtil.getDigestUserId(HttpServletRequest)`
`protected long`	`getDoAsUserId(javax.servlet.http.HttpServletRequest request, java.lang.String doAsUserIdString, boolean alwaysAllowDoAsUser)`
`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)`
`java.lang.String`	`getFirstPageLayoutTypes(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getForwardedHost(javax.servlet.http.HttpServletRequest request)`
`int`	`getForwardedPort(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getFullName(java.lang.String firstName, java.lang.String middleName, java.lang.String lastName)`
`java.lang.String`	`getGlobalLibDir()`
`java.lang.String`	`getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`protected java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, boolean canonicalURL)`
`protected java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, boolean canonicalURL, boolean controlPanel)`
`java.lang.String`	`getGroupFriendlyURL(LayoutSet layoutSet, 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)`
`protected java.lang.String[]`	`getGroupPermissions(java.lang.String[] groupPermissions, java.lang.String className, java.lang.String inputPermissionsShowOptions)`
`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)`
`protected java.lang.String[]`	`getGuestPermissions(java.lang.String[] guestPermissions, java.lang.String className, java.lang.String inputPermissionsShowOptions)`
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`Layout`	`getJournalArticleLayout(long groupId, boolean privateLayout, java.lang.String friendlyURL)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`java.lang.String`	`getJsSafePortletId(java.lang.String portletId)`
`java.lang.String`	`getLayoutActualURL(Layout layout)`
`java.lang.String`	`getLayoutActualURL(Layout layout, java.lang.String mainPath)`
`java.lang.String`	`getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL)`
`java.lang.String`	`getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`java.lang.String`	`getLayoutFriendlyURL(ThemeDisplay themeDisplay)`
`LayoutFriendlyURLComposite`	`getLayoutFriendlyURLComposite(long groupId, boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)` Deprecated. As of Judson (7.1.x), replaced by `getLayoutFriendlyURLSeparatorComposite(long, boolean, String, Map, Map)`
`LayoutFriendlyURLSeparatorComposite`	`getLayoutFriendlyURLSeparatorComposite(long groupId, boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId)`
`java.lang.String`	`getLayoutFullURL(long groupId, java.lang.String portletId, boolean secure)`
`java.lang.String`	`getLayoutFullURL(ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutSetDisplayURL(LayoutSet layoutSet, boolean secureConnection)`
`java.lang.String`	`getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutTarget(Layout layout)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`java.lang.String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, java.util.Locale locale)`
`java.lang.String`	`getLayoutURL(ThemeDisplay themeDisplay)`
`LiferayPortletRequest`	`getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)`
`LiferayPortletResponse`	`getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)`
`java.util.Locale`	`getLocale(javax.servlet.http.HttpServletRequest 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)`
`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)`
`PortalInetSocketAddressEventListener[]`	`getPortalInetSocketAddressEventListeners()`
`java.lang.String`	`getPortalLibDir()`
`java.net.InetAddress`	`getPortalLocalInetAddress(boolean secure)`
`int`	`getPortalLocalPort(boolean secure)`
`int`	`getPortalPort(boolean secure)` Deprecated. As of Wilberforce (7.0.x), replaced by `getPortalServerPort(boolean)`
`java.util.Properties`	`getPortalProperties()`
`java.net.InetAddress`	`getPortalServerInetAddress(boolean secure)`
`int`	`getPortalServerPort(boolean secure)`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request)`
`java.lang.String`	`getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)`
`java.lang.String`	`getPortalURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalURL(Layout layout, ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPortalURL(javax.portlet.PortletRequest portletRequest, boolean secure)`
`java.lang.String`	`getPortalURL(java.lang.String serverName, int serverPort, boolean secure)`
`java.lang.String`	`getPortalURL(ThemeDisplay themeDisplay)`
`java.lang.String`	`getPortalWebDir()`
`java.util.List<BreadcrumbEntry>`	`getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `BreadcrumbUtil.getPortletBreadcrumbEntries( HttpServletRequest)`
`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)`
`LayoutQueryStringComposite`	`getPortletFriendlyURLMapperLayoutQueryStringComposite(long groupId, boolean privateLayout, java.lang.String url, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)`
`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)`
`protected java.lang.String`	`getPortletParam(javax.servlet.http.HttpServletRequest request, java.lang.String name)`
`java.lang.String`	`getPortletTitle(Portlet portlet, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(javax.portlet.PortletRequest portletRequest)`
`java.lang.String`	`getPortletTitle(javax.portlet.PortletResponse portletResponse)`
`java.lang.String`	`getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(Portlet portlet, java.lang.String languageId)`
`java.lang.String`	`getPortletTitle(Portlet portlet, User user)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.Locale locale)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.util.ResourceBundle resourceBundle)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, java.lang.String languageId)`
`java.lang.String`	`getPortletTitle(java.lang.String portletId, User user)`
`java.lang.String`	`getPortletXmlFileName()`
`javax.portlet.PortletPreferences`	`getPreferences(javax.servlet.http.HttpServletRequest request)`
`javax.portlet.PreferencesValidator`	`getPreferencesValidator(Portlet portlet)`
`java.lang.String`	`getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)`
`java.util.ResourceBundle`	`getResourceBundle(java.util.Locale locale)`
`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()`
`protected java.lang.String`	`getServletURL(Portlet portlet, java.lang.String servletPath, ThemeDisplay themeDisplay)`
`long[]`	`getSharedContentSiteGroupIds(long companyId, long groupId, long userId)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, java.lang.String portletId)` Deprecated. As of Wilberforce (7.0.x), replaced by `#getControlPanelPortletURL(PortletRequest, Group, String, String)`
`javax.portlet.PortletURL`	`getSiteAdministrationURL(javax.portlet.PortletResponse portletResponse, ThemeDisplay themeDisplay, java.lang.String portletName)` Deprecated. As of Wilberforce (7.0.x), replaced by `#getControlPanelPortletURL(PortletRequest, Group, String, String)`
`java.lang.String`	`getSiteAdminURL(Company company, Group group, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)` Deprecated. As of Judson (7.1.x), replaced by `getSiteAdminURL(ThemeDisplay, String, Map)`
`java.lang.String`	`getSiteAdminURL(Group group, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)` Deprecated. As of Judson (7.1.x), replaced by `getSiteAdminURL(ThemeDisplay, String, Map)`
`java.lang.String`	`getSiteAdminURL(ThemeDisplay themeDisplay, java.lang.String ppid, java.util.Map<java.lang.String,java.lang.String[]> params)`
`long[]`	`getSiteAndCompanyGroupIds(long groupId)` Deprecated. As of Wilberforce (7.0.x), replaced by `getCurrentAndAncestorSiteGroupIds(long)`
`long[]`	`getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)` Deprecated. As of Wilberforce (7.0.x), replaced by `getCurrentAndAncestorSiteGroupIds(long)`
`java.util.Locale`	`getSiteDefaultLocale(Group group)`
`java.util.Locale`	`getSiteDefaultLocale(long groupId)`
`long`	`getSiteGroupId(long groupId)`
`java.lang.String`	`getSiteLoginURL(ThemeDisplay themeDisplay)` Returns the URL of the login page for the current site if one is available.
`java.lang.String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest 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 elementId)`
`java.lang.String`	`getUniqueElementId(javax.portlet.PortletRequest request, java.lang.String namespace, java.lang.String elementId)`
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`java.lang.String`	`getValidPortalDomain(long companyId, java.lang.String domain)`
`long`	`getValidUserId(long companyId, long userId)`
`java.lang.String`	`getVirtualHostname(LayoutSet layoutSet)`
`java.lang.String`	`getVirtualLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`LayoutFriendlyURLComposite`	`getVirtualLayoutFriendlyURLComposite(boolean privateLayout, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params, java.util.Map<java.lang.String,java.lang.Object> requestContext)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`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)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`void`	`invokeTaglibDiscussionPagination(javax.portlet.PortletConfig portletConfig, javax.portlet.ResourceRequest resourceRequest, javax.portlet.ResourceResponse resourceResponse)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`protected boolean`	`isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)`
`protected boolean`	`isAlwaysAllowDoAsUser(java.lang.String actionName, java.lang.String mvcRenderCommandName, java.lang.String path, java.lang.String strutsAction)`
`boolean`	`isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isCDNDynamicResourcesEnabled(long companyId)`
`boolean`	`isCompanyAdmin(User user)`
`boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`boolean`	`isCompanyControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, java.lang.String category, ThemeDisplay themeDisplay)`
`boolean`	`isControlPanelPortlet(java.lang.String portletId, ThemeDisplay themeDisplay)`
`boolean`	`isCustomPortletMode(javax.portlet.PortletMode portletMode)`
`boolean`	`isForwardedSecure(javax.servlet.http.HttpServletRequest request)`
`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`	`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`	`isOmniadmin(User user)`
`boolean`	`isReservedParameter(java.lang.String name)`
`boolean`	`isRightToLeft(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isRSSFeedsEnabled()`
`boolean`	`isSecure(javax.servlet.http.HttpServletRequest request)`
`boolean`	`isSkipPortletContentProcessing(Group group, javax.servlet.http.HttpServletRequest httpServletRequest, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, java.lang.String portletName)`
`boolean`	`isSkipPortletContentRendering(Group group, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, java.lang.String portletName)`
`boolean`	`isSystemGroup(java.lang.String groupName)`
`boolean`	`isSystemRole(java.lang.String roleName)`
`protected boolean`	`isUnwrapRequest(java.lang.String currentRequestClassName)`
`boolean`	`isUpdateAvailable()`
`protected boolean`	`isValidPortalDomain(long companyId, java.lang.String domain)`
`protected boolean`	`isValidPortalDomain(java.lang.String domain)`
`boolean`	`isValidResourceId(java.lang.String resourceId)`
`protected boolean`	`isValidVirtualHostname(java.lang.String virtualHostname)`
`protected void`	`notifyPortalInetSocketAddressEventListeners(java.net.InetSocketAddress inetSocketAddress, boolean local, boolean secure)`
`protected void`	`notifyPortalPortEventListeners(int portalPort)` Deprecated. As of Wilberforce (7.0.x), replaced by `notifyPortalInetSocketAddressEventListeners( InetSocketAddress, boolean, boolean)`
`boolean`	`removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)`
`void`	`removePortalPortEventListener(PortalPortEventListener portalPortEventListener)` Deprecated. As of Judson (7.1.x), replaced by `removePortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)`
`protected java.lang.String`	`removeRedirectParameter(java.lang.String url)`
`void`	`resetCDNHosts()`
`java.lang.String`	`resetPortletParameters(java.lang.String url, java.lang.String portletId)`
`protected void`	`resetThemeDisplayI18n(ThemeDisplay themeDisplay, java.lang.String languageId, java.lang.String path, java.util.Locale locale)`
`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)`
`protected void`	`setLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Locale locale)`
`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`	`setPortalInetSocketAddresses(javax.servlet.http.HttpServletRequest request)`
`void`	`setPortalPort(javax.servlet.http.HttpServletRequest request)` Deprecated. As of Wilberforce (7.0.x), replaced by `setPortalInetSocketAddresses(HttpServletRequest)`
`protected void`	`setThemeDisplayI18n(ThemeDisplay themeDisplay, java.util.Locale locale)`
`void`	`storePreferences(javax.portlet.PortletPreferences portletPreferences)`
`java.lang.String[]`	`stripURLAnchor(java.lang.String url, java.lang.String separator)`
`java.lang.String`	`transformCustomSQL(java.lang.String sql)`
`java.lang.String`	`transformSQL(java.lang.String sql)`
`void`	`updateImageId(BaseModel<?> baseModel, boolean hasImage, byte[] bytes, java.lang.String fieldName, long maxSize, int maxHeight, int maxWidth)`
`javax.portlet.PortletMode`	`updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest 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)`

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

Constructor Detail
- PortalImpl
```
public PortalImpl()
```

Method Detail

addPageDescription
```
public void addPageDescription(java.lang.String description,
                               javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

Appends the description to the current meta description of the page.

Specified by:

addPageDescription in interface Portal

Parameters:

description - the description to append to the current meta description

request - the servlet request for the page

addPageKeywords
```
public void addPageKeywords(java.lang.String keywords,
                            javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

Appends the keywords to the current meta keywords of the page.

Specified by:

addPageKeywords in interface Portal

Parameters:

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

request - the servlet request for the page

addPageSubtitle
```
public void addPageSubtitle(java.lang.String subtitle,
                            javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

Appends the subtitle to the current subtitle of the page.

Specified by:

addPageSubtitle in interface Portal

Parameters:

subtitle - the subtitle to append to the current subtitle

request - the servlet request for the page

addPageTitle
```
public void addPageTitle(java.lang.String title,
                         javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

Appends the title to the current title of the page.

Specified by:

addPageTitle in interface Portal

Parameters:

title - the title to append to the current title

request - the servlet request for the page

addPortalInetSocketAddressEventListener

public boolean addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

Specified by:: addPortalInetSocketAddressEventListener in interface Portal

addPortalPortEventListener
```
@Deprecated
public void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
```
Deprecated. As of Judson (7.1.x), replaced by addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)

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

Specified by:

addPortalPortEventListener in interface Portal

Parameters:

portalPortEventListener - the portal port event listener to add

addPortletBreadcrumbEntry
```
public void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String title,
                                      java.lang.String url)
```
Description copied from interface: Portal

Adds an entry to the portlet breadcrumbs for the page.

Specified by:

addPortletBreadcrumbEntry in interface Portal

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
```
public 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)
```
Description copied from interface: Portal

Adds an entry to the portlet breadcrumbs for the page.

Specified by:

addPortletBreadcrumbEntry in interface Portal

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

addPortletBreadcrumbEntry
```
public void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String title,
                                      java.lang.String url,
                                      java.util.Map<java.lang.String,java.lang.Object> data,
                                      boolean portletBreadcrumbEntry)
```
Description copied from interface: Portal

Adds an entry to the portlet breadcrumbs for the page.

Specified by:

addPortletBreadcrumbEntry in interface Portal

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

portletBreadcrumbEntry - whether the entry is a portlet breadcrumb entry

addPortletDefaultResource
```
public void addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
                                      Portlet portlet)
                               throws PortalException
```
Description copied from interface: Portal

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

Specified by:

addPortletDefaultResource in interface Portal

Parameters:

request - the servlet request for the page

portlet - the portlet

Throws:

PortalException - if a portal exception occurred

addPortletDefaultResource

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

Specified by:: addPortletDefaultResource in interface Portal
Throws:: PortalException

addPreservedParameters
```
public java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                               Layout layout,
                                               java.lang.String url,
                                               boolean doAsUser)
```
Description copied from interface: Portal

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.

Specified by:

addPreservedParameters in interface 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
```
public java.lang.String addPreservedParameters(ThemeDisplay themeDisplay,
                                               java.lang.String url)
```
Description copied from interface: Portal

Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, and refererPlid to the URL.

Specified by:

addPreservedParameters in interface Portal

Parameters:

themeDisplay - the current theme display

url - the URL

Returns:

the URL with the preserved parameters added

addPreservedParameters

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

Specified by:: addPreservedParameters in interface Portal

addUserLocaleOptionsMessage

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

Specified by:: addUserLocaleOptionsMessage in interface Portal

clearRequestParameters
```
public void clearRequestParameters(javax.portlet.RenderRequest renderRequest)
```
Description copied from interface: Portal

Clears the render parameters in the request if the portlet is in the action phase.

Specified by:

clearRequestParameters in interface Portal

Parameters:

renderRequest - the render request

copyRequestParameters
```
public void copyRequestParameters(javax.portlet.ActionRequest actionRequest,
                                  javax.portlet.ActionResponse actionResponse)
```
Description copied from interface: Portal

Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters.

Specified by:

copyRequestParameters in interface Portal

Parameters:

actionRequest - the request from which to get the request parameters

actionResponse - the response to receive the render parameters

escapeRedirect
```
public java.lang.String escapeRedirect(java.lang.String url)
```
Description copied from interface: Portal

Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects.

Specified by:

escapeRedirect in interface Portal

Parameters:

url - the URL to escape

Returns:

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

generateRandomKey
```
public java.lang.String generateRandomKey(javax.servlet.http.HttpServletRequest request,
                                          java.lang.String input)
```
Description copied from interface: Portal

Generates a random key to identify the request based on the input string.

Specified by:

generateRandomKey in interface Portal

Parameters:

request - the servlet request for the page

input - the input string

Returns:

the generated key

getAbsoluteURL

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

Specified by:: getAbsoluteURL in interface Portal

getActualLayoutQueryStringComposite

public 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

Specified by:: getActualLayoutQueryStringComposite in interface Portal
Throws:: PortalException

getActualURL

public 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

Specified by:: getActualURL in interface Portal
Throws:: PortalException

getAlternateURL
```
public java.lang.String getAlternateURL(java.lang.String canonicalURL,
                                        ThemeDisplay themeDisplay,
                                        java.util.Locale locale,
                                        Layout layout)
                                 throws PortalException
```
Description copied from interface: Portal

Returns the alternate URL for the requested canonical URL in the given locale.
The alternate URL lets search engines know that an equivalent page is available for the given locale. For more information, see https://support.google.com/webmasters/answer/189077?hl=en.

Specified by:

getAlternateURL in interface Portal

Parameters:

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

themeDisplay - the theme display

locale - the locale of the alternate (translated) page

layout - the page being requested

Returns:

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

Throws:

PortalException - if a portal exception occurred

getAlternateURLs

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

Specified by:: getAlternateURLs in interface Portal
Throws:: PortalException

getAncestorSiteGroupIds

public long[] getAncestorSiteGroupIds(long groupId)
                               throws PortalException

Specified by:: getAncestorSiteGroupIds in interface Portal
Throws:: PortalException

getBaseModel
```
public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                          throws PortalException
```
Description copied from interface: Portal

Returns the base model instance for the resource permission.

Specified by:

getBaseModel in interface Portal

Parameters:

resourcePermission - the resource permission

Returns:

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

Throws:

PortalException - if a portal exception occurred

getBaseModel
```
public BaseModel<?> getBaseModel(java.lang.String modelName,
                                 java.lang.String primKey)
                          throws PortalException
```
Description copied from interface: Portal

Returns the base model instance for the model name and primary key.

Specified by:

getBaseModel in interface Portal

Parameters:

modelName - the fully qualified class name of the model

primKey - the primary key of the model instance to get

Returns:

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

Throws:

PortalException - if a portal exception occurred

getBasicAuthUserId
```
@Deprecated
public long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                                    throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getBasicUserId(HttpServletRequest)

Specified by:

getBasicAuthUserId in interface Portal

Throws:

PortalException

getBasicAuthUserId

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

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

Specified by:: getBasicAuthUserId in interface Portal
Throws:: PortalException

getBrowsableScopeGroups

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

Specified by:: getBrowsableScopeGroups in interface Portal
Throws:: PortalException

getCanonicalURL
```
public java.lang.String getCanonicalURL(java.lang.String completeURL,
                                        ThemeDisplay themeDisplay,
                                        Layout layout)
                                 throws PortalException
```
Description copied from interface: Portal

Returns the canonical URL of the page, to distinguish it among its translations.

Specified by:

getCanonicalURL in interface Portal

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
public java.lang.String getCanonicalURL(java.lang.String completeURL,
                                        ThemeDisplay themeDisplay,
                                        Layout layout,
                                        boolean forceLayoutFriendlyURL)
                                 throws PortalException
```
Description copied from interface: Portal

Returns the canonical URL of the page, to distinguish it among its translations.

Specified by:

getCanonicalURL in interface Portal

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL
```
public java.lang.String getCanonicalURL(java.lang.String completeURL,
                                        ThemeDisplay themeDisplay,
                                        Layout layout,
                                        boolean forceLayoutFriendlyURL,
                                        boolean includeQueryString)
                                 throws PortalException
```
Description copied from interface: Portal

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

Specified by:

getCanonicalURL in interface Portal

Parameters:

completeURL - the complete URL of the page

themeDisplay - the theme display

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

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

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCDNHost
```
public java.lang.String getCDNHost(boolean secure)
```
Description copied from interface: Portal

Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.

Specified by:

getCDNHost in interface Portal

Parameters:

secure - whether to get the secure or insecure CDN host address

Returns:

the CDN host address

getCDNHost

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

Specified by:: getCDNHost in interface Portal
Throws:: PortalException

getCDNHostHttp
```
public java.lang.String getCDNHostHttp(long companyId)
```
Description copied from interface: Portal

Returns the insecure (HTTP) content distribution network (CDN) host address

Specified by:

getCDNHostHttp in interface Portal

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getCDNHostHttps
```
public java.lang.String getCDNHostHttps(long companyId)
```
Description copied from interface: Portal

Returns the secure (HTTPS) content distribution network (CDN) host address

Specified by:

getCDNHostHttps in interface Portal

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getClassName
```
public java.lang.String getClassName(long classNameId)
```
Description copied from interface: Portal

Returns the fully qualified name of the class from its ID.

Specified by:

getClassName in interface Portal

Parameters:

classNameId - the ID of the class

Returns:

the fully qualified name of the class

getClassNameId
```
public long getClassNameId(java.lang.Class<?> clazz)
```
Description copied from interface: Portal

Returns the ID of the class from its class object.

Specified by:

getClassNameId in interface Portal

Parameters:

clazz - the class object

Returns:

the ID of the class

getClassNameId
```
public long getClassNameId(java.lang.String value)
```
Description copied from interface: Portal

Returns the ID of the class from its fully qualified name.

Specified by:

getClassNameId in interface Portal

Parameters:

value - the fully qualified name of the class

Returns:

the ID of the class

getCompany

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

Specified by:: getCompany in interface Portal
Throws:: PortalException

getCompany

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

Specified by:: getCompany in interface Portal
Throws:: PortalException

getCompanyId

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

Specified by:: getCompanyId in interface Portal

getCompanyId

public long getCompanyId(javax.portlet.PortletRequest portletRequest)

Specified by:: getCompanyId in interface Portal

getCompanyIds
```
public long[] getCompanyIds()
```
Specified by:

getCompanyIds in interface Portal

getComputerAddresses
```
public java.util.Set<java.lang.String> getComputerAddresses()
```
Specified by:

getComputerAddresses in interface Portal

getComputerName
```
public java.lang.String getComputerName()
```
Specified by:

getComputerName in interface Portal

getControlPanelFullURL

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

Specified by:: getControlPanelFullURL in interface Portal
Throws:: PortalException

getControlPanelPlid

public long getControlPanelPlid(long companyId)
                         throws PortalException

Specified by:: getControlPanelPlid in interface Portal
Throws:: PortalException

getControlPanelPlid

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

Specified by:: getControlPanelPlid in interface Portal
Throws:: PortalException

getControlPanelPortletURL

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

Specified by:: getControlPanelPortletURL in interface Portal

getControlPanelPortletURL

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

Specified by:: getControlPanelPortletURL in interface Portal

getControlPanelPortletURL

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

Specified by:: getControlPanelPortletURL in interface Portal

getControlPanelPortletURL

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

Specified by:: getControlPanelPortletURL in interface Portal

getCreateAccountURL

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

Specified by:: getCreateAccountURL in interface Portal
Throws:: java.lang.Exception

getCurrentAndAncestorSiteGroupIds

public long[] getCurrentAndAncestorSiteGroupIds(long groupId)
                                         throws PortalException

Specified by:: getCurrentAndAncestorSiteGroupIds in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Specified by:: getCurrentAndAncestorSiteGroupIds in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Specified by:: getCurrentAndAncestorSiteGroupIds in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroupIds

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

Specified by:: getCurrentAndAncestorSiteGroupIds in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Specified by:: getCurrentAndAncestorSiteGroups in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Specified by:: getCurrentAndAncestorSiteGroups in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Specified by:: getCurrentAndAncestorSiteGroups in interface Portal
Throws:: PortalException

getCurrentAndAncestorSiteGroups

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

Specified by:: getCurrentAndAncestorSiteGroups in interface Portal
Throws:: PortalException

getCurrentCompleteURL

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

Specified by:: getCurrentCompleteURL in interface Portal

getCurrentURL

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

Specified by:: getCurrentURL in interface Portal

getCurrentURL

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

Specified by:: getCurrentURL in interface Portal

getCustomSQLFunctionIsNotNull
```
public java.lang.String getCustomSQLFunctionIsNotNull()
```
Specified by:

getCustomSQLFunctionIsNotNull in interface Portal

getCustomSQLFunctionIsNull
```
public java.lang.String getCustomSQLFunctionIsNull()
```
Specified by:

getCustomSQLFunctionIsNull in interface Portal

getDate
```
public java.util.Date getDate(int month,
                              int day,
                              int year)
```
Description copied from interface: Portal

Returns the date object for the specified month, day, and year, or null if the date is invalid.

Specified by:

getDate in interface Portal

Parameters:

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

day - the day of the month

year - the year

Returns:

the date object, or null if the date is invalid

getDate
```
public java.util.Date getDate(int month,
                              int day,
                              int year,
                              java.lang.Class<? extends PortalException> clazz)
                       throws PortalException
```
Description copied from interface: Portal

Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.

Specified by:

getDate in interface Portal

Parameters:

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

day - the day of the month

year - the year

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate
```
public java.util.Date getDate(int month,
                              int day,
                              int year,
                              int hour,
                              int min,
                              java.lang.Class<? extends PortalException> clazz)
                       throws PortalException
```
Description copied from interface: Portal

Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid.

Specified by:

getDate in interface Portal

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate
```
public 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
```
Description copied from interface: Portal

Returns the date object for the specified month, day, year, hour, minute, and time zone, optionally throwing an exception if the date is invalid.

Specified by:

getDate in interface Portal

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate
```
public java.util.Date getDate(int month,
                              int day,
                              int year,
                              java.util.TimeZone timeZone,
                              java.lang.Class<? extends PortalException> clazz)
                       throws PortalException
```
Description copied from interface: Portal

Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid.

Specified by:

getDate in interface Portal

Parameters:

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

day - the day of the month

year - the year

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDefaultCompanyId
```
public long getDefaultCompanyId()
```
Specified by:

getDefaultCompanyId in interface Portal

getDigestAuthUserId
```
@Deprecated
public long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
                                     throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getDigestUserId(HttpServletRequest)

Specified by:

getDigestAuthUserId in interface Portal

Throws:

PortalException

getEmailFromAddress

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

Specified by:: getEmailFromAddress in interface Portal

getEmailFromName

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

Specified by:: getEmailFromName in interface Portal

getExpandoBridgeAttributes

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

Specified by:: getExpandoBridgeAttributes in interface Portal
Throws:: PortalException

getExpandoBridgeAttributes

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

Specified by:: getExpandoBridgeAttributes in interface Portal
Throws:: PortalException

getExpandoBridgeAttributes

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

Specified by:: getExpandoBridgeAttributes in interface Portal
Throws:: PortalException

getExpandoValue

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

Specified by:: getExpandoValue in interface Portal
Throws:: PortalException

getExpandoValue

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

Specified by:: getExpandoValue in interface Portal
Throws:: PortalException

getExpandoValue

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

Specified by:: getExpandoValue in interface Portal
Throws:: PortalException

getFacebookURL

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

Specified by:: getFacebookURL in interface Portal
Throws:: PortalException

getFirstPageLayoutTypes

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

Specified by:: getFirstPageLayoutTypes in interface Portal

getForwardedHost

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

Specified by:: getForwardedHost in interface Portal

getForwardedPort

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

Specified by:: getForwardedPort in interface Portal

getFullName

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

Specified by:: getFullName in interface Portal

getGlobalLibDir
```
public java.lang.String getGlobalLibDir()
```
Specified by:

getGlobalLibDir in interface Portal

getGoogleGadgetURL

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

Specified by:: getGoogleGadgetURL in interface Portal
Throws:: PortalException

getGroupFriendlyURL

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

Specified by:: getGroupFriendlyURL in interface Portal
Throws:: PortalException

getGroupFriendlyURL

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

Specified by:: getGroupFriendlyURL in interface Portal
Throws:: PortalException

getGroupFriendlyURLIndex
```
public int[] getGroupFriendlyURLIndex(java.lang.String requestURI)
```
Specified by:

getGroupFriendlyURLIndex in interface Portal

getGroupPermissions

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

Specified by:: getGroupPermissions in interface Portal

getGroupPermissions

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

Specified by:: getGroupPermissions in interface Portal

getGroupPermissions

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

Specified by:: getGroupPermissions in interface Portal

getGroupPermissions

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

Specified by:: getGroupPermissions in interface Portal

getGuestPermissions

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

Specified by:: getGuestPermissions in interface Portal

getGuestPermissions

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

Specified by:: getGuestPermissions in interface Portal

getGuestPermissions

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

Specified by:: getGuestPermissions in interface Portal

getGuestPermissions

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

Specified by:: getGuestPermissions in interface Portal

getHomeURL

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

Specified by:: getHomeURL in interface Portal
Throws:: PortalException

getHost

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

Specified by:: getHost in interface Portal

getHost

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

Specified by:: getHost in interface Portal

getHttpServletRequest

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

Specified by:: getHttpServletRequest in interface Portal

getHttpServletResponse

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

Specified by:: getHttpServletResponse in interface Portal

getI18nPathLanguageId

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

Specified by:: getI18nPathLanguageId in interface Portal

getJournalArticleActualURL

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

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

Specified by:: getJournalArticleActualURL in interface Portal
Throws:: PortalException

getJournalArticleLayout

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

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

Specified by:: getJournalArticleLayout in interface Portal
Throws:: PortalException

getJsSafePortletId

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

Specified by:: getJsSafePortletId in interface Portal

getLayoutActualURL
```
public java.lang.String getLayoutActualURL(Layout layout)
```
Specified by:

getLayoutActualURL in interface Portal

getLayoutActualURL

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

Specified by:: getLayoutActualURL in interface Portal

getLayoutActualURL

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

Specified by:: getLayoutActualURL in interface Portal
Throws:: PortalException

getLayoutActualURL

public 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

Specified by:: getLayoutActualURL in interface Portal
Throws:: PortalException

getLayoutFriendlyURL

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

Specified by:: getLayoutFriendlyURL in interface Portal
Throws:: PortalException

getLayoutFriendlyURL

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

Specified by:: getLayoutFriendlyURL in interface Portal
Throws:: PortalException

getLayoutFriendlyURL

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

Specified by:: getLayoutFriendlyURL in interface Portal
Throws:: PortalException

getLayoutFriendlyURLComposite

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

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

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

Specified by:: getLayoutFriendlyURLComposite in interface Portal
Throws:: PortalException

getLayoutFriendlyURLSeparatorComposite

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

Specified by:: getLayoutFriendlyURLSeparatorComposite in interface Portal
Throws:: PortalException

getLayoutFullURL

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

Specified by:: getLayoutFullURL in interface Portal
Throws:: PortalException

getLayoutFullURL

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

Specified by:: getLayoutFullURL in interface Portal
Throws:: PortalException

getLayoutFullURL

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

Specified by:: getLayoutFullURL in interface Portal
Throws:: PortalException

getLayoutFullURL

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

Specified by:: getLayoutFullURL in interface Portal
Throws:: PortalException

getLayoutFullURL

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

Specified by:: getLayoutFullURL in interface Portal
Throws:: PortalException

getLayoutRelativeURL

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

Specified by:: getLayoutRelativeURL in interface Portal
Throws:: PortalException

getLayoutRelativeURL

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

Specified by:: getLayoutRelativeURL in interface Portal
Throws:: PortalException

getLayoutSetDisplayURL

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

Specified by:: getLayoutSetDisplayURL in interface Portal
Throws:: PortalException

getLayoutSetFriendlyURL

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

Specified by:: getLayoutSetFriendlyURL in interface Portal
Throws:: PortalException

getLayoutTarget
```
public java.lang.String getLayoutTarget(Layout layout)
```
Specified by:

getLayoutTarget in interface Portal

getLayoutURL

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

Specified by:: getLayoutURL in interface Portal
Throws:: PortalException

getLayoutURL

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

Specified by:: getLayoutURL in interface Portal
Throws:: PortalException

getLayoutURL

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

Specified by:: getLayoutURL in interface Portal
Throws:: PortalException

getLayoutURL

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

Specified by:: getLayoutURL in interface Portal
Throws:: PortalException

getLiferayPortletRequest

public LiferayPortletRequest getLiferayPortletRequest(javax.portlet.PortletRequest portletRequest)

Specified by:: getLiferayPortletRequest in interface Portal

getLiferayPortletResponse

public LiferayPortletResponse getLiferayPortletResponse(javax.portlet.PortletResponse portletResponse)

Specified by:: getLiferayPortletResponse in interface Portal

getLocale

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

Specified by:: getLocale in interface Portal

getLocale

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

Specified by:: getLocale in interface Portal

getLocale

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

Specified by:: getLocale in interface Portal

getLocalizedFriendlyURL

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

Specified by:: getLocalizedFriendlyURL in interface Portal
Throws:: java.lang.Exception

getMailId

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

Specified by:: getMailId in interface Portal

getNetvibesURL

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

Specified by:: getNetvibesURL in interface Portal
Throws:: PortalException

getNewPortletTitle

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

Specified by:: getNewPortletTitle in interface Portal

getOriginalServletRequest

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

Specified by:: getOriginalServletRequest in interface Portal

getPathContext
```
public java.lang.String getPathContext()
```
Specified by:

getPathContext in interface Portal

getPathContext

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

Specified by:: getPathContext in interface Portal

getPathContext

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

Specified by:: getPathContext in interface Portal

getPathContext

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

Specified by:: getPathContext in interface Portal

getPathFriendlyURLPrivateGroup
```
public java.lang.String getPathFriendlyURLPrivateGroup()
```
Specified by:

getPathFriendlyURLPrivateGroup in interface Portal

getPathFriendlyURLPrivateUser
```
public java.lang.String getPathFriendlyURLPrivateUser()
```
Specified by:

getPathFriendlyURLPrivateUser in interface Portal

getPathFriendlyURLPublic
```
public java.lang.String getPathFriendlyURLPublic()
```
Specified by:

getPathFriendlyURLPublic in interface Portal

getPathImage
```
public java.lang.String getPathImage()
```
Specified by:

getPathImage in interface Portal

getPathMain
```
public java.lang.String getPathMain()
```
Specified by:

getPathMain in interface Portal

getPathModule
```
public java.lang.String getPathModule()
```
Specified by:

getPathModule in interface Portal

getPathProxy
```
public java.lang.String getPathProxy()
```
Specified by:

getPathProxy in interface Portal

getPlidFromFriendlyURL

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

Specified by:: getPlidFromFriendlyURL in interface Portal

getPlidFromPortletId

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

Specified by:: getPlidFromPortletId in interface Portal

getPlidFromPortletId

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

Specified by:: getPlidFromPortletId in interface Portal

getPortalInetSocketAddressEventListeners
```
public PortalInetSocketAddressEventListener[] getPortalInetSocketAddressEventListeners()
```
Specified by:

getPortalInetSocketAddressEventListeners in interface Portal

getPortalLibDir
```
public java.lang.String getPortalLibDir()
```
Specified by:

getPortalLibDir in interface Portal

getPortalLocalInetAddress
```
public java.net.InetAddress getPortalLocalInetAddress(boolean secure)
```
Specified by:

getPortalLocalInetAddress in interface Portal

getPortalLocalPort
```
public int getPortalLocalPort(boolean secure)
```
Specified by:

getPortalLocalPort in interface Portal

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

Specified by:

getPortalPort in interface Portal

getPortalProperties
```
public java.util.Properties getPortalProperties()
```
Specified by:

getPortalProperties in interface Portal

getPortalServerInetAddress
```
public java.net.InetAddress getPortalServerInetAddress(boolean secure)
```
Specified by:

getPortalServerInetAddress in interface Portal

getPortalServerPort
```
public int getPortalServerPort(boolean secure)
```
Specified by:

getPortalServerPort in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal
Throws:: PortalException

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal

getPortalURL

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

Specified by:: getPortalURL in interface Portal
Throws:: PortalException

getPortalWebDir
```
public java.lang.String getPortalWebDir()
```
Specified by:

getPortalWebDir in interface Portal

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

Specified by:

getPortletBreadcrumbs in interface Portal

getPortletConfig

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

Specified by:: getPortletConfig in interface Portal
Throws:: javax.portlet.PortletException

getPortletDescription

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

Specified by:: getPortletDescription in interface Portal

getPortletDescription

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

Specified by:: getPortletDescription in interface Portal

getPortletDescription

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

Specified by:: getPortletDescription in interface Portal

getPortletDescription

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

Specified by:: getPortletDescription in interface Portal

getPortletDescription

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

Specified by:: getPortletDescription in interface Portal

getPortletFriendlyURLMapperLayoutQueryStringComposite

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

Throws:: PortalException

getPortletId

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

Specified by:: getPortletId in interface Portal

getPortletId

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

Specified by:: getPortletId in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletLongTitle

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

Specified by:: getPortletLongTitle in interface Portal

getPortletNamespace

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

Specified by:: getPortletNamespace in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletTitle

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

Specified by:: getPortletTitle in interface Portal

getPortletXmlFileName
```
public java.lang.String getPortletXmlFileName()
```
Specified by:

getPortletXmlFileName in interface Portal

getPreferences

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

Specified by:: getPreferences in interface Portal

getPreferencesValidator

public javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

Specified by:: getPreferencesValidator in interface Portal

getRelativeHomeURL

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

Specified by:: getRelativeHomeURL in interface Portal
Throws:: PortalException

getResourceBundle

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

Specified by:: getResourceBundle in interface Portal

getScopeGroupId

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

Specified by:: getScopeGroupId in interface Portal
Throws:: PortalException

getScopeGroupId

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

Specified by:: getScopeGroupId in interface Portal
Throws:: PortalException

getScopeGroupId

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

Specified by:: getScopeGroupId in interface Portal
Throws:: PortalException

getScopeGroupId
```
public long getScopeGroupId(Layout layout)
```
Specified by:

getScopeGroupId in interface Portal

getScopeGroupId

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

Specified by:: getScopeGroupId in interface Portal

getScopeGroupId
```
public long getScopeGroupId(long plid)
```
Specified by:

getScopeGroupId in interface Portal

getScopeGroupId

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

Specified by:: getScopeGroupId in interface Portal
Throws:: PortalException

getSelectedUser

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

Specified by:: getSelectedUser in interface Portal
Throws:: PortalException

getSelectedUser

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

Specified by:: getSelectedUser in interface Portal
Throws:: PortalException

getSelectedUser

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

Specified by:: getSelectedUser in interface Portal
Throws:: PortalException

getSelectedUser

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

Specified by:: getSelectedUser in interface Portal
Throws:: PortalException

getServletContextName
```
public java.lang.String getServletContextName()
```
Specified by:

getServletContextName in interface Portal

getSharedContentSiteGroupIds

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

Specified by:: getSharedContentSiteGroupIds in interface Portal
Throws:: PortalException

getSiteAdministrationURL

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

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

#getControlPanelPortletURL(PortletRequest, Group, String,
             String)

Specified by:: getSiteAdministrationURL in interface Portal

getSiteAdministrationURL

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

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

#getControlPanelPortletURL(PortletRequest, Group, String,
             String)

Specified by:: getSiteAdministrationURL in interface Portal

getSiteAdminURL

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

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

Specified by:: getSiteAdminURL in interface Portal
Throws:: PortalException

getSiteAdminURL

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

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

Specified by:: getSiteAdminURL in interface Portal
Throws:: PortalException

getSiteAdminURL

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

Specified by:: getSiteAdminURL in interface Portal
Throws:: PortalException

getSiteAndCompanyGroupIds
```
@Deprecated
public long[] getSiteAndCompanyGroupIds(long groupId)
                                             throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Specified by:

getSiteAndCompanyGroupIds in interface Portal

Throws:

PortalException

getSiteAndCompanyGroupIds
```
@Deprecated
public long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
                                             throws PortalException
```
Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Specified by:

getSiteAndCompanyGroupIds in interface Portal

Throws:

PortalException

getSiteDefaultLocale

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

Specified by:: getSiteDefaultLocale in interface Portal
Throws:: PortalException

getSiteDefaultLocale

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

Specified by:: getSiteDefaultLocale in interface Portal
Throws:: PortalException

getSiteGroupId
```
public long getSiteGroupId(long groupId)
```
Specified by:

getSiteGroupId in interface Portal

getSiteLoginURL
```
public java.lang.String getSiteLoginURL(ThemeDisplay themeDisplay)
                                 throws PortalException
```
Description copied from interface: Portal

Returns the URL of the login page for the current site if one is available.

Specified by:

getSiteLoginURL in interface Portal

Parameters:

themeDisplay - the theme display for the current page

Returns:

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

Throws:

PortalException - if a portal exception occurred

getStaticResourceURL

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

Specified by:: getStaticResourceURL in interface Portal

getStaticResourceURL

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

Specified by:: getStaticResourceURL in interface Portal

getStaticResourceURL

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

Specified by:: getStaticResourceURL in interface Portal

getStaticResourceURL

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

Specified by:: getStaticResourceURL in interface Portal

getStrutsAction

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

Specified by:: getStrutsAction in interface Portal

getSystemGroups
```
public java.lang.String[] getSystemGroups()
```
Specified by:

getSystemGroups in interface Portal

getSystemOrganizationRoles
```
public java.lang.String[] getSystemOrganizationRoles()
```
Specified by:

getSystemOrganizationRoles in interface Portal

getSystemRoles
```
public java.lang.String[] getSystemRoles()
```
Specified by:

getSystemRoles in interface Portal

getSystemSiteRoles
```
public java.lang.String[] getSystemSiteRoles()
```
Specified by:

getSystemSiteRoles in interface Portal

getUniqueElementId

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

Specified by:: getUniqueElementId in interface Portal

getUniqueElementId

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

Specified by:: getUniqueElementId in interface Portal

getUploadPortletRequest

public UploadPortletRequest getUploadPortletRequest(javax.portlet.PortletRequest portletRequest)

Specified by:: getUploadPortletRequest in interface Portal

getUploadServletRequest

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

Specified by:: getUploadServletRequest in interface Portal

getUptime
```
public java.util.Date getUptime()
```
Specified by:

getUptime in interface Portal

getURLWithSessionId

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

Specified by:: getURLWithSessionId in interface Portal

getUser

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

Specified by:: getUser in interface Portal
Throws:: PortalException

getUser

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

Specified by:: getUser in interface Portal
Throws:: PortalException

getUserEmailAddress
```
public java.lang.String getUserEmailAddress(long userId)
```
Specified by:

getUserEmailAddress in interface Portal

getUserId

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

Specified by:: getUserId in interface Portal

getUserId

public long getUserId(javax.portlet.PortletRequest portletRequest)

Specified by:: getUserId in interface Portal

getUserName

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

Specified by:: getUserName in interface Portal

getUserName

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

Specified by:: getUserName in interface Portal

getUserName

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

Specified by:: getUserName in interface Portal

getUserName

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

Specified by:: getUserName in interface Portal

getUserName

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

Specified by:: getUserName in interface Portal

getUserPassword

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

Specified by:: getUserPassword in interface Portal

getUserPassword

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

Specified by:: getUserPassword in interface Portal

getUserPassword

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

Specified by:: getUserPassword in interface Portal

getUserValue

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

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

Specified by:: getUserValue in interface Portal

getValidPortalDomain

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

Specified by:: getValidPortalDomain in interface Portal

getValidUserId

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

Specified by:: getValidUserId in interface Portal
Throws:: PortalException

getVirtualHostname

public java.lang.String getVirtualHostname(LayoutSet layoutSet)

Specified by:: getVirtualHostname in interface Portal

getVirtualLayoutActualURL

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

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

Specified by:: getVirtualLayoutActualURL in interface Portal
Throws:: PortalException

getVirtualLayoutFriendlyURLComposite

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

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

Specified by:: getVirtualLayoutFriendlyURLComposite in interface Portal
Throws:: PortalException

getWidgetURL

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

Specified by:: getWidgetURL in interface Portal
Throws:: PortalException

initCustomSQL
```
public void initCustomSQL()
```
Specified by:

initCustomSQL in interface Portal

initUser

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

Specified by:: initUser in interface Portal
Throws:: java.lang.Exception

invokeTaglibDiscussion

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

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

Specified by:: invokeTaglibDiscussion in interface Portal
Throws:: java.lang.Exception

invokeTaglibDiscussionPagination

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

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

Specified by:: invokeTaglibDiscussionPagination in interface Portal
Throws:: java.io.IOException; javax.portlet.PortletException

isCDNDynamicResourcesEnabled

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

Specified by:: isCDNDynamicResourcesEnabled in interface Portal
Throws:: PortalException

isCDNDynamicResourcesEnabled
```
public boolean isCDNDynamicResourcesEnabled(long companyId)
```
Specified by:

isCDNDynamicResourcesEnabled in interface Portal

isCompanyAdmin

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

Specified by:: isCompanyAdmin in interface Portal
Throws:: java.lang.Exception

isCompanyControlPanelPortlet

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

Specified by:: isCompanyControlPanelPortlet in interface Portal
Throws:: PortalException

isCompanyControlPanelPortlet

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

Specified by:: isCompanyControlPanelPortlet in interface Portal
Throws:: PortalException

isControlPanelPortlet

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

Specified by:: isControlPanelPortlet in interface Portal

isControlPanelPortlet

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

Specified by:: isControlPanelPortlet in interface Portal

isCustomPortletMode

public boolean isCustomPortletMode(javax.portlet.PortletMode portletMode)

Specified by:: isCustomPortletMode in interface Portal

isForwardedSecure

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

Specified by:: isForwardedSecure in interface Portal

isGroupAdmin

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

Specified by:: isGroupAdmin in interface Portal
Throws:: java.lang.Exception

isGroupFriendlyURL

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

Specified by:: isGroupFriendlyURL in interface Portal

isGroupOwner

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

Specified by:: isGroupOwner in interface Portal
Throws:: java.lang.Exception

isLayoutDescendant

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

Specified by:: isLayoutDescendant in interface Portal
Throws:: PortalException

isLayoutSitemapable
```
public boolean isLayoutSitemapable(Layout layout)
```
Specified by:

isLayoutSitemapable in interface Portal

isLoginRedirectRequired

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

Specified by:: isLoginRedirectRequired in interface Portal

isMethodGet

public boolean isMethodGet(javax.portlet.PortletRequest portletRequest)

Specified by:: isMethodGet in interface Portal

isMethodPost

public boolean isMethodPost(javax.portlet.PortletRequest portletRequest)

Specified by:: isMethodPost in interface Portal

isMultipartRequest

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

Specified by:: isMultipartRequest in interface Portal

isOmniadmin
```
public boolean isOmniadmin(long userId)
```
Specified by:

isOmniadmin in interface Portal

isOmniadmin
```
public boolean isOmniadmin(User user)
```
Specified by:

isOmniadmin in interface Portal

isReservedParameter
```
public boolean isReservedParameter(java.lang.String name)
```
Specified by:

isReservedParameter in interface Portal

isRightToLeft

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

Specified by:: isRightToLeft in interface Portal

isRSSFeedsEnabled
```
public boolean isRSSFeedsEnabled()
```
Specified by:

isRSSFeedsEnabled in interface Portal

isSecure

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

Specified by:: isSecure in interface Portal

isSkipPortletContentProcessing

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

Specified by:: isSkipPortletContentProcessing in interface Portal
Throws:: java.lang.Exception

isSkipPortletContentRendering

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

Specified by:: isSkipPortletContentRendering in interface Portal

isSystemGroup

public boolean isSystemGroup(java.lang.String groupName)

Specified by:: isSystemGroup in interface Portal

isSystemRole

public boolean isSystemRole(java.lang.String roleName)

Specified by:: isSystemRole in interface Portal

isUpdateAvailable
```
public boolean isUpdateAvailable()
```
Specified by:

isUpdateAvailable in interface Portal

isValidResourceId
```
public boolean isValidResourceId(java.lang.String resourceId)
```
Specified by:

isValidResourceId in interface Portal

removePortalInetSocketAddressEventListener

public boolean removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

Specified by:: removePortalInetSocketAddressEventListener in interface Portal

removePortalPortEventListener
```
@Deprecated
public void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
```
Deprecated. As of Judson (7.1.x), replaced by removePortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)

Specified by:

removePortalPortEventListener in interface Portal

resetCDNHosts
```
public void resetCDNHosts()
```
Specified by:

resetCDNHosts in interface Portal

resetPortletParameters

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

Specified by:: resetPortletParameters in interface Portal

sendError

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

Specified by:: sendError in interface Portal
Throws:: java.io.IOException

sendError

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

Specified by:: sendError in interface Portal
Throws:: java.io.IOException; javax.servlet.ServletException

sendError

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

Specified by:: sendError in interface Portal
Throws:: java.io.IOException

sendError

public 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

Specified by:: sendError in interface Portal
Throws:: java.io.IOException; javax.servlet.ServletException

sendRSSFeedsDisabledError

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

Specified by:: sendRSSFeedsDisabledError in interface Portal
Throws:: java.io.IOException; javax.servlet.ServletException

sendRSSFeedsDisabledError

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

Specified by:: sendRSSFeedsDisabledError in interface Portal
Throws:: java.io.IOException; javax.servlet.ServletException

setPageDescription
```
public void setPageDescription(java.lang.String description,
                               javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

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

Specified by:

setPageDescription in interface Portal

setPageKeywords
```
public void setPageKeywords(java.lang.String keywords,
                            javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

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

Specified by:

setPageKeywords in interface Portal

setPageSubtitle
```
public void setPageSubtitle(java.lang.String subtitle,
                            javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

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

Specified by:

setPageSubtitle in interface Portal

setPageTitle
```
public void setPageTitle(java.lang.String title,
                         javax.servlet.http.HttpServletRequest request)
```
Description copied from interface: Portal

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

Specified by:

setPageTitle in interface Portal

setPortalInetSocketAddresses

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

Specified by:: setPortalInetSocketAddresses in interface Portal

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

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

Specified by:

setPortalPort in interface Portal

storePreferences

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

Specified by:: storePreferences in interface Portal
Throws:: java.io.IOException; javax.portlet.ValidatorException

stripURLAnchor

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

Specified by:: stripURLAnchor in interface Portal

transformCustomSQL

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

Specified by:: transformCustomSQL in interface Portal

transformSQL

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

Specified by:: transformSQL in interface Portal

updateImageId

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

Specified by:: updateImageId in interface Portal
Throws:: PortalException

updatePortletMode

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

Specified by:: updatePortletMode in interface Portal
Throws:: PortalException

updateRedirect

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

Specified by:: updateRedirect in interface Portal

updateWindowState

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

Specified by:: updateWindowState in interface Portal

addDefaultResource

@Deprecated
protected void addDefaultResource(long companyId,
                                              Layout layout,
                                              Portlet portlet,
                                              boolean portletActions)
                                       throws PortalException

Deprecated. As of Wilberforce (7.0.x)

Throws:: PortalException

addDefaultResource

@Deprecated
protected void addDefaultResource(long companyId,
                                              long groupId,
                                              Layout layout,
                                              Portlet portlet,
                                              boolean portletActions)
                                       throws PortalException

Deprecated. As of Wilberforce (7.0.x)

Throws:: PortalException

addRootModelResource

@Deprecated
protected void addRootModelResource(long companyId,
                                                long groupId,
                                                Portlet portlet)
                                         throws PortalException

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

Throws:: PortalException

addRootModelResource

protected void addRootModelResource(long companyId,
                                    long groupId,
                                    java.lang.String name)
                             throws PortalException

Throws:: PortalException

buildI18NPath

@Deprecated
protected java.lang.String buildI18NPath(java.util.Locale locale)

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

doGetAncestorSiteGroups

protected java.util.Set<Group> doGetAncestorSiteGroups(long groupId,
                                                       boolean checkContentSharingWithChildrenEnabled)
                                                throws PortalException

Throws:: PortalException

doGetCurrentSiteGroup

protected Group doGetCurrentSiteGroup(long groupId)
                               throws PortalException

Throws:: PortalException

doGetPlidFromPortletId

protected long doGetPlidFromPortletId(long groupId,
                                      boolean privateLayout,
                                      java.lang.String portletId)

filterControlPanelPortlets

protected java.util.List<Portlet> filterControlPanelPortlets(java.util.Set<Portlet> portlets,
                                                             ThemeDisplay themeDisplay)

getAvailableLocale

protected java.util.Locale getAvailableLocale(long groupId,
                                              java.util.Locale locale)

getBrowsableLayout

protected Layout getBrowsableLayout(Layout layout)

getCanonicalDomain

protected java.lang.String getCanonicalDomain(java.lang.String virtualHostname,
                                              java.lang.String portalDomain)

getContextPath

protected java.lang.String getContextPath(java.lang.String contextPath)

getControlPanelDisplayGroup

protected Group getControlPanelDisplayGroup(Group controlPanelGroup,
                                            Group scopeGroup,
                                            long doAsGroupId,
                                            java.lang.String portletId)

getControlPanelDisplayGroup

protected Group getControlPanelDisplayGroup(long companyId,
                                            long scopeGroupId,
                                            long doAsGroupId,
                                            java.lang.String portletId)

getDoAsUserId

protected long getDoAsUserId(javax.servlet.http.HttpServletRequest request,
                             java.lang.String doAsUserIdString,
                             boolean alwaysAllowDoAsUser)
                      throws java.lang.Exception

Throws:: java.lang.Exception

getGroupFriendlyURL

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

Throws:: PortalException

getGroupFriendlyURL

protected java.lang.String getGroupFriendlyURL(LayoutSet layoutSet,
                                               ThemeDisplay themeDisplay,
                                               boolean canonicalURL,
                                               boolean controlPanel)
                                        throws PortalException

Throws:: PortalException

getGroupPermissions

protected java.lang.String[] getGroupPermissions(java.lang.String[] groupPermissions,
                                                 java.lang.String className,
                                                 java.lang.String inputPermissionsShowOptions)

getGuestPermissions

protected java.lang.String[] getGuestPermissions(java.lang.String[] guestPermissions,
                                                 java.lang.String className,
                                                 java.lang.String inputPermissionsShowOptions)

getPortletParam

protected java.lang.String getPortletParam(javax.servlet.http.HttpServletRequest request,
                                           java.lang.String name)

getServletURL

protected java.lang.String getServletURL(Portlet portlet,
                                         java.lang.String servletPath,
                                         ThemeDisplay themeDisplay)
                                  throws PortalException

Throws:: PortalException

isAlwaysAllowDoAsUser

protected boolean isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)
                                 throws java.lang.Exception

Throws:: java.lang.Exception

isAlwaysAllowDoAsUser

protected boolean isAlwaysAllowDoAsUser(java.lang.String actionName,
                                        java.lang.String mvcRenderCommandName,
                                        java.lang.String path,
                                        java.lang.String strutsAction)

isUnwrapRequest

protected boolean isUnwrapRequest(java.lang.String currentRequestClassName)

isValidPortalDomain

protected boolean isValidPortalDomain(long companyId,
                                      java.lang.String domain)

isValidPortalDomain

protected boolean isValidPortalDomain(java.lang.String domain)

isValidVirtualHostname

protected boolean isValidVirtualHostname(java.lang.String virtualHostname)

notifyPortalInetSocketAddressEventListeners

protected void notifyPortalInetSocketAddressEventListeners(java.net.InetSocketAddress inetSocketAddress,
                                                           boolean local,
                                                           boolean secure)

notifyPortalPortEventListeners
```
@Deprecated
protected void notifyPortalPortEventListeners(int portalPort)
```
Deprecated. As of Wilberforce (7.0.x), replaced by notifyPortalInetSocketAddressEventListeners( InetSocketAddress, boolean, boolean)

removeRedirectParameter

protected java.lang.String removeRedirectParameter(java.lang.String url)

resetThemeDisplayI18n

protected void resetThemeDisplayI18n(ThemeDisplay themeDisplay,
                                     java.lang.String languageId,
                                     java.lang.String path,
                                     java.util.Locale locale)

setLocale

protected void setLocale(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         java.util.Locale locale)

setThemeDisplayI18n

protected void setThemeDisplayI18n(ThemeDisplay themeDisplay,
                                   java.util.Locale locale)

Class PortalImpl

Field Summary

Fields inherited from interface com.liferay.portal.kernel.util.Portal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortalImpl

Method Detail

addPageDescription

addPageKeywords

addPageSubtitle

addPageTitle

addPortalInetSocketAddressEventListener

addPortalPortEventListener

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletBreadcrumbEntry

addPortletDefaultResource

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

addPreservedParameters

addUserLocaleOptionsMessage

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getAbsoluteURL

getActualLayoutQueryStringComposite

getActualURL

getAlternateURL

getAlternateURLs

getAncestorSiteGroupIds

getBaseModel

getBaseModel

getBasicAuthUserId

getBasicAuthUserId

getBrowsableScopeGroups

getCanonicalURL

getCanonicalURL

getCanonicalURL

getCDNHost

getCDNHost

getCDNHostHttp

getCDNHostHttps

getClassName

getClassNameId

getClassNameId

getCompany

getCompany

getCompanyId

getCompanyId

getCompanyIds

getComputerAddresses

getComputerName

getControlPanelFullURL

getControlPanelPlid

getControlPanelPlid

getControlPanelPortletURL

getControlPanelPortletURL

getControlPanelPortletURL

getControlPanelPortletURL

getCreateAccountURL

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroupIds

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentAndAncestorSiteGroups

getCurrentCompleteURL

getCurrentURL

getCurrentURL

getCustomSQLFunctionIsNotNull

getCustomSQLFunctionIsNull

getDate

getDate

getDate