Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.1.2-ce-ga3
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.util
Class PortalImpl

java.lang.Object
  extended by com.liferay.portal.util.PortalImpl
All Implemented Interfaces:
Portal
public class PortalImpl
extends Object
implements Portal

Field Summary
 
Fields inherited from interface com.liferay.portal.util.Portal
FRIENDLY_URL_SEPARATOR, PATH_IMAGE, PATH_MAIN, PATH_PORTAL_LAYOUT, PORTAL_REALM, PORTLET_XML_FILE_NAME_CUSTOM, PORTLET_XML_FILE_NAME_STANDARD, TEMP_OBFUSCATION_VALUE
 
Constructor Summary
PortalImpl()
           
 
Method Summary
protected  void addDefaultResource(long companyId, Layout layout, Portlet portlet, boolean portletActions)
           
protected  void addDefaultResource(long companyId, long groupId, Layout layout, Portlet portlet, boolean portletActions)
           
 void addPageDescription(String description, javax.servlet.http.HttpServletRequest request)
          Appends the description to the current meta description of the page.
 void addPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)
          Appends the keywords to the current meta keywords of the page.
 void addPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)
          Appends the subtitle to the current subtitle of the page.
 void addPageTitle(String title, javax.servlet.http.HttpServletRequest request)
          Appends the title to the current title of the page.
 void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
          Adds the portal port event listener to the portal.
 void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url)
          Adds an entry to the portlet breadcrumbs for the page.
 void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url, Map<String,Object> data)
          Adds an entry to the portlet breadcrumbs for the page.
 void addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)
          Adds the default resource permissions for the portlet to the page.
 void addPortletDefaultResource(long companyId, Layout layout, Portlet portlet)
           
 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.
 String addPreservedParameters(ThemeDisplay themeDisplay, String url)
          Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, refererPlid, and controlPanelCategory to the URL.
protected  String buildI18NPath(Locale locale)
           
 void clearRequestParameters(RenderRequest renderRequest)
          Clears the render parameters in the request if the portlet is in the action phase.
 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.
protected  long doGetPlidFromPortletId(long groupId, boolean privateLayout, String portletId)
           
 String escapeRedirect(String url)
          Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects.
protected  List<Portlet> filterControlPanelPortlets(Set<Portlet> portlets, String category, ThemeDisplay themeDisplay)
           
 String generateRandomKey(javax.servlet.http.HttpServletRequest request, String input)
          Generates a random key to identify the request based on the input string.
 String getActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
           
 Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request)
          Returns an array with the alternate locales, considering if the page is showing just a content and the translations of this content.
 String getAlternateURL(javax.servlet.http.HttpServletRequest request, String canonicalURL, Locale locale)
          Deprecated. getAlternateURL(String, ThemeDisplay, Locale)
 String getAlternateURL(String canonicalURL, ThemeDisplay themeDisplay, Locale locale)
          Returns the alternate URL of the page, to distinguish it from its canonical URL.
 Set<String> getAuthTokenIgnoreActions()
          Returns the set of struts actions that should not be checked for an authentication token.
 Set<String> getAuthTokenIgnorePortlets()
          Returns the set of IDs of portlets that should not be checked for an authentication token.
protected  Locale getAvailableLocale(Locale locale)
           
 BaseModel<?> getBaseModel(Resource resource)
          Returns the base model instance for the resource.
 BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
          Returns the base model instance for the resource permission.
 BaseModel<?> getBaseModel(String modelName, String primKey)
          Returns the base model instance for the model name and primary key.
 long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
          Returns the user's ID from the HTTP authentication headers after validating their credentials.
 long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)
          Returns the user's ID from the HTTP authentication headers after validation their credentials.
 String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay)
          Deprecated. getCanonicalURL(String, ThemeDisplay, Layout)
 String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout)
          Returns the canonical URL of the page, to distinguish it among its translations.
 String getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL)
          Returns the canonical URL of the page, to distinguish it among its translations.
 String getCDNHost()
          Deprecated. getCDNHost(boolean)
 String getCDNHost(boolean secure)
          Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal.
 String getCDNHost(javax.servlet.http.HttpServletRequest request)
           
 String getCDNHostHttp(long companyId)
          Returns the insecure (HTTP) content distribution network (CDN) host address
 String getCDNHostHttps(long companyId)
          Returns the secure (HTTPS) content distribution network (CDN) host address
 String getClassName(long classNameId)
          Returns the fully qualified name of the class from its ID.
 long getClassNameId(Class<?> clazz)
          Returns the ID of the class from its class object.
 long getClassNameId(String value)
          Returns the ID of the class from its fully qualified name.
 String getClassNamePortletId(String className)
          Returns the ID of certain portlets from the fully qualified name of one of their classes.
 Company getCompany(javax.servlet.http.HttpServletRequest request)
           
 Company getCompany(PortletRequest portletRequest)
           
 long getCompanyId(javax.servlet.http.HttpServletRequest request)
           
 long getCompanyId(PortletRequest portletRequest)
           
 long[] getCompanyIds()
           
 String getComputerAddress()
           
 String getComputerName()
           
 String getControlPanelCategory(String portletId, ThemeDisplay themeDisplay)
           
 String getControlPanelFullURL(long scopeGroupId, String ppid, Map<String,String[]> params)
           
 Set<Portlet> getControlPanelPortlets(long companyId, String category)
           
 List<Portlet> getControlPanelPortlets(String category, ThemeDisplay themeDisplay)
           
 String getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)
           
 String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
           
 String getCurrentURL(javax.servlet.http.HttpServletRequest request)
           
 String getCurrentURL(PortletRequest portletRequest)
           
 String getCustomSQLFunctionIsNotNull()
           
 String getCustomSQLFunctionIsNull()
           
 Date getDate(int month, int day, int year)
          Returns the date object for the specified month, day, and year.
 Date getDate(int month, int day, int year, Class<? extends PortalException> clazz)
          Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid.
 Date getDate(int month, int day, int year, int hour, int min, 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.
 Date getDate(int month, int day, int year, int hour, int min, PortalException pe)
          Deprecated. getDate(int, int, int, int, int, Class)
 Date getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, 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.
 Date getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, PortalException pe)
          Deprecated. getDate(int, int, int, int, int, TimeZone, Class)
 Date getDate(int month, int day, int year, PortalException pe)
          Deprecated. getDate(int, int, int, Class)
 Date getDate(int month, int day, int year, TimeZone timeZone, 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.
 Date getDate(int month, int day, int year, TimeZone timeZone, PortalException pe)
          Deprecated. getDate(int, int, int, TimeZone, Class)
 long getDefaultCompanyId()
           
protected  long getDefaultScopeGroupId(long companyId)
           
 long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
           
protected  long getDoAsUserId(javax.servlet.http.HttpServletRequest request, String doAsUserIdString, boolean alwaysAllowDoAsUser)
           
 String getEmailFromAddress(PortletPreferences preferences, long companyId, String defaultValue)
           
 String getEmailFromName(PortletPreferences preferences, long companyId, String defaultValue)
           
 Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge, PortletRequest portletRequest)
           
 Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge, UploadPortletRequest uploadPortletRequest)
           
 Serializable getExpandoValue(PortletRequest portletRequest, String name, int type, String displayType)
           
 Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest, String name, int type, String displayType)
           
 String getFacebookURL(Portlet portlet, String facebookCanvasPageURL, ThemeDisplay themeDisplay)
           
 String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
           
 String getGlobalLibDir()
           
 String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
           
 String getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay)
           
protected  String getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay, boolean canonicalURL)
           
 String getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay, Locale locale)
           
 String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request)
           
 String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request, String className)
           
 String[] getGroupPermissions(PortletRequest portletRequest)
           
 String[] getGroupPermissions(PortletRequest portletRequest, String className)
           
 String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request)
           
 String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request, String className)
           
 String[] getGuestPermissions(PortletRequest portletRequest)
           
 String[] getGuestPermissions(PortletRequest portletRequest, String className)
           
 String getHomeURL(javax.servlet.http.HttpServletRequest request)
           
 String getHost(javax.servlet.http.HttpServletRequest request)
           
 String getHost(PortletRequest portletRequest)
           
 javax.servlet.http.HttpServletRequest getHttpServletRequest(PortletRequest portletRequest)
           
 javax.servlet.http.HttpServletResponse getHttpServletResponse(PortletResponse portletResponse)
           
 String getJournalArticleActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
           
 String getJsSafePortletId(String portletId)
           
 String getLayoutActualURL(Layout layout)
           
 String getLayoutActualURL(Layout layout, String mainPath)
           
 String getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL)
           
 String getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
           
 String getLayoutEditPage(Layout layout)
           
 String getLayoutEditPage(String type)
           
 String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
           
 String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, Locale locale)
           
 String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)
           
 String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
           
 String getLayoutFullURL(long groupId, String portletId)
           
 String getLayoutFullURL(long groupId, String portletId, boolean secure)
           
 String getLayoutFullURL(ThemeDisplay themeDisplay)
           
 String getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)
           
 String getLayoutTarget(Layout layout)
           
 String getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
           
 String getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
           
 String getLayoutURL(ThemeDisplay themeDisplay)
           
 String getLayoutViewPage(Layout layout)
           
 String getLayoutViewPage(String type)
           
 LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)
           
 LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)
           
 Locale getLocale(javax.servlet.http.HttpServletRequest request)
           
 Locale getLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean initialize)
           
 Locale getLocale(RenderRequest renderRequest)
           
 String getMailId(String mx, String popPortletPrefix, Object... ids)
           
 String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
           
 String getNewPortletTitle(String portletTitle, String oldScopeName, String newScopeName)
           
 javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
           
 long getParentGroupId(long groupId)
           
 String getPathContext()
           
 String getPathFriendlyURLPrivateGroup()
           
 String getPathFriendlyURLPrivateUser()
           
 String getPathFriendlyURLPublic()
           
 String getPathImage()
           
 String getPathMain()
           
 String getPathProxy()
           
 long getPlidFromFriendlyURL(long companyId, String friendlyURL)
           
 long getPlidFromPortletId(long groupId, boolean privateLayout, String portletId)
           
 long getPlidFromPortletId(long groupId, String portletId)
           
 String getPortalLibDir()
           
 int getPortalPort()
          Deprecated. getPortalPort(boolean)
 int getPortalPort(boolean secure)
           
 Properties getPortalProperties()
           
 String getPortalURL(javax.servlet.http.HttpServletRequest request)
           
 String getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)
           
 String getPortalURL(Layout layout, ThemeDisplay themeDisplay)
           
 String getPortalURL(PortletRequest portletRequest)
           
 String getPortalURL(PortletRequest portletRequest, boolean secure)
           
 String getPortalURL(String serverName, int serverPort, boolean secure)
           
 String getPortalURL(ThemeDisplay themeDisplay)
           
 String getPortalWebDir()
           
 Set<String> getPortletAddDefaultResourceCheckWhitelist()
           
 Set<String> getPortletAddDefaultResourceCheckWhitelistActions()
           
 List<BreadcrumbEntry> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
          Deprecated. getPortletBreadcrumbs(HttpServletRequest)
 List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
           
 String getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
           
 String getPortletDescription(Portlet portlet, User user)
           
 String getPortletDescription(String portletId, Locale locale)
           
 String getPortletDescription(String portletId, String languageId)
           
 String getPortletDescription(String portletId, User user)
           
 Object[] getPortletFriendlyURLMapper(long groupId, boolean privateLayout, String url, Map<String,String[]> params, Map<String,Object> requestContext)
           
 String getPortletId(javax.servlet.http.HttpServletRequest request)
           
 String getPortletId(PortletRequest portletRequest)
           
 String getPortletLongTitle(Portlet portlet, Locale locale)
           
 String getPortletLongTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
           
 String getPortletLongTitle(Portlet portlet, String languageId)
           
 String getPortletLongTitle(Portlet portlet, User user)
           
 String getPortletLongTitle(String portletId, Locale locale)
           
 String getPortletLongTitle(String portletId, String languageId)
           
 String getPortletLongTitle(String portletId, User user)
           
 String getPortletNamespace(String portletId)
           
protected  String getPortletParam(javax.servlet.http.HttpServletRequest request, String name)
           
 String getPortletTitle(Portlet portlet, Locale locale)
           
 String getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
           
 String getPortletTitle(Portlet portlet, String languageId)
           
 String getPortletTitle(Portlet portlet, User user)
           
 String getPortletTitle(RenderResponse renderResponse)
           
 String getPortletTitle(String portletId, Locale locale)
           
 String getPortletTitle(String portletId, String languageId)
           
 String getPortletTitle(String portletId, User user)
           
 String getPortletXmlFileName()
           
 PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
           
 PreferencesValidator getPreferencesValidator(Portlet portlet)
           
 String getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
           
 long getScopeGroupId(javax.servlet.http.HttpServletRequest request)
           
 long getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId)
           
 long getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId, boolean checkStagingGroup)
           
 long getScopeGroupId(Layout layout)
           
 long getScopeGroupId(Layout layout, String portletId)
           
 long getScopeGroupId(long plid)
           
 long getScopeGroupId(PortletRequest portletRequest)
           
 User getSelectedUser(javax.servlet.http.HttpServletRequest request)
           
 User getSelectedUser(javax.servlet.http.HttpServletRequest request, boolean checkPermission)
           
 User getSelectedUser(PortletRequest portletRequest)
           
 User getSelectedUser(PortletRequest portletRequest, boolean checkPermission)
           
 javax.servlet.ServletContext getServletContext(Portlet portlet, javax.servlet.ServletContext servletContext)
           
protected  String getServletURL(Portlet portlet, String servletPath, ThemeDisplay themeDisplay)
           
 String getSiteLoginURL(ThemeDisplay themeDisplay)
          Returns the URL of the login page for the current site if one is available.
 String getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri)
           
 String getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, long timestamp)
           
 String getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, String queryString)
           
 String getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, String queryString, long timestamp)
           
 String getStrutsAction(javax.servlet.http.HttpServletRequest request)
           
 String[] getSystemGroups()
           
 String[] getSystemOrganizationRoles()
           
 String[] getSystemRoles()
           
 String[] getSystemSiteRoles()
           
 String getUniqueElementId(javax.servlet.http.HttpServletRequest request, String namespace, String elementId)
           
 String getUniqueElementId(PortletRequest request, String namespace, String elementId)
           
 UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)
           
 UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest request)
           
 Date getUptime()
           
 String getURLWithSessionId(String url, String sessionId)
           
 User getUser(javax.servlet.http.HttpServletRequest request)
           
 User getUser(PortletRequest portletRequest)
           
 String getUserEmailAddress(long userId)
           
 long getUserId(javax.servlet.http.HttpServletRequest request)
           
 long getUserId(PortletRequest portletRequest)
           
 String getUserName(BaseModel<?> baseModel)
           
 String getUserName(long userId, String defaultUserName)
           
 String getUserName(long userId, String defaultUserName, javax.servlet.http.HttpServletRequest request)
           
 String getUserName(long userId, String defaultUserName, String userAttribute)
           
 String getUserName(long userId, String defaultUserName, String userAttribute, javax.servlet.http.HttpServletRequest request)
           
 String getUserPassword(javax.servlet.http.HttpServletRequest request)
           
 String getUserPassword(javax.servlet.http.HttpSession session)
           
 String getUserPassword(PortletRequest portletRequest)
           
 String getUserValue(long userId, String param, String defaultValue)
           
 long getValidUserId(long companyId, long userId)
           
 String getVirtualLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
           
 String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
           
protected  boolean hasPortletDefaultResource(ThemeDisplay themeDisplay, Layout layout, Portlet portlet)
           
 void initCustomSQL()
           
 User initUser(javax.servlet.http.HttpServletRequest request)
           
 boolean isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)
           
protected  boolean isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)
           
 boolean isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
           
 boolean isCDNDynamicResourcesEnabled(long companyId)
           
 boolean isCommunityAdmin(User user, long groupId)
          Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long)
 boolean isCommunityOwner(User user, long groupId)
          Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long)
 boolean isCompanyAdmin(User user)
           
 boolean isCompanyControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)
           
 boolean isCompanyControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)
           
 boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
           
 boolean isControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)
           
 boolean isControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)
           
 boolean isGroupAdmin(User user, long groupId)
           
 boolean isGroupFriendlyURL(String fullURL, String groupFriendlyURL, String layoutFriendlyURL)
           
 boolean isGroupOwner(User user, long groupId)
           
 boolean isLayoutDescendant(Layout layout, long layoutId)
           
 boolean isLayoutFirstPageable(Layout layout)
           
 boolean isLayoutFirstPageable(String type)
           
 boolean isLayoutFriendliable(Layout layout)
           
 boolean isLayoutFriendliable(String type)
           
 boolean isLayoutParentable(Layout layout)
           
 boolean isLayoutParentable(String type)
           
 boolean isLayoutSitemapable(Layout layout)
           
 boolean isMethodGet(PortletRequest portletRequest)
           
 boolean isMethodPost(PortletRequest portletRequest)
           
 boolean isMultipartRequest(javax.servlet.http.HttpServletRequest request)
           
 boolean isOmniadmin(long userId)
           
protected  boolean isPanelSelectedPortlet(ThemeDisplay themeDisplay, String portletId)
           
 boolean isReservedParameter(String name)
           
 boolean isSecure(javax.servlet.http.HttpServletRequest request)
           
 boolean isSystemGroup(String groupName)
           
 boolean isSystemRole(String roleName)
           
 boolean isUpdateAvailable()
           
 boolean isValidResourceId(String resourceId)
           
protected  void notifyPortalPortEventListeners(int portalPort)
           
 void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
           
protected  String removeRedirectParameter(String url)
           
 String renderPage(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String path)
           
 String renderPortlet(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, String queryString, boolean writeOutput)
           
 String renderPortlet(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, String queryString, String columnId, Integer columnPos, Integer columnCount, boolean writeOutput)
           
 String renderPortlet(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, String queryString, String columnId, Integer columnPos, Integer columnCount, String path, boolean writeOutput)
           
 void resetCDNHosts()
           
 Set<String> resetPortletAddDefaultResourceCheckWhitelist()
           
 Set<String> resetPortletAddDefaultResourceCheckWhitelistActions()
           
protected  void resetThemeDisplayI18n(ThemeDisplay themeDisplay, String languageId, String path)
           
 void sendError(Exception e, ActionRequest actionRequest, ActionResponse actionResponse)
           
 void sendError(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void sendError(int status, Exception e, ActionRequest actionRequest, ActionResponse actionResponse)
           
 void sendError(int status, Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
protected  void setLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Locale locale)
           
 void setPageDescription(String description, javax.servlet.http.HttpServletRequest request)
          Sets the description for the page, overriding the existing page description.
 void setPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)
          Sets the keywords for the page, overriding the existing page keywords.
 void setPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)
          Sets the subtitle for the page, overriding the existing page subtitle.
 void setPageTitle(String title, javax.servlet.http.HttpServletRequest request)
          Sets the whole title for the page, overriding the existing page whole title.
 void setPortalPort(javax.servlet.http.HttpServletRequest request)
          Sets the port obtained on the first request to the portal.
protected  void setThemeDisplayI18n(ThemeDisplay themeDisplay, Locale locale)
           
 void storePreferences(PortletPreferences portletPreferences)
           
 String[] stripURLAnchor(String url, String separator)
           
 String transformCustomSQL(String sql)
           
 String transformSQL(String sql)
           
 PortletMode updatePortletMode(String portletId, User user, Layout layout, PortletMode portletMode, javax.servlet.http.HttpServletRequest request)
           
 String updateRedirect(String redirect, String oldPath, String newPath)
           
 WindowState updateWindowState(String portletId, User user, Layout layout, 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(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(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(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(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

addPortalPortEventListener

public void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
Description copied from interface: Portal
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,
                                      String title,
                                      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,
                                      String title,
                                      String url,
                                      Map<String,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

addPortletDefaultResource

public void addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
                                      Portlet portlet)
                               throws PortalException,
                                      SystemException
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 adding the default resource permissions failed
SystemException - if a system exception occurred

addPortletDefaultResource

public void addPortletDefaultResource(long companyId,
                                      Layout layout,
                                      Portlet portlet)
                               throws PortalException,
                                      SystemException
Specified by:
addPortletDefaultResource in interface Portal
Throws:
PortalException
SystemException

addPreservedParameters

public String addPreservedParameters(ThemeDisplay themeDisplay,
                                     Layout layout,
                                     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 String addPreservedParameters(ThemeDisplay themeDisplay,
                                     String url)
Description copied from interface: Portal
Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, refererPlid, and controlPanelCategory 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

clearRequestParameters

public void clearRequestParameters(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(ActionRequest actionRequest,
                                  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 String escapeRedirect(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 String generateRandomKey(javax.servlet.http.HttpServletRequest request,
                                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

getActualURL

public String getActualURL(long groupId,
                           boolean privateLayout,
                           String mainPath,
                           String friendlyURL,
                           Map<String,String[]> params,
                           Map<String,Object> requestContext)
                    throws PortalException,
                           SystemException
Specified by:
getActualURL in interface Portal
Throws:
PortalException
SystemException

getAlternateLocales

public Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request)
                             throws PortalException,
                                    SystemException
Description copied from interface: Portal
Returns an array with the alternate locales, considering if the page is showing just a content and the translations of this content.

Specified by:
getAlternateLocales in interface Portal
Parameters:
request - the servlet request for the page
Returns:
the array of alternate locales
Throws:
PortalException
SystemException

getAlternateURL

public String getAlternateURL(javax.servlet.http.HttpServletRequest request,
                              String canonicalURL,
                              Locale locale)
Deprecated. getAlternateURL(String, ThemeDisplay, Locale)

Specified by:
getAlternateURL in interface Portal

getAlternateURL

public String getAlternateURL(String canonicalURL,
                              ThemeDisplay themeDisplay,
                              Locale locale)
Description copied from interface: Portal
Returns the alternate URL of the page, to distinguish it from its canonical URL.

Specified by:
getAlternateURL in interface Portal
Parameters:
canonicalURL - the canonical URL previously obtained
themeDisplay - the theme display
locale - the locale of the translated page
Returns:
the alternate URL

getAuthTokenIgnoreActions

public Set<String> getAuthTokenIgnoreActions()
Description copied from interface: Portal
Returns the set of struts actions that should not be checked for an authentication token.

Specified by:
getAuthTokenIgnoreActions in interface Portal
Returns:
the set of struts actions that should not be checked for an authentication token

getAuthTokenIgnorePortlets

public Set<String> getAuthTokenIgnorePortlets()
Description copied from interface: Portal
Returns the set of IDs of portlets that should not be checked for an authentication token.

Specified by:
getAuthTokenIgnorePortlets in interface Portal
Returns:
the set of IDs of portlets that should not be checked for an authentication token

getBaseModel

public BaseModel<?> getBaseModel(Resource resource)
                          throws PortalException,
                                 SystemException
Description copied from interface: Portal
Returns the base model instance for the resource.

Specified by:
getBaseModel in interface Portal
Parameters:
resource - the resource
Returns:
the base model instance, or null if the resource does not have a base model instance (such as if its a portlet)
Throws:
PortalException - if a base model instance for the resource could not be found
SystemException - if a system exception occurred

getBaseModel

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

getBaseModel

public BaseModel<?> getBaseModel(String modelName,
                                 String primKey)
                          throws PortalException,
                                 SystemException
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 base model instance with the primary key could not be found
SystemException - if a system exception occurred

getBasicAuthUserId

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

Specified by:
getBasicAuthUserId in interface Portal
Parameters:
request - the servlet request from which to retrieve the HTTP authentication headers
Returns:
the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise
Throws:
PortalException - if an authentication exception occurred
SystemException - if a system exception occurred

getBasicAuthUserId

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

Specified by:
getBasicAuthUserId in interface Portal
Parameters:
request - the servlet request to retrieve the HTTP authentication headers from
companyId - unused
Returns:
the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise
Throws:
PortalException - if an authentication exception occurred
SystemException - if a system exception occurred

getCanonicalURL

public String getCanonicalURL(String completeURL,
                              ThemeDisplay themeDisplay)
                       throws PortalException,
                              SystemException
Deprecated. getCanonicalURL(String, ThemeDisplay, Layout)

Specified by:
getCanonicalURL in interface Portal
Throws:
PortalException
SystemException

getCanonicalURL

public String getCanonicalURL(String completeURL,
                              ThemeDisplay themeDisplay,
                              Layout layout)
                       throws PortalException,
                              SystemException
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 friendly URL or the group could not be retrieved
SystemException - if a system exception occurred

getCanonicalURL

public String getCanonicalURL(String completeURL,
                              ThemeDisplay themeDisplay,
                              Layout layout,
                              boolean forceLayoutFriendlyURL)
                       throws PortalException,
                              SystemException
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 friendly URL or the group could not be retrieved
SystemException - if a system exception occurred

getCDNHost

public String getCDNHost()
Deprecated. getCDNHost(boolean)

Specified by:
getCDNHost in interface Portal

getCDNHost

public 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 String getCDNHost(javax.servlet.http.HttpServletRequest request)
                  throws PortalException,
                         SystemException
Specified by:
getCDNHost in interface Portal
Throws:
PortalException
SystemException

getCDNHostHttp

public 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
Returns:
the CDN host address

getCDNHostHttps

public 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
Returns:
the CDN host address

getClassName

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

getClassNamePortletId

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

Specified by:
getClassNamePortletId in interface Portal
Parameters:
className - the fully qualified name of a class in a portlet
Returns:
the ID of the portlet the class is a part of, or an empty string if the class is not supported

getCompany

public Company getCompany(javax.servlet.http.HttpServletRequest request)
                   throws PortalException,
                          SystemException
Specified by:
getCompany in interface Portal
Throws:
PortalException
SystemException

getCompany

public Company getCompany(PortletRequest portletRequest)
                   throws PortalException,
                          SystemException
Specified by:
getCompany in interface Portal
Throws:
PortalException
SystemException

getCompanyId

public long getCompanyId(javax.servlet.http.HttpServletRequest request)
Specified by:
getCompanyId in interface Portal

getCompanyId

public long getCompanyId(PortletRequest portletRequest)
Specified by:
getCompanyId in interface Portal

getCompanyIds

public long[] getCompanyIds()
Specified by:
getCompanyIds in interface Portal

getComputerAddress

public String getComputerAddress()
Specified by:
getComputerAddress in interface Portal

getComputerName

public String getComputerName()
Specified by:
getComputerName in interface Portal

getControlPanelCategory

public String getControlPanelCategory(String portletId,
                                      ThemeDisplay themeDisplay)
                               throws SystemException
Specified by:
getControlPanelCategory in interface Portal
Throws:
SystemException

getControlPanelFullURL

public String getControlPanelFullURL(long scopeGroupId,
                                     String ppid,
                                     Map<String,String[]> params)
                              throws PortalException,
                                     SystemException
Specified by:
getControlPanelFullURL in interface Portal
Throws:
PortalException
SystemException

getControlPanelPortlets

public Set<Portlet> getControlPanelPortlets(long companyId,
                                            String category)
                                     throws SystemException
Specified by:
getControlPanelPortlets in interface Portal
Throws:
SystemException

getControlPanelPortlets

public List<Portlet> getControlPanelPortlets(String category,
                                             ThemeDisplay themeDisplay)
                                      throws SystemException
Specified by:
getControlPanelPortlets in interface Portal
Throws:
SystemException

getCreateAccountURL

public String getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
                                  ThemeDisplay themeDisplay)
                           throws Exception
Specified by:
getCreateAccountURL in interface Portal
Throws:
Exception

getCurrentCompleteURL

public String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
Specified by:
getCurrentCompleteURL in interface Portal

getCurrentURL

public String getCurrentURL(javax.servlet.http.HttpServletRequest request)
Specified by:
getCurrentURL in interface Portal

getCurrentURL

public String getCurrentURL(PortletRequest portletRequest)
Specified by:
getCurrentURL in interface Portal

getCustomSQLFunctionIsNotNull

public String getCustomSQLFunctionIsNotNull()
Specified by:
getCustomSQLFunctionIsNotNull in interface Portal

getCustomSQLFunctionIsNull

public String getCustomSQLFunctionIsNull()
Specified by:
getCustomSQLFunctionIsNull in interface Portal

getDate

public Date getDate(int month,
                    int day,
                    int year)
Description copied from interface: Portal
Returns the date object for the specified month, day, and year.

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

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    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 the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    int hour,
                    int min,
                    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 the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    int hour,
                    int min,
                    PortalException pe)
             throws PortalException
Deprecated. getDate(int, int, int, int, int, Class)

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
pe - the exception to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
Returns:
the date object, or null if the date is invalid and no exception to throw was provided
Throws:
PortalException - if the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    int hour,
                    int min,
                    TimeZone timeZone,
                    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 the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    int hour,
                    int min,
                    TimeZone timeZone,
                    PortalException pe)
             throws PortalException
Deprecated. getDate(int, int, int, int, int, TimeZone, Class)

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
pe - the exception to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
Returns:
the date object, or null if the date is invalid and no exception to throw was provided
Throws:
PortalException - if the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    PortalException pe)
             throws PortalException
Deprecated. getDate(int, int, int, Class)

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
pe - the exception to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
Returns:
the date object, or null if the date is invalid and no exception to throw was provided
Throws:
PortalException - if the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    TimeZone timeZone,
                    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 the date was invalid and pe was not null

getDate

public Date getDate(int month,
                    int day,
                    int year,
                    TimeZone timeZone,
                    PortalException pe)
             throws PortalException
Deprecated. getDate(int, int, int, TimeZone, Class)

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
pe - the exception to throw if the date is invalid. If null, no exception will be thrown for an invalid date.
Returns:
the date object, or null if the date is invalid and no exception to throw was provided
Throws:
PortalException - if the date was invalid and pe was not null

getDefaultCompanyId

public long getDefaultCompanyId()
Specified by:
getDefaultCompanyId in interface Portal

getDigestAuthUserId

public long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
                         throws PortalException,
                                SystemException
Specified by:
getDigestAuthUserId in interface Portal
Throws:
PortalException
SystemException

getEmailFromAddress

public String getEmailFromAddress(PortletPreferences preferences,
                                  long companyId,
                                  String defaultValue)
                           throws SystemException
Specified by:
getEmailFromAddress in interface Portal
Throws:
SystemException

getEmailFromName

public String getEmailFromName(PortletPreferences preferences,
                               long companyId,
                               String defaultValue)
                        throws SystemException
Specified by:
getEmailFromName in interface Portal
Throws:
SystemException

getExpandoBridgeAttributes

public Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                           PortletRequest portletRequest)
                                                    throws PortalException,
                                                           SystemException
Specified by:
getExpandoBridgeAttributes in interface Portal
Throws:
PortalException
SystemException

getExpandoBridgeAttributes

public Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                           UploadPortletRequest uploadPortletRequest)
                                                    throws PortalException,
                                                           SystemException
Specified by:
getExpandoBridgeAttributes in interface Portal
Throws:
PortalException
SystemException

getExpandoValue

public Serializable getExpandoValue(PortletRequest portletRequest,
                                    String name,
                                    int type,
                                    String displayType)
                             throws PortalException,
                                    SystemException
Specified by:
getExpandoValue in interface Portal
Throws:
PortalException
SystemException

getExpandoValue

public Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest,
                                    String name,
                                    int type,
                                    String displayType)
                             throws PortalException,
                                    SystemException
Specified by:
getExpandoValue in interface Portal
Throws:
PortalException
SystemException

getFacebookURL

public String getFacebookURL(Portlet portlet,
                             String facebookCanvasPageURL,
                             ThemeDisplay themeDisplay)
                      throws PortalException,
                             SystemException
Specified by:
getFacebookURL in interface Portal
Throws:
PortalException
SystemException

getFirstPageLayoutTypes

public String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
Specified by:
getFirstPageLayoutTypes in interface Portal

getGlobalLibDir

public String getGlobalLibDir()
Specified by:
getGlobalLibDir in interface Portal

getGoogleGadgetURL

public String getGoogleGadgetURL(Portlet portlet,
                                 ThemeDisplay themeDisplay)
                          throws PortalException,
                                 SystemException
Specified by:
getGoogleGadgetURL in interface Portal
Throws:
PortalException
SystemException

getGroupFriendlyURL

public String getGroupFriendlyURL(Group group,
                                  boolean privateLayoutSet,
                                  ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException
Specified by:
getGroupFriendlyURL in interface Portal
Throws:
PortalException
SystemException

getGroupFriendlyURL

public String getGroupFriendlyURL(Group group,
                                  boolean privateLayoutSet,
                                  ThemeDisplay themeDisplay,
                                  Locale locale)
                           throws PortalException,
                                  SystemException
Specified by:
getGroupFriendlyURL in interface Portal
Throws:
PortalException
SystemException

getGroupPermissions

public String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request)
Specified by:
getGroupPermissions in interface Portal

getGroupPermissions

public String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request,
                                    String className)
Specified by:
getGroupPermissions in interface Portal

getGroupPermissions

public String[] getGroupPermissions(PortletRequest portletRequest)
Specified by:
getGroupPermissions in interface Portal

getGroupPermissions

public String[] getGroupPermissions(PortletRequest portletRequest,
                                    String className)
Specified by:
getGroupPermissions in interface Portal

getGuestPermissions

public String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request)
Specified by:
getGuestPermissions in interface Portal

getGuestPermissions

public String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request,
                                    String className)
Specified by:
getGuestPermissions in interface Portal

getGuestPermissions

public String[] getGuestPermissions(PortletRequest portletRequest)
Specified by:
getGuestPermissions in interface Portal

getGuestPermissions

public String[] getGuestPermissions(PortletRequest portletRequest,
                                    String className)
Specified by:
getGuestPermissions in interface Portal

getHomeURL

public String getHomeURL(javax.servlet.http.HttpServletRequest request)
                  throws PortalException,
                         SystemException
Specified by:
getHomeURL in interface Portal
Throws:
PortalException
SystemException

getHost

public String getHost(javax.servlet.http.HttpServletRequest request)
Specified by:
getHost in interface Portal

getHost

public String getHost(PortletRequest portletRequest)
Specified by:
getHost in interface Portal

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest(PortletRequest portletRequest)
Specified by:
getHttpServletRequest in interface Portal

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse(PortletResponse portletResponse)
Specified by:
getHttpServletResponse in interface Portal

getJournalArticleActualURL

public String getJournalArticleActualURL(long groupId,
                                         boolean privateLayout,
                                         String mainPath,
                                         String friendlyURL,
                                         Map<String,String[]> params,
                                         Map<String,Object> requestContext)
                                  throws PortalException,
                                         SystemException
Specified by:
getJournalArticleActualURL in interface Portal
Throws:
PortalException
SystemException

getJsSafePortletId

public String getJsSafePortletId(String portletId)
Specified by:
getJsSafePortletId in interface Portal

getLayoutActualURL

public String getLayoutActualURL(Layout layout)
Specified by:
getLayoutActualURL in interface Portal

getLayoutActualURL

public String getLayoutActualURL(Layout layout,
                                 String mainPath)
Specified by:
getLayoutActualURL in interface Portal

getLayoutActualURL

public String getLayoutActualURL(long groupId,
                                 boolean privateLayout,
                                 String mainPath,
                                 String friendlyURL)
                          throws PortalException,
                                 SystemException
Specified by:
getLayoutActualURL in interface Portal
Throws:
PortalException
SystemException

getLayoutActualURL

public String getLayoutActualURL(long groupId,
                                 boolean privateLayout,
                                 String mainPath,
                                 String friendlyURL,
                                 Map<String,String[]> params,
                                 Map<String,Object> requestContext)
                          throws PortalException,
                                 SystemException
Specified by:
getLayoutActualURL in interface Portal
Throws:
PortalException
SystemException

getLayoutEditPage

public String getLayoutEditPage(Layout layout)
Specified by:
getLayoutEditPage in interface Portal

getLayoutEditPage

public String getLayoutEditPage(String type)
Specified by:
getLayoutEditPage in interface Portal

getLayoutFriendlyURL

public String getLayoutFriendlyURL(Layout layout,
                                   ThemeDisplay themeDisplay)
                            throws PortalException,
                                   SystemException
Specified by:
getLayoutFriendlyURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFriendlyURL

public String getLayoutFriendlyURL(Layout layout,
                                   ThemeDisplay themeDisplay,
                                   Locale locale)
                            throws PortalException,
                                   SystemException
Specified by:
getLayoutFriendlyURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFullURL

public String getLayoutFullURL(Layout layout,
                               ThemeDisplay themeDisplay)
                        throws PortalException,
                               SystemException
Specified by:
getLayoutFullURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFullURL

public String getLayoutFullURL(Layout layout,
                               ThemeDisplay themeDisplay,
                               boolean doAsUser)
                        throws PortalException,
                               SystemException
Specified by:
getLayoutFullURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFullURL

public String getLayoutFullURL(long groupId,
                               String portletId)
                        throws PortalException,
                               SystemException
Specified by:
getLayoutFullURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFullURL

public String getLayoutFullURL(long groupId,
                               String portletId,
                               boolean secure)
                        throws PortalException,
                               SystemException
Specified by:
getLayoutFullURL in interface Portal
Throws:
PortalException
SystemException

getLayoutFullURL

public String getLayoutFullURL(ThemeDisplay themeDisplay)
                        throws PortalException,
                               SystemException
Specified by:
getLayoutFullURL in interface Portal
Throws:
PortalException
SystemException

getLayoutSetFriendlyURL

public String getLayoutSetFriendlyURL(LayoutSet layoutSet,
                                      ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException
Specified by:
getLayoutSetFriendlyURL in interface Portal
Throws:
PortalException
SystemException

getLayoutTarget

public String getLayoutTarget(Layout layout)
Specified by:
getLayoutTarget in interface Portal

getLayoutURL

public String getLayoutURL(Layout layout,
                           ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException
Specified by:
getLayoutURL in interface Portal
Throws:
PortalException
SystemException

getLayoutURL

public String getLayoutURL(Layout layout,
                           ThemeDisplay themeDisplay,
                           boolean doAsUser)
                    throws PortalException,
                           SystemException
Specified by:
getLayoutURL in interface Portal
Throws:
PortalException
SystemException

getLayoutURL

public String getLayoutURL(ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException
Specified by:
getLayoutURL in interface Portal
Throws:
PortalException
SystemException

getLayoutViewPage

public String getLayoutViewPage(Layout layout)
Specified by:
getLayoutViewPage in interface Portal

getLayoutViewPage

public String getLayoutViewPage(String type)
Specified by:
getLayoutViewPage in interface Portal

getLiferayPortletRequest

public LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)
Specified by:
getLiferayPortletRequest in interface Portal

getLiferayPortletResponse

public LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)
Specified by:
getLiferayPortletResponse in interface Portal

getLocale

public Locale getLocale(javax.servlet.http.HttpServletRequest request)
Specified by:
getLocale in interface Portal

getLocale

public Locale getLocale(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        boolean initialize)
Specified by:
getLocale in interface Portal

getLocale

public Locale getLocale(RenderRequest renderRequest)
Specified by:
getLocale in interface Portal

getMailId

public String getMailId(String mx,
                        String popPortletPrefix,
                        Object... ids)
Specified by:
getMailId in interface Portal

getNetvibesURL

public String getNetvibesURL(Portlet portlet,
                             ThemeDisplay themeDisplay)
                      throws PortalException,
                             SystemException
Specified by:
getNetvibesURL in interface Portal
Throws:
PortalException
SystemException

getNewPortletTitle

public String getNewPortletTitle(String portletTitle,
                                 String oldScopeName,
                                 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

getParentGroupId

public long getParentGroupId(long groupId)
                      throws PortalException,
                             SystemException
Specified by:
getParentGroupId in interface Portal
Throws:
PortalException
SystemException

getPathContext

public String getPathContext()
Specified by:
getPathContext in interface Portal

getPathFriendlyURLPrivateGroup

public String getPathFriendlyURLPrivateGroup()
Specified by:
getPathFriendlyURLPrivateGroup in interface Portal

getPathFriendlyURLPrivateUser

public String getPathFriendlyURLPrivateUser()
Specified by:
getPathFriendlyURLPrivateUser in interface Portal

getPathFriendlyURLPublic

public String getPathFriendlyURLPublic()
Specified by:
getPathFriendlyURLPublic in interface Portal

getPathImage

public String getPathImage()
Specified by:
getPathImage in interface Portal

getPathMain

public String getPathMain()
Specified by:
getPathMain in interface Portal

getPathProxy

public String getPathProxy()
Specified by:
getPathProxy in interface Portal

getPlidFromFriendlyURL

public long getPlidFromFriendlyURL(long companyId,
                                   String friendlyURL)
Specified by:
getPlidFromFriendlyURL in interface Portal

getPlidFromPortletId

public long getPlidFromPortletId(long groupId,
                                 boolean privateLayout,
                                 String portletId)
                          throws PortalException,
                                 SystemException
Specified by:
getPlidFromPortletId in interface Portal
Throws:
PortalException
SystemException

getPlidFromPortletId

public long getPlidFromPortletId(long groupId,
                                 String portletId)
                          throws PortalException,
                                 SystemException
Specified by:
getPlidFromPortletId in interface Portal
Throws:
PortalException
SystemException

getPortalLibDir

public String getPortalLibDir()
Specified by:
getPortalLibDir in interface Portal

getPortalPort

public int getPortalPort()
Deprecated. getPortalPort(boolean)

Specified by:
getPortalPort in interface Portal

getPortalPort

public int getPortalPort(boolean secure)
Specified by:
getPortalPort in interface Portal

getPortalProperties

public Properties getPortalProperties()
Specified by:
getPortalProperties in interface Portal

getPortalURL

public String getPortalURL(javax.servlet.http.HttpServletRequest request)
Specified by:
getPortalURL in interface Portal

getPortalURL

public String getPortalURL(javax.servlet.http.HttpServletRequest request,
                           boolean secure)
Specified by:
getPortalURL in interface Portal

getPortalURL

public String getPortalURL(Layout layout,
                           ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException
Specified by:
getPortalURL in interface Portal
Throws:
PortalException
SystemException

getPortalURL

public String getPortalURL(PortletRequest portletRequest)
Specified by:
getPortalURL in interface Portal

getPortalURL

public String getPortalURL(PortletRequest portletRequest,
                           boolean secure)
Specified by:
getPortalURL in interface Portal

getPortalURL

public String getPortalURL(String serverName,
                           int serverPort,
                           boolean secure)
Specified by:
getPortalURL in interface Portal

getPortalURL

public String getPortalURL(ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException
Specified by:
getPortalURL in interface Portal
Throws:
PortalException
SystemException

getPortalWebDir

public String getPortalWebDir()
Specified by:
getPortalWebDir in interface Portal

getPortletAddDefaultResourceCheckWhitelist

public Set<String> getPortletAddDefaultResourceCheckWhitelist()
Specified by:
getPortletAddDefaultResourceCheckWhitelist in interface Portal

getPortletAddDefaultResourceCheckWhitelistActions

public Set<String> getPortletAddDefaultResourceCheckWhitelistActions()
Specified by:
getPortletAddDefaultResourceCheckWhitelistActions in interface Portal

getPortletBreadcrumbList

public List<BreadcrumbEntry> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
Deprecated. getPortletBreadcrumbs(HttpServletRequest)

Specified by:
getPortletBreadcrumbList in interface Portal

getPortletBreadcrumbs

public List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
Specified by:
getPortletBreadcrumbs in interface Portal

getPortletDescription

public String getPortletDescription(Portlet portlet,
                                    javax.servlet.ServletContext servletContext,
                                    Locale locale)
Specified by:
getPortletDescription in interface Portal

getPortletDescription

public String getPortletDescription(Portlet portlet,
                                    User user)
Specified by:
getPortletDescription in interface Portal

getPortletDescription

public String getPortletDescription(String portletId,
                                    Locale locale)
Specified by:
getPortletDescription in interface Portal

getPortletDescription

public String getPortletDescription(String portletId,
                                    String languageId)
Specified by:
getPortletDescription in interface Portal

getPortletDescription

public String getPortletDescription(String portletId,
                                    User user)
Specified by:
getPortletDescription in interface Portal

getPortletFriendlyURLMapper

public Object[] getPortletFriendlyURLMapper(long groupId,
                                            boolean privateLayout,
                                            String url,
                                            Map<String,String[]> params,
                                            Map<String,Object> requestContext)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

getPortletId

public String getPortletId(javax.servlet.http.HttpServletRequest request)
Specified by:
getPortletId in interface Portal

getPortletId

public String getPortletId(PortletRequest portletRequest)
Specified by:
getPortletId in interface Portal

getPortletLongTitle

public String getPortletLongTitle(Portlet portlet,
                                  Locale locale)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(Portlet portlet,
                                  javax.servlet.ServletContext servletContext,
                                  Locale locale)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(Portlet portlet,
                                  String languageId)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(Portlet portlet,
                                  User user)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(String portletId,
                                  Locale locale)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(String portletId,
                                  String languageId)
Specified by:
getPortletLongTitle in interface Portal

getPortletLongTitle

public String getPortletLongTitle(String portletId,
                                  User user)
Specified by:
getPortletLongTitle in interface Portal

getPortletNamespace

public String getPortletNamespace(String portletId)
Specified by:
getPortletNamespace in interface Portal

getPortletTitle

public String getPortletTitle(Portlet portlet,
                              Locale locale)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(Portlet portlet,
                              javax.servlet.ServletContext servletContext,
                              Locale locale)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(Portlet portlet,
                              String languageId)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(Portlet portlet,
                              User user)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(RenderResponse renderResponse)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(String portletId,
                              Locale locale)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(String portletId,
                              String languageId)
Specified by:
getPortletTitle in interface Portal

getPortletTitle

public String getPortletTitle(String portletId,
                              User user)
Specified by:
getPortletTitle in interface Portal

getPortletXmlFileName

public String getPortletXmlFileName()
                             throws SystemException
Specified by:
getPortletXmlFileName in interface Portal
Throws:
SystemException

getPreferences

public PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
Specified by:
getPreferences in interface Portal

getPreferencesValidator

public PreferencesValidator getPreferencesValidator(Portlet portlet)
Specified by:
getPreferencesValidator in interface Portal

getRelativeHomeURL

public String getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
                          throws PortalException,
                                 SystemException
Specified by:
getRelativeHomeURL in interface Portal
Throws:
PortalException
SystemException

getScopeGroupId

public long getScopeGroupId(javax.servlet.http.HttpServletRequest request)
                     throws PortalException,
                            SystemException
Specified by:
getScopeGroupId in interface Portal
Throws:
PortalException
SystemException

getScopeGroupId

public long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
                            String portletId)
                     throws PortalException,
                            SystemException
Specified by:
getScopeGroupId in interface Portal
Throws:
PortalException
SystemException

getScopeGroupId

public long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
                            String portletId,
                            boolean checkStagingGroup)
                     throws PortalException,
                            SystemException
Specified by:
getScopeGroupId in interface Portal
Throws:
PortalException
SystemException

getScopeGroupId

public long getScopeGroupId(Layout layout)
Specified by:
getScopeGroupId in interface Portal

getScopeGroupId

public long getScopeGroupId(Layout layout,
                            String portletId)
Specified by:
getScopeGroupId in interface Portal

getScopeGroupId

public long getScopeGroupId(long plid)
Specified by:
getScopeGroupId in interface Portal

getScopeGroupId

public long getScopeGroupId(PortletRequest portletRequest)
                     throws PortalException,
                            SystemException
Specified by:
getScopeGroupId in interface Portal
Throws:
PortalException
SystemException

getSelectedUser

public User getSelectedUser(javax.servlet.http.HttpServletRequest request)
                     throws PortalException,
                            SystemException
Specified by:
getSelectedUser in interface Portal
Throws:
PortalException
SystemException

getSelectedUser

public User getSelectedUser(javax.servlet.http.HttpServletRequest request,
                            boolean checkPermission)
                     throws PortalException,
                            SystemException
Specified by:
getSelectedUser in interface Portal
Throws:
PortalException
SystemException

getSelectedUser

public User getSelectedUser(PortletRequest portletRequest)
                     throws PortalException,
                            SystemException
Specified by:
getSelectedUser in interface Portal
Throws:
PortalException
SystemException

getSelectedUser

public User getSelectedUser(PortletRequest portletRequest,
                            boolean checkPermission)
                     throws PortalException,
                            SystemException
Specified by:
getSelectedUser in interface Portal
Throws:
PortalException
SystemException

getServletContext

public javax.servlet.ServletContext getServletContext(Portlet portlet,
                                                      javax.servlet.ServletContext servletContext)
Specified by:
getServletContext in interface Portal

getSiteLoginURL

public String getSiteLoginURL(ThemeDisplay themeDisplay)
                       throws PortalException,
                              SystemException
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
SystemException - if a system exception occurred

getStaticResourceURL

public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                   String uri)
Specified by:
getStaticResourceURL in interface Portal

getStaticResourceURL

public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                   String uri,
                                   long timestamp)
Specified by:
getStaticResourceURL in interface Portal

getStaticResourceURL

public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                   String uri,
                                   String queryString)
Specified by:
getStaticResourceURL in interface Portal

getStaticResourceURL

public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                   String uri,
                                   String queryString,
                                   long timestamp)
Specified by:
getStaticResourceURL in interface Portal

getStrutsAction

public String getStrutsAction(javax.servlet.http.HttpServletRequest request)
Specified by:
getStrutsAction in interface Portal

getSystemGroups

public String[] getSystemGroups()
Specified by:
getSystemGroups in interface Portal

getSystemOrganizationRoles

public String[] getSystemOrganizationRoles()
Specified by:
getSystemOrganizationRoles in interface Portal

getSystemRoles

public String[] getSystemRoles()
Specified by:
getSystemRoles in interface Portal

getSystemSiteRoles

public String[] getSystemSiteRoles()
Specified by:
getSystemSiteRoles in interface Portal

getUniqueElementId

public String getUniqueElementId(javax.servlet.http.HttpServletRequest request,
                                 String namespace,
                                 String elementId)
Specified by:
getUniqueElementId in interface Portal

getUniqueElementId

public String getUniqueElementId(PortletRequest request,
                                 String namespace,
                                 String elementId)
Specified by:
getUniqueElementId in interface Portal

getUploadPortletRequest

public UploadPortletRequest getUploadPortletRequest(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 Date getUptime()
Specified by:
getUptime in interface Portal

getURLWithSessionId

public String getURLWithSessionId(String url,
                                  String sessionId)
Specified by:
getURLWithSessionId in interface Portal

getUser

public User getUser(javax.servlet.http.HttpServletRequest request)
             throws PortalException,
                    SystemException
Specified by:
getUser in interface Portal
Throws:
PortalException
SystemException

getUser

public User getUser(PortletRequest portletRequest)
             throws PortalException,
                    SystemException
Specified by:
getUser in interface Portal
Throws:
PortalException
SystemException

getUserEmailAddress

public String getUserEmailAddress(long userId)
                           throws SystemException
Specified by:
getUserEmailAddress in interface Portal
Throws:
SystemException

getUserId

public long getUserId(javax.servlet.http.HttpServletRequest request)
Specified by:
getUserId in interface Portal

getUserId

public long getUserId(PortletRequest portletRequest)
Specified by:
getUserId in interface Portal

getUserName

public String getUserName(BaseModel<?> baseModel)
Specified by:
getUserName in interface Portal

getUserName

public String getUserName(long userId,
                          String defaultUserName)
Specified by:
getUserName in interface Portal

getUserName

public String getUserName(long userId,
                          String defaultUserName,
                          javax.servlet.http.HttpServletRequest request)
Specified by:
getUserName in interface Portal

getUserName

public String getUserName(long userId,
                          String defaultUserName,
                          String userAttribute)
Specified by:
getUserName in interface Portal

getUserName

public String getUserName(long userId,
                          String defaultUserName,
                          String userAttribute,
                          javax.servlet.http.HttpServletRequest request)
Specified by:
getUserName in interface Portal

getUserPassword

public String getUserPassword(javax.servlet.http.HttpServletRequest request)
Specified by:
getUserPassword in interface Portal

getUserPassword

public String getUserPassword(javax.servlet.http.HttpSession session)
Specified by:
getUserPassword in interface Portal

getUserPassword

public String getUserPassword(PortletRequest portletRequest)
Specified by:
getUserPassword in interface Portal

getUserValue

public String getUserValue(long userId,
                           String param,
                           String defaultValue)
                    throws SystemException
Specified by:
getUserValue in interface Portal
Throws:
SystemException

getValidUserId

public long getValidUserId(long companyId,
                           long userId)
                    throws PortalException,
                           SystemException
Specified by:
getValidUserId in interface Portal
Throws:
PortalException
SystemException

getVirtualLayoutActualURL

public String getVirtualLayoutActualURL(long groupId,
                                        boolean privateLayout,
                                        String mainPath,
                                        String friendlyURL,
                                        Map<String,String[]> params,
                                        Map<String,Object> requestContext)
                                 throws PortalException,
                                        SystemException
Specified by:
getVirtualLayoutActualURL in interface Portal
Throws:
PortalException
SystemException

getWidgetURL

public String getWidgetURL(Portlet portlet,
                           ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException
Specified by:
getWidgetURL in interface Portal
Throws:
PortalException
SystemException

initCustomSQL

public void initCustomSQL()
Specified by:
initCustomSQL in interface Portal

initUser

public User initUser(javax.servlet.http.HttpServletRequest request)
              throws Exception
Specified by:
initUser in interface Portal
Throws:
Exception

isAllowAddPortletDefaultResource

public boolean isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
                                                Portlet portlet)
                                         throws PortalException,
                                                SystemException
Specified by:
isAllowAddPortletDefaultResource in interface Portal
Throws:
PortalException
SystemException

isCDNDynamicResourcesEnabled

public boolean isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
                                     throws PortalException,
                                            SystemException
Specified by:
isCDNDynamicResourcesEnabled in interface Portal
Throws:
PortalException
SystemException

isCDNDynamicResourcesEnabled

public boolean isCDNDynamicResourcesEnabled(long companyId)
Specified by:
isCDNDynamicResourcesEnabled in interface Portal

isCommunityAdmin

public boolean isCommunityAdmin(User user,
                                long groupId)
                         throws Exception
Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long)

Specified by:
isCommunityAdmin in interface Portal
Throws:
Exception

isCommunityOwner

public boolean isCommunityOwner(User user,
                                long groupId)
                         throws Exception
Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long)

Specified by:
isCommunityOwner in interface Portal
Throws:
Exception

isCompanyAdmin

public boolean isCompanyAdmin(User user)
                       throws Exception
Specified by:
isCompanyAdmin in interface Portal
Throws:
Exception

isCompanyControlPanelPortlet

public boolean isCompanyControlPanelPortlet(String portletId,
                                            String category,
                                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException
Specified by:
isCompanyControlPanelPortlet in interface Portal
Throws:
PortalException
SystemException

isCompanyControlPanelPortlet

public boolean isCompanyControlPanelPortlet(String portletId,
                                            ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException
Specified by:
isCompanyControlPanelPortlet in interface Portal
Throws:
PortalException
SystemException

isCompanyControlPanelVisible

public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException
Specified by:
isCompanyControlPanelVisible in interface Portal
Throws:
PortalException
SystemException

isControlPanelPortlet

public boolean isControlPanelPortlet(String portletId,
                                     String category,
                                     ThemeDisplay themeDisplay)
                              throws SystemException
Specified by:
isControlPanelPortlet in interface Portal
Throws:
SystemException

isControlPanelPortlet

public boolean isControlPanelPortlet(String portletId,
                                     ThemeDisplay themeDisplay)
                              throws SystemException
Specified by:
isControlPanelPortlet in interface Portal
Throws:
SystemException

isGroupAdmin

public boolean isGroupAdmin(User user,
                            long groupId)
                     throws Exception
Specified by:
isGroupAdmin in interface Portal
Throws:
Exception

isGroupFriendlyURL

public boolean isGroupFriendlyURL(String fullURL,
                                  String groupFriendlyURL,
                                  String layoutFriendlyURL)
Specified by:
isGroupFriendlyURL in interface Portal

isGroupOwner

public boolean isGroupOwner(User user,
                            long groupId)
                     throws Exception
Specified by:
isGroupOwner in interface Portal
Throws:
Exception

isLayoutDescendant

public boolean isLayoutDescendant(Layout layout,
                                  long layoutId)
                           throws PortalException,
                                  SystemException
Specified by:
isLayoutDescendant in interface Portal
Throws:
PortalException
SystemException

isLayoutFirstPageable

public boolean isLayoutFirstPageable(Layout layout)
Specified by:
isLayoutFirstPageable in interface Portal

isLayoutFirstPageable

public boolean isLayoutFirstPageable(String type)
Specified by:
isLayoutFirstPageable in interface Portal

isLayoutFriendliable

public boolean isLayoutFriendliable(Layout layout)
Specified by:
isLayoutFriendliable in interface Portal

isLayoutFriendliable

public boolean isLayoutFriendliable(String type)
Specified by:
isLayoutFriendliable in interface Portal

isLayoutParentable

public boolean isLayoutParentable(Layout layout)
Specified by:
isLayoutParentable in interface Portal

isLayoutParentable

public boolean isLayoutParentable(String type)
Specified by:
isLayoutParentable in interface Portal

isLayoutSitemapable

public boolean isLayoutSitemapable(Layout layout)
Specified by:
isLayoutSitemapable in interface Portal

isMethodGet

public boolean isMethodGet(PortletRequest portletRequest)
Specified by:
isMethodGet in interface Portal

isMethodPost

public boolean isMethodPost(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

isReservedParameter

public boolean isReservedParameter(String name)
Specified by:
isReservedParameter in interface Portal

isSecure

public boolean isSecure(javax.servlet.http.HttpServletRequest request)
Specified by:
isSecure in interface Portal

isSystemGroup

public boolean isSystemGroup(String groupName)
Specified by:
isSystemGroup in interface Portal

isSystemRole

public boolean isSystemRole(String roleName)
Specified by:
isSystemRole in interface Portal

isUpdateAvailable

public boolean isUpdateAvailable()
                          throws SystemException
Specified by:
isUpdateAvailable in interface Portal
Throws:
SystemException

isValidResourceId

public boolean isValidResourceId(String resourceId)
Specified by:
isValidResourceId in interface Portal

removePortalPortEventListener

public void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
Specified by:
removePortalPortEventListener in interface Portal

renderPage

public String renderPage(javax.servlet.ServletContext servletContext,
                         javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         String path)
                  throws IOException,
                         javax.servlet.ServletException
Specified by:
renderPage in interface Portal
Throws:
IOException
javax.servlet.ServletException

renderPortlet

public String renderPortlet(javax.servlet.ServletContext servletContext,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Portlet portlet,
                            String queryString,
                            boolean writeOutput)
                     throws IOException,
                            javax.servlet.ServletException
Specified by:
renderPortlet in interface Portal
Throws:
IOException
javax.servlet.ServletException

renderPortlet

public String renderPortlet(javax.servlet.ServletContext servletContext,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Portlet portlet,
                            String queryString,
                            String columnId,
                            Integer columnPos,
                            Integer columnCount,
                            boolean writeOutput)
                     throws IOException,
                            javax.servlet.ServletException
Specified by:
renderPortlet in interface Portal
Throws:
IOException
javax.servlet.ServletException

renderPortlet

public String renderPortlet(javax.servlet.ServletContext servletContext,
                            javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Portlet portlet,
                            String queryString,
                            String columnId,
                            Integer columnPos,
                            Integer columnCount,
                            String path,
                            boolean writeOutput)
                     throws IOException,
                            javax.servlet.ServletException
Specified by:
renderPortlet in interface Portal
Throws:
IOException
javax.servlet.ServletException

resetCDNHosts

public void resetCDNHosts()
Specified by:
resetCDNHosts in interface Portal

resetPortletAddDefaultResourceCheckWhitelist

public Set<String> resetPortletAddDefaultResourceCheckWhitelist()
Specified by:
resetPortletAddDefaultResourceCheckWhitelist in interface Portal

resetPortletAddDefaultResourceCheckWhitelistActions

public Set<String> resetPortletAddDefaultResourceCheckWhitelistActions()
Specified by:
resetPortletAddDefaultResourceCheckWhitelistActions in interface Portal

sendError

public void sendError(Exception e,
                      ActionRequest actionRequest,
                      ActionResponse actionResponse)
               throws IOException
Specified by:
sendError in interface Portal
Throws:
IOException

sendError

public void sendError(Exception e,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws IOException,
                      javax.servlet.ServletException
Specified by:
sendError in interface Portal
Throws:
IOException
javax.servlet.ServletException

sendError

public void sendError(int status,
                      Exception e,
                      ActionRequest actionRequest,
                      ActionResponse actionResponse)
               throws IOException
Specified by:
sendError in interface Portal
Throws:
IOException

sendError

public void sendError(int status,
                      Exception e,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws IOException,
                      javax.servlet.ServletException
Specified by:
sendError in interface Portal
Throws:
IOException
javax.servlet.ServletException

setPageDescription

public void setPageDescription(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(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(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(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

setPortalPort

public void setPortalPort(javax.servlet.http.HttpServletRequest request)
Description copied from interface: Portal
Sets the port obtained on the first request to the portal.

Specified by:
setPortalPort in interface Portal

storePreferences

public void storePreferences(PortletPreferences portletPreferences)
                      throws IOException,
                             ValidatorException
Specified by:
storePreferences in interface Portal
Throws:
IOException
ValidatorException

stripURLAnchor

public String[] stripURLAnchor(String url,
                               String separator)
Specified by:
stripURLAnchor in interface Portal

transformCustomSQL

public String transformCustomSQL(String sql)
Specified by:
transformCustomSQL in interface Portal

transformSQL

public String transformSQL(String sql)
Specified by:
transformSQL in interface Portal

updatePortletMode

public PortletMode updatePortletMode(String portletId,
                                     User user,
                                     Layout layout,
                                     PortletMode portletMode,
                                     javax.servlet.http.HttpServletRequest request)
Specified by:
updatePortletMode in interface Portal

updateRedirect

public String updateRedirect(String redirect,
                             String oldPath,
                             String newPath)
Specified by:
updateRedirect in interface Portal

updateWindowState

public WindowState updateWindowState(String portletId,
                                     User user,
                                     Layout layout,
                                     WindowState windowState,
                                     javax.servlet.http.HttpServletRequest request)
Specified by:
updateWindowState in interface Portal

addDefaultResource

protected void addDefaultResource(long companyId,
                                  Layout layout,
                                  Portlet portlet,
                                  boolean portletActions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

addDefaultResource

protected void addDefaultResource(long companyId,
                                  long groupId,
                                  Layout layout,
                                  Portlet portlet,
                                  boolean portletActions)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

buildI18NPath

protected String buildI18NPath(Locale locale)

doGetPlidFromPortletId

protected long doGetPlidFromPortletId(long groupId,
                                      boolean privateLayout,
                                      String portletId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

filterControlPanelPortlets

protected List<Portlet> filterControlPanelPortlets(Set<Portlet> portlets,
                                                   String category,
                                                   ThemeDisplay themeDisplay)

getAvailableLocale

protected Locale getAvailableLocale(Locale locale)

getDefaultScopeGroupId

protected long getDefaultScopeGroupId(long companyId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

getDoAsUserId

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

getGroupFriendlyURL

protected String getGroupFriendlyURL(Group group,
                                     boolean privateLayoutSet,
                                     ThemeDisplay themeDisplay,
                                     boolean canonicalURL)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getPortletParam

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

getServletURL

protected String getServletURL(Portlet portlet,
                               String servletPath,
                               ThemeDisplay themeDisplay)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

hasPortletDefaultResource

protected boolean hasPortletDefaultResource(ThemeDisplay themeDisplay,
                                            Layout layout,
                                            Portlet portlet)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

isAlwaysAllowDoAsUser

protected boolean isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)
                                 throws Exception
Throws:
Exception

isPanelSelectedPortlet

protected boolean isPanelSelectedPortlet(ThemeDisplay themeDisplay,
                                         String portletId)

notifyPortalPortEventListeners

protected void notifyPortalPortEventListeners(int portalPort)

removeRedirectParameter

protected String removeRedirectParameter(String url)

resetThemeDisplayI18n

protected void resetThemeDisplayI18n(ThemeDisplay themeDisplay,
                                     String languageId,
                                     String path)

setLocale

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

setThemeDisplayI18n

protected void setThemeDisplayI18n(ThemeDisplay themeDisplay,
                                   Locale locale)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.1.2-ce-ga3
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD