Interface Portal


@ProviderType public interface Portal
Author:
Brian Wing Shun Chan, Eduardo Lundgren, Marco Leo
  • Field Details

  • Method Details

    • addPageDescription

      void addPageDescription(String description, javax.servlet.http.HttpServletRequest httpServletRequest)
      Appends the description to the current meta description of the page.
      Parameters:
      description - the description to append to the current meta description
      httpServletRequest - the servlet request for the page
    • addPageKeywords

      void addPageKeywords(String keywords, javax.servlet.http.HttpServletRequest httpServletRequest)
      Appends the keywords to the current meta keywords of the page.
      Parameters:
      keywords - the keywords to add to the current meta keywords (comma-separated)
      httpServletRequest - the servlet request for the page
    • addPageSubtitle

      void addPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest httpServletRequest)
      Appends the subtitle to the current subtitle of the page.
      Parameters:
      subtitle - the subtitle to append to the current subtitle
      httpServletRequest - the servlet request for the page
    • addPageTitle

      void addPageTitle(String title, javax.servlet.http.HttpServletRequest httpServletRequest)
      Appends the title to the current title of the page.
      Parameters:
      title - the title to append to the current title
      httpServletRequest - the servlet request for the page
    • addPortletBreadcrumbEntry

      void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, String title, String url)
      Adds an entry to the portlet breadcrumbs for the page.
      Parameters:
      httpServletRequest - the servlet request for the page
      title - the title of the new breakcrumb entry
      url - the URL of the new breadcrumb entry
    • addPortletBreadcrumbEntry

      void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, String title, String url, Map<String,Object> data)
      Adds an entry to the portlet breadcrumbs for the page.
      Parameters:
      httpServletRequest - the servlet request for the page
      title - the title of the new breakcrumb entry
      url - the URL of the new breadcrumb entry
      data - the HTML5 data parameters of the new breadcrumb entry
    • addPortletBreadcrumbEntry

      void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest httpServletRequest, String title, String url, Map<String,Object> data, boolean portletBreadcrumbEntry)
      Adds an entry to the portlet breadcrumbs for the page.
      Parameters:
      httpServletRequest - the servlet request for the page
      title - the title of the new breakcrumb entry
      url - the URL of the new breadcrumb entry
      data - the HTML5 data parameters of the new breadcrumb entry
      portletBreadcrumbEntry - whether the entry is a portlet breadcrumb entry
    • addPortletDefaultResource

      void addPortletDefaultResource(javax.servlet.http.HttpServletRequest httpServletRequest, Portlet portlet) throws PortalException
      Adds the default resource permissions for the portlet to the page.
      Parameters:
      httpServletRequest - the servlet request for the page
      portlet - the portlet
      Throws:
      PortalException - if a portal exception occurred
    • addPortletDefaultResource

      void addPortletDefaultResource(long companyId, Layout layout, Portlet portlet) throws PortalException
      Throws:
      PortalException
    • addPreservedParameters

      String addPreservedParameters(ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser)
      Adds the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well.

      Preserved parameters are parameters that should be sent with every request as the user navigates the portal.

      Parameters:
      themeDisplay - the current theme display
      layout - the current layout
      url - the URL
      doAsUser - whether to include doAsUserId and doAsLanguageId in the URL if they are available. If false, doAsUserId and doAsUserLanguageId will never be added.
      Returns:
      the URL with the preserved parameters added
    • addPreservedParameters

      String addPreservedParameters(ThemeDisplay themeDisplay, String url)
      Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, and refererPlid to the URL.
      Parameters:
      themeDisplay - the current theme display
      url - the URL
      Returns:
      the URL with the preserved parameters added
    • addPreservedParameters

      String addPreservedParameters(ThemeDisplay themeDisplay, String url, boolean typeControlPanel, boolean doAsUser)
    • copyRequestParameters

      void copyRequestParameters(ActionRequest actionRequest, ActionResponse actionResponse)
      Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters.
      Parameters:
      actionRequest - the request from which to get the request parameters
      actionResponse - the response to receive the render parameters
    • escapeRedirect

      String escapeRedirect(String url)
      Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects.
      Parameters:
      url - the URL to escape
      Returns:
      the escaped URL, or null if the URL is not an allowed for redirects
    • generateRandomKey

      String generateRandomKey(javax.servlet.http.HttpServletRequest httpServletRequest, String input)
      Generates a random key to identify the request based on the input string.
      Parameters:
      httpServletRequest - the servlet request for the page
      input - the input string
      Returns:
      the generated key
    • getAbsoluteURL

      String getAbsoluteURL(javax.servlet.http.HttpServletRequest httpServletRequest, String url)
    • getActualLayoutQueryStringComposite

      LayoutQueryStringComposite getActualLayoutQueryStringComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException
      Throws:
      PortalException
    • getActualURL

      String getActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException
      Throws:
      PortalException
    • getAlternateURL

      String getAlternateURL(String canonicalURL, ThemeDisplay themeDisplay, Locale locale, Layout layout) throws PortalException
      Returns the alternate URL for the requested canonical URL in the given locale.

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

      Parameters:
      canonicalURL - the canonical URL being requested. For more information, see getCanonicalURL(java.lang.String, com.liferay.portal.kernel.theme.ThemeDisplay, com.liferay.portal.kernel.model.Layout).
      themeDisplay - the theme display
      locale - the locale of the alternate (translated) page
      layout - the page being requested
      Returns:
      the alternate URL for the requested canonical URL in the given locale
      Throws:
      PortalException - if a portal exception occurred
    • getAlternateURLs

      Map<Locale,String> getAlternateURLs(String canonicalURL, ThemeDisplay themeDisplay, Layout layout) throws PortalException
      Throws:
      PortalException
    • getAlternateURLs

      Map<Locale,String> getAlternateURLs(String canonicalURL, ThemeDisplay themeDisplay, Layout layout, Set<Locale> availableLocales) throws PortalException
      Throws:
      PortalException
    • getAncestorSiteGroupIds

      long[] getAncestorSiteGroupIds(long groupId)
    • getCanonicalURL

      String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout) throws PortalException
      Returns the canonical URL of the page, to distinguish it among its translations.
      Parameters:
      completeURL - the complete URL of the page
      themeDisplay - the current theme display
      layout - the layout. If it is null, then it is generated for the current layout
      Returns:
      the canonical URL
      Throws:
      PortalException - if a portal exception occurred
    • getCanonicalURL

      String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL) throws PortalException
      Returns the canonical URL of the page, to distinguish it among its translations.
      Parameters:
      completeURL - the complete URL of the page
      themeDisplay - the current theme display
      layout - the layout. If it is null, then it is generated for the current layout
      forceLayoutFriendlyURL - adds the page friendly URL to the canonical URL even if it is not needed
      Returns:
      the canonical URL
      Throws:
      PortalException - if a portal exception occurred
    • getCanonicalURL

      String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL, boolean includeQueryString) throws PortalException
      Returns the canonical URL of the page. The canonical URL is often used to distinguish a preferred page from its translations.

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

      Parameters:
      completeURL - the complete URL of the page
      themeDisplay - the theme display
      layout - the page being requested (optionally null). If null is specified, the current page is used.
      forceLayoutFriendlyURL - whether to add the page's friendly URL to the canonical URL
      includeQueryString - whether to add the URL query string to the canonical URL
      Returns:
      the canonical URL
      Throws:
      PortalException - if a portal exception occurred
    • getCDNHost

      String getCDNHost(boolean secure)
      Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.
      Parameters:
      secure - whether to get the secure or insecure CDN host address
      Returns:
      the CDN host address
    • getCDNHost

      String getCDNHost(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getCDNHostHttp

      String getCDNHostHttp(long companyId)
      Returns the insecure (HTTP) content distribution network (CDN) host address
      Parameters:
      companyId - the company ID of a site
      Returns:
      the CDN host address
    • getCDNHostHttps

      String getCDNHostHttps(long companyId)
      Returns the secure (HTTPS) content distribution network (CDN) host address
      Parameters:
      companyId - the company ID of a site
      Returns:
      the CDN host address
    • getClassName

      String getClassName(long classNameId)
      Returns the fully qualified name of the class from its ID.
      Parameters:
      classNameId - the ID of the class
      Returns:
      the fully qualified name of the class
    • getClassNameId

      long getClassNameId(Class<?> clazz)
      Returns the ID of the class from its class object.
      Parameters:
      clazz - the class object
      Returns:
      the ID of the class
    • getClassNameId

      long getClassNameId(String value)
      Returns the ID of the class from its fully qualified name.
      Parameters:
      value - the fully qualified name of the class
      Returns:
      the ID of the class
    • getCompany

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

      Company getCompany(PortletRequest portletRequest) throws PortalException
      Throws:
      PortalException
    • getCompanyId

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

      long getCompanyId(PortletRequest portletRequest)
    • getCompanyIds

      long[] getCompanyIds()
    • getComputerAddresses

      Set<String> getComputerAddresses()
    • getComputerName

      String getComputerName()
    • getControlPanelFullURL

      String getControlPanelFullURL(long scopeGroupId, String ppid, Map<String,String[]> params) throws PortalException
      Throws:
      PortalException
    • getControlPanelPlid

      long getControlPanelPlid(long companyId) throws PortalException
      Throws:
      PortalException
    • getControlPanelPlid

      long getControlPanelPlid(PortletRequest portletRequest) throws PortalException
      Throws:
      PortalException
    • getControlPanelPortletURL

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

      PortletURL getControlPanelPortletURL(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId, String lifecycle)
    • getControlPanelPortletURL

      PortletURL getControlPanelPortletURL(PortletRequest portletRequest, Group group, String portletId, long refererGroupId, long refererPlid, String lifecycle)
    • getControlPanelPortletURL

      PortletURL getControlPanelPortletURL(PortletRequest portletRequest, String portletId, String lifecycle)
    • getCreateAccountURL

      String getCreateAccountURL(javax.servlet.http.HttpServletRequest httpServletRequest, ThemeDisplay themeDisplay) throws Exception
      Throws:
      Exception
    • getCurrentAndAncestorSiteGroupIds

      long[] getCurrentAndAncestorSiteGroupIds(long groupId)
    • getCurrentAndAncestorSiteGroupIds

      long[] getCurrentAndAncestorSiteGroupIds(long groupId, boolean checkContentSharingWithChildrenEnabled)
    • getCurrentAndAncestorSiteGroupIds

      long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds)
    • getCurrentAndAncestorSiteGroupIds

      long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
    • getCurrentAndAncestorSiteGroups

      List<Group> getCurrentAndAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)
    • getCurrentAndAncestorSiteGroups

      List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
    • getCurrentCompleteURL

      String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getCurrentURL

      String getCurrentURL(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getCurrentURL

      String getCurrentURL(PortletRequest portletRequest)
    • getCustomSQLFunctionIsNotNull

      String getCustomSQLFunctionIsNotNull()
    • getCustomSQLFunctionIsNull

      String getCustomSQLFunctionIsNull()
    • getDate

      Date getDate(int month, int day, int year)
      Returns the date object for the specified month, day, and year, or null if the date is invalid.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      Returns:
      the date object, or null if the date is invalid
    • getDate

      Date getDate(int month, int day, int year, Class<? extends PortalException> clazz) throws PortalException
      Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
      Returns:
      the date object, or null if the date is invalid and no exception to throw was provided
      Throws:
      PortalException - if a portal exception occurred
    • getDate

      Date getDate(int month, int day, int year, int hour, int min, Class<? extends PortalException> clazz) throws PortalException
      Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      hour - the hour (0-24)
      min - the minute of the hour
      clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
      Returns:
      the date object, or null if the date is invalid and no exception to throw was provided
      Throws:
      PortalException - if a portal exception occurred
    • getDate

      Date getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, Class<? extends PortalException> clazz) throws PortalException
      Returns the date object for the specified month, day, year, hour, minute, and time zone, optionally throwing an exception if the date is invalid.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      hour - the hour (0-24)
      min - the minute of the hour
      timeZone - the time zone of the date
      clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
      Returns:
      the date object, or null if the date is invalid and no exception to throw was provided
      Throws:
      PortalException - if a portal exception occurred
    • getDate

      Date getDate(int month, int day, int year, TimeZone timeZone, Class<? extends PortalException> clazz) throws PortalException
      Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid.
      Parameters:
      month - the month (0-based, meaning 0 for January)
      day - the day of the month
      year - the year
      timeZone - the time zone of the date
      clazz - the exception class to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
      Returns:
      the date object, or null if the date is invalid and no exception to throw was provided
      Throws:
      PortalException - if a portal exception occurred
    • getDefaultCompanyId

      long getDefaultCompanyId()
    • getEmailFromAddress

      String getEmailFromAddress(PortletPreferences portletPreferences, long companyId, String defaultValue)
    • getEmailFromName

      String getEmailFromName(PortletPreferences portletPreferences, long companyId, String defaultValue)
    • getForwardedHost

      String getForwardedHost(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getForwardedPort

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

      String getFullName(String firstName, String middleName, String lastName)
    • getGoogleGadgetURL

      String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getGroupFriendlyURL

      String getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, boolean canonicalURL, boolean controlPanel) throws PortalException
      Throws:
      PortalException
    • getGroupFriendlyURL

      String getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, Locale locale) throws PortalException
      Throws:
      PortalException
    • getGroupFriendlyURLIndex

      int[] getGroupFriendlyURLIndex(String requestURI)
    • getHomeURL

      String getHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getHost

      String getHost(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getHost

      String getHost(PortletRequest portletRequest)
    • getHttpServletRequest

      javax.servlet.http.HttpServletRequest getHttpServletRequest(PortletRequest portletRequest)
    • getHttpServletResponse

      javax.servlet.http.HttpServletResponse getHttpServletResponse(PortletResponse portletResponse)
    • getI18nPathLanguageId

      String getI18nPathLanguageId(Locale locale, String defaultI18nPathLanguageId)
    • getJsSafePortletId

      String getJsSafePortletId(String portletId)
    • getLayoutActualURL

      String getLayoutActualURL(Layout layout)
    • getLayoutActualURL

      String getLayoutActualURL(Layout layout, String mainPath)
    • getLayoutActualURL

      String getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException
      Throws:
      PortalException
    • getLayoutFriendlyURL

      String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutFriendlyURL

      String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, Locale locale) throws PortalException
      Throws:
      PortalException
    • getLayoutFriendlyURL

      String getLayoutFriendlyURL(ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutFriendlyURLSeparatorComposite

      LayoutFriendlyURLSeparatorComposite getLayoutFriendlyURLSeparatorComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException
      Throws:
      PortalException
    • getLayoutFullURL

      String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutFullURL

      String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser) throws PortalException
      Throws:
      PortalException
    • getLayoutFullURL

      String getLayoutFullURL(long groupId, String portletId) throws PortalException
      Throws:
      PortalException
    • getLayoutFullURL

      String getLayoutFullURL(long groupId, String portletId, boolean secure) throws PortalException
      Throws:
      PortalException
    • getLayoutFullURL

      String getLayoutFullURL(ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutRelativeURL

      String getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutRelativeURL

      String getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser) throws PortalException
      Throws:
      PortalException
    • getLayoutSetDisplayURL

      String getLayoutSetDisplayURL(LayoutSet layoutSet, boolean secureConnection) throws PortalException
      Throws:
      PortalException
    • getLayoutSetFriendlyURL

      String getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutTarget

      String getLayoutTarget(Layout layout)
    • getLayoutURL

      String getLayoutURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLayoutURL

      String getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser) throws PortalException
      Throws:
      PortalException
    • getLayoutURL

      String getLayoutURL(Layout layout, ThemeDisplay themeDisplay, Locale locale) throws PortalException
      Throws:
      PortalException
    • getLayoutURL

      String getLayoutURL(ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getLiferayPortletRequest

      LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)
    • getLiferayPortletResponse

      LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)
    • getLocale

      Locale getLocale(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getLocale

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

      Locale getLocale(PortletRequest portletRequest)
    • getMailId

      String getMailId(String mx, String popPortletPrefix, Object... ids)
    • getNetvibesURL

      String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getNewPortletTitle

      String getNewPortletTitle(String portletTitle, String oldScopeName, String newScopeName)
    • getOriginalServletRequest

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

      String getPathContext()
    • getPathContext

      String getPathContext(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getPathContext

      String getPathContext(PortletRequest portletRequest)
    • getPathContext

      String getPathContext(String contextPath)
    • getPathFriendlyURLPrivateGroup

      String getPathFriendlyURLPrivateGroup()
    • getPathFriendlyURLPrivateUser

      String getPathFriendlyURLPrivateUser()
    • getPathFriendlyURLPublic

      String getPathFriendlyURLPublic()
    • getPathImage

      String getPathImage()
    • getPathMain

      String getPathMain()
    • getPathModule

      String getPathModule()
    • getPathProxy

      String getPathProxy()
    • getPlidFromFriendlyURL

      long getPlidFromFriendlyURL(long companyId, String friendlyURL)
    • getPlidFromPortletId

      long getPlidFromPortletId(long groupId, boolean privateLayout, String portletId) throws PortalException
      Throws:
      PortalException
    • getPlidFromPortletId

      long getPlidFromPortletId(long groupId, String portletId) throws PortalException
      Throws:
      PortalException
    • getPortalLocalPort

      int getPortalLocalPort(boolean secure)
    • getPortalProperties

      Properties getPortalProperties()
    • getPortalServerPort

      int getPortalServerPort(boolean secure)
    • getPortalURL

      String getPortalURL(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getPortalURL

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

      String getPortalURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getPortalURL

      String getPortalURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)
    • getPortalURL

      String getPortalURL(PortletRequest portletRequest)
    • getPortalURL

      String getPortalURL(PortletRequest portletRequest, boolean secure)
    • getPortalURL

      String getPortalURL(String serverName, int serverPort, boolean secure)
    • getPortalURL

      String getPortalURL(ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • getPortletConfig

      PortletConfig getPortletConfig(long companyId, String portletId, javax.servlet.ServletContext servletContext) throws PortletException
      Throws:
      PortletException
    • getPortletDescription

      String getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
    • getPortletDescription

      String getPortletDescription(Portlet portlet, User user)
    • getPortletDescription

      String getPortletDescription(String portletId, Locale locale)
    • getPortletDescription

      String getPortletDescription(String portletId, String languageId)
    • getPortletDescription

      String getPortletDescription(String portletId, User user)
    • getPortletFriendlyURLMapperLayoutQueryStringComposite

      LayoutQueryStringComposite getPortletFriendlyURLMapperLayoutQueryStringComposite(String url, Map<String,String[]> params, Map<String,Object> requestContext)
    • getPortletId

      String getPortletId(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getPortletId

      String getPortletId(PortletRequest portletRequest)
    • getPortletLongTitle

      String getPortletLongTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
    • getPortletLongTitle

      String getPortletLongTitle(String portletId, Locale locale)
    • getPortletNamespace

      String getPortletNamespace(String portletId)
    • getPortletTitle

      String getPortletTitle(Portlet portlet, Locale locale)
    • getPortletTitle

      String getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
    • getPortletTitle

      String getPortletTitle(Portlet portlet, String languageId)
    • getPortletTitle

      String getPortletTitle(Portlet portlet, User user)
    • getPortletTitle

      String getPortletTitle(PortletRequest portletRequest)
    • getPortletTitle

      String getPortletTitle(PortletResponse portletResponse)
    • getPortletTitle

      String getPortletTitle(String portletId, Locale locale)
    • getPortletTitle

      String getPortletTitle(String portletId, ResourceBundle resourceBundle)
    • getPortletTitle

      String getPortletTitle(String portletId, String languageId)
    • getPortletTitle

      String getPortletTitle(String portletId, User user)
    • getPreferences

      PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getPreferencesValidator

      PreferencesValidator getPreferencesValidator(Portlet portlet)
    • getRelativeHomeURL

      String getRelativeHomeURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getResourceBundle

      ResourceBundle getResourceBundle(Locale locale)
    • getScopeGroupId

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

      long getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId) throws PortalException
      Throws:
      PortalException
    • getScopeGroupId

      long getScopeGroupId(javax.servlet.http.HttpServletRequest httpServletRequest, String portletId, boolean checkStagingGroup) throws PortalException
      Throws:
      PortalException
    • getScopeGroupId

      long getScopeGroupId(Layout layout)
    • getScopeGroupId

      long getScopeGroupId(Layout layout, String portletId)
    • getScopeGroupId

      long getScopeGroupId(long plid)
    • getScopeGroupId

      long getScopeGroupId(PortletRequest portletRequest) throws PortalException
      Throws:
      PortalException
    • getSelectedUser

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

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

      User getSelectedUser(PortletRequest portletRequest) throws PortalException
      Throws:
      PortalException
    • getSelectedUser

      User getSelectedUser(PortletRequest portletRequest, boolean checkPermission) throws PortalException
      Throws:
      PortalException
    • getServletContextName

      String getServletContextName()
    • getSharedContentSiteGroupIds

      long[] getSharedContentSiteGroupIds(long companyId, long groupId, long userId) throws PortalException
      Throws:
      PortalException
    • getSiteAdminURL

      String getSiteAdminURL(String portalURL, Group group, String ppid, Map<String,String[]> params) throws PortalException
      Throws:
      PortalException
    • getSiteAdminURL

      String getSiteAdminURL(ThemeDisplay themeDisplay, String ppid, Map<String,String[]> params) throws PortalException
      Throws:
      PortalException
    • getSiteDefaultLocale

      Locale getSiteDefaultLocale(Group group) throws PortalException
      Throws:
      PortalException
    • getSiteDefaultLocale

      Locale getSiteDefaultLocale(long groupId) throws PortalException
      Throws:
      PortalException
    • getSiteGroupId

      long getSiteGroupId(long groupId)
    • getSiteLoginURL

      String getSiteLoginURL(ThemeDisplay themeDisplay) throws PortalException
      Returns the URL of the login page for the current site if one is available.
      Parameters:
      themeDisplay - the theme display for the current page
      Returns:
      the URL of the login page for the current site, or null if one is not available
      Throws:
      PortalException - if a portal exception occurred
    • getStaticResourceURL

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

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

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

      String getStaticResourceURL(javax.servlet.http.HttpServletRequest httpServletRequest, String uri, String queryString, long timestamp)
    • getStrutsAction

      String getStrutsAction(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getSystemGroups

      String[] getSystemGroups()
    • getSystemOrganizationRoles

      String[] getSystemOrganizationRoles()
    • getSystemRoles

      String[] getSystemRoles()
    • getSystemSiteRoles

      String[] getSystemSiteRoles()
    • getUniqueElementId

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

      String getUniqueElementId(PortletRequest request, String namespace, String id)
    • getUploadPortletRequest

      UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)
    • getUploadServletRequest

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

      UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest httpServletRequest, int fileSizeThreshold, String location)
    • getUptime

      Date getUptime()
    • getURLWithSessionId

      String getURLWithSessionId(String url, String sessionId)
    • getUser

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

      User getUser(PortletRequest portletRequest) throws PortalException
      Throws:
      PortalException
    • getUserEmailAddress

      String getUserEmailAddress(long userId)
    • getUserId

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

      long getUserId(PortletRequest portletRequest)
    • getUserName

      String getUserName(BaseModel<?> baseModel)
    • getUserName

      String getUserName(long userId, String defaultUserName)
    • getUserName

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

      String getUserName(long userId, String defaultUserName, String userAttribute)
    • getUserName

      String getUserName(long userId, String defaultUserName, String userAttribute, javax.servlet.http.HttpServletRequest httpServletRequest)
    • getUserPassword

      String getUserPassword(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getUserPassword

      String getUserPassword(javax.servlet.http.HttpSession httpSession)
    • getUserPassword

      String getUserPassword(PortletRequest portletRequest)
    • getValidPortalDomain

      String getValidPortalDomain(long companyId, String domain)
    • getValidUserId

      long getValidUserId(long companyId, long userId) throws PortalException
      Throws:
      PortalException
    • getVirtualHostnames

      TreeMap<String,String> getVirtualHostnames(LayoutSet layoutSet)
    • getWidgetURL

      String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException
      Throws:
      PortalException
    • initUser

      User initUser(javax.servlet.http.HttpServletRequest httpServletRequest) throws Exception
      Throws:
      Exception
    • isCDNDynamicResourcesEnabled

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

      boolean isCDNDynamicResourcesEnabled(long companyId)
    • isCompanyAdmin

      boolean isCompanyAdmin(User user) throws Exception
      Throws:
      Exception
    • isCustomPortletMode

      boolean isCustomPortletMode(PortletMode portletMode)
    • isForwardedSecure

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

      boolean isGroupAdmin(User user, long groupId) throws Exception
      Throws:
      Exception
    • isGroupControlPanelPath

      boolean isGroupControlPanelPath(String path)
    • isGroupFriendlyURL

      boolean isGroupFriendlyURL(String fullURL, String groupFriendlyURL, String layoutFriendlyURL)
    • isGroupOwner

      boolean isGroupOwner(User user, long groupId) throws Exception
      Throws:
      Exception
    • isLayoutDescendant

      boolean isLayoutDescendant(Layout layout, long layoutId) throws PortalException
      Throws:
      PortalException
    • isLayoutSitemapable

      boolean isLayoutSitemapable(Layout layout)
    • isLoginRedirectRequired

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

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

      boolean isOmniadmin(long userId)
    • isOmniadmin

      boolean isOmniadmin(User user)
    • isReservedParameter

      boolean isReservedParameter(String name)
    • isRightToLeft

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

      boolean isRSSFeedsEnabled()
    • isSecure

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

      boolean isSkipPortletContentRendering(Group group, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, String portletName)
    • isSystemGroup

      boolean isSystemGroup(String groupName)
    • isSystemRole

      boolean isSystemRole(String roleName)
    • isValidPortalDomain

      boolean isValidPortalDomain(long companyId, String domain)
    • isValidResourceId

      boolean isValidResourceId(String resourceId)
    • resetCDNHosts

      void resetCDNHosts()
    • sendError

      void sendError(Exception exception, ActionRequest actionRequest, ActionResponse actionResponse) throws IOException
      Throws:
      IOException
    • sendError

      void sendError(Exception exception, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • sendError

      void sendError(int status, Exception exception, ActionRequest actionRequest, ActionResponse actionResponse) throws IOException
      Throws:
      IOException
    • sendError

      void sendError(int status, Exception exception, javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • sendRSSFeedsDisabledError

      void sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • sendRSSFeedsDisabledError

      void sendRSSFeedsDisabledError(PortletRequest portletRequest, PortletResponse portletResponse) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • setPageDescription

      void setPageDescription(String description, javax.servlet.http.HttpServletRequest httpServletRequest)
      Sets the description for the page, overriding the existing page description.
    • setPageKeywords

      void setPageKeywords(String keywords, javax.servlet.http.HttpServletRequest httpServletRequest)
      Sets the keywords for the page, overriding the existing page keywords.
    • setPageSubtitle

      void setPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest httpServletRequest)
      Sets the subtitle for the page, overriding the existing page subtitle.
    • setPageTitle

      void setPageTitle(String title, javax.servlet.http.HttpServletRequest httpServletRequest)
      Sets the whole title for the page, overriding the existing page whole title.
    • setPortalInetSocketAddresses

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

      String[] stripURLAnchor(String url, String separator)
    • transformCustomSQL

      String transformCustomSQL(String sql)
    • transformSQL

      String transformSQL(String sql)
    • updateImageId

      void updateImageId(BaseModel<?> baseModel, boolean image, byte[] bytes, String fieldName, long maxSize, int maxHeight, int maxWidth) throws PortalException
      Throws:
      PortalException
    • updatePortletMode

      PortletMode updatePortletMode(String portletId, User user, Layout layout, PortletMode portletMode, javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • updateRedirect

      String updateRedirect(String redirect, String oldPath, String newPath)
    • updateWindowState

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