PortalUtil (Liferay 6.0.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.0.5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.util
Class PortalUtil

java.lang.Object
  com.liferay.portal.util.PortalUtil

public class PortalUtil
extends Object
extends Object

Constructor Summary
`PortalUtil()`

Method Summary
`static void`	`addPageDescription(String description, javax.servlet.http.HttpServletRequest request)` Adds the description for a page.
`static void`	`addPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)` Adds the keywords for a page.
`static void`	`addPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)` Adds the subtitle for a page.
`static void`	`addPageTitle(String title, javax.servlet.http.HttpServletRequest request)` Adds the whole title for a page.
`static void`	`addPortalPortEventListener(PortalPortEventListener portalPortEventListener)`
`static void`	`addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url)`
`static void`	`addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)`
`static String`	`addPreservedParameters(ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser)` Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.
`static String`	`addPreservedParameters(ThemeDisplay themeDisplay, String url)` Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.
`static void`	`clearRequestParameters(RenderRequest renderRequest)`
`static void`	`copyRequestParameters(ActionRequest actionRequest, ActionResponse actionResponse)`
`static String`	`escapeRedirect(String url)`
`static String`	`generateRandomKey(javax.servlet.http.HttpServletRequest request, String input)`
`static BaseModel<?>`	`getBaseModel(Resource resource)`
`static BaseModel<?>`	`getBaseModel(ResourcePermission resourcePermission)`
`static BaseModel<?>`	`getBaseModel(String modelName, String primKey)`
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)`
`static String`	`getCDNHost()` Deprecated. `getCDNHost(boolean)`
`static String`	`getCDNHost(boolean secure)`
`static String`	`getCDNHostHttp()`
`static String`	`getCDNHostHttps()`
`static String`	`getClassName(long classNameId)`
`static long`	`getClassNameId(Class<?> classObj)`
`static long`	`getClassNameId(String value)`
`static String`	`getClassNamePortletId(String className)`
`static String`	`getCommunityLoginURL(ThemeDisplay themeDisplay)`
`static String[]`	`getCommunityPermissions(javax.servlet.http.HttpServletRequest request)`
`static String[]`	`getCommunityPermissions(PortletRequest portletRequest)`
`static Company`	`getCompany(javax.servlet.http.HttpServletRequest request)`
`static Company`	`getCompany(PortletRequest portletRequest)`
`static long`	`getCompanyId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getCompanyId(PortletRequest portletRequest)`
`static long[]`	`getCompanyIds()`
`static String`	`getComputerAddress()`
`static String`	`getComputerName()`
`static String`	`getControlPanelCategory(String portletId, ThemeDisplay themeDisplay)`
`static String`	`getControlPanelFullURL(long scopeGroupId, String ppid, Map<String,String[]> params)`
`static List<Portlet>`	`getControlPanelPortlets(String category, ThemeDisplay themeDisplay)`
`static String`	`getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)`
`static String`	`getCurrentURL(javax.servlet.http.HttpServletRequest request)`
`static String`	`getCurrentURL(PortletRequest portletRequest)`
`static String`	`getCustomSQLFunctionIsNotNull()`
`static String`	`getCustomSQLFunctionIsNull()`
`static Date`	`getDate(int month, int day, int year)`
`static Date`	`getDate(int month, int day, int year, int hour, int min, PortalException pe)`
`static Date`	`getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, PortalException pe)`
`static Date`	`getDate(int month, int day, int year, PortalException pe)`
`static Date`	`getDate(int month, int day, int year, TimeZone timeZone, PortalException pe)`
`static DB`	`getDB()` Deprecated. `DBFactoryUtil.getDB()`
`static long`	`getDefaultCompanyId()`
`static long`	`getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)`
`static Map<String,Serializable>`	`getExpandoBridgeAttributes(ExpandoBridge expandoBridge, PortletRequest portletRequest)`
`static String`	`getFacebookURL(Portlet portlet, String facebookCanvasPageURL, ThemeDisplay themeDisplay)`
`static String`	`getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)`
`static String`	`getGlobalLibDir()`
`static String`	`getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static String[]`	`getGuestPermissions(javax.servlet.http.HttpServletRequest request)`
`static String[]`	`getGuestPermissions(PortletRequest portletRequest)`
`static String`	`getHomeURL(javax.servlet.http.HttpServletRequest request)`
`static String`	`getHost(javax.servlet.http.HttpServletRequest request)`
`static String`	`getHost(PortletRequest portletRequest)`
`static javax.servlet.http.HttpServletRequest`	`getHttpServletRequest(PortletRequest portletRequest)`
`static javax.servlet.http.HttpServletResponse`	`getHttpServletResponse(PortletResponse portletResponse)`
`static String`	`getJsSafePortletId(String portletId)`
`static String`	`getLayoutActualURL(Layout layout)`
`static String`	`getLayoutActualURL(Layout layout, String mainPath)`
`static String`	`getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL)`
`static String`	`getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)`
`static String`	`getLayoutEditPage(Layout layout)`
`static String`	`getLayoutEditPage(String type)`
`static String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)`
`static String`	`getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, Locale locale)`
`static String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay)`
`static String`	`getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`static String`	`getLayoutFullURL(long groupId, String portletId)`
`static String`	`getLayoutFullURL(ThemeDisplay themeDisplay)`
`static String`	`getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)`
`static String`	`getLayoutTarget(Layout layout)`
`static String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay)`
`static String`	`getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)`
`static String`	`getLayoutURL(ThemeDisplay themeDisplay)`
`static String`	`getLayoutViewPage(Layout layout)`
`static String`	`getLayoutViewPage(String type)`
`static LiferayPortletResponse`	`getLiferayPortletResponse(PortletResponse portletResponse)`
`static Locale`	`getLocale(javax.servlet.http.HttpServletRequest request)`
`static Locale`	`getLocale(RenderRequest renderRequest)`
`static BaseModel<?>`	`getModel(Resource resource)` Deprecated. `getBaseModel(Resource)`
`static BaseModel<?>`	`getModel(ResourcePermission resourcePermission)` Deprecated. `getBaseModel(ResourcePermission)`
`static BaseModel<?>`	`getModel(String modelName, String primKey)` Deprecated. `getBaseModel(String, String)`
`static String`	`getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static javax.servlet.http.HttpServletRequest`	`getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)`
`static long`	`getParentGroupId(long scopeGroupId)`
`static String`	`getPathContext()`
`static String`	`getPathFriendlyURLPrivateGroup()`
`static String`	`getPathFriendlyURLPrivateUser()`
`static String`	`getPathFriendlyURLPublic()`
`static String`	`getPathImage()`
`static String`	`getPathMain()`
`static long`	`getPlidFromFriendlyURL(long companyId, String friendlyURL)`
`static long`	`getPlidFromPortletId(long groupId, boolean privateLayout, String portletId)`
`static long`	`getPlidFromPortletId(long groupId, String portletId)`
`static Portal`	`getPortal()`
`static String`	`getPortalLibDir()`
`static int`	`getPortalPort()`
`static Properties`	`getPortalProperties()`
`static String`	`getPortalURL(javax.servlet.http.HttpServletRequest request)`
`static String`	`getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)`
`static String`	`getPortalURL(PortletRequest portletRequest)`
`static String`	`getPortalURL(PortletRequest portletRequest, boolean secure)`
`static String`	`getPortalURL(String serverName, int serverPort, boolean secure)`
`static String`	`getPortalURL(ThemeDisplay themeDisplay)`
`static String`	`getPortalWebDir()`
`static List<KeyValuePair>`	`getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)`
`static String`	`getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)`
`static String`	`getPortletDescription(Portlet portlet, User user)`
`static String`	`getPortletDescription(String portletId, Locale locale)`
`static String`	`getPortletDescription(String portletId, String languageId)`
`static String`	`getPortletDescription(String portletId, User user)`
`static String`	`getPortletId(javax.servlet.http.HttpServletRequest request)`
`static String`	`getPortletId(PortletRequest portletRequest)`
`static String`	`getPortletNamespace(String portletId)`
`static String`	`getPortletTitle(Portlet portlet, Locale locale)`
`static String`	`getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)`
`static String`	`getPortletTitle(Portlet portlet, String languageId)`
`static String`	`getPortletTitle(Portlet portlet, User user)`
`static String`	`getPortletTitle(RenderResponse renderResponse)`
`static String`	`getPortletTitle(String portletId, Locale locale)`
`static String`	`getPortletTitle(String portletId, String languageId)`
`static String`	`getPortletTitle(String portletId, User user)`
`static String`	`getPortletXmlFileName()`
`static PortletPreferences`	`getPreferences(javax.servlet.http.HttpServletRequest request)`
`static PreferencesValidator`	`getPreferencesValidator(Portlet portlet)`
`static long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId)`
`static long`	`getScopeGroupId(Layout layout)`
`static long`	`getScopeGroupId(Layout layout, String portletId)`
`static long`	`getScopeGroupId(long plid)`
`static long`	`getScopeGroupId(PortletRequest portletRequest)`
`static User`	`getSelectedUser(javax.servlet.http.HttpServletRequest request)`
`static User`	`getSelectedUser(javax.servlet.http.HttpServletRequest request, boolean checkPermission)`
`static User`	`getSelectedUser(PortletRequest portletRequest)`
`static User`	`getSelectedUser(PortletRequest portletRequest, boolean checkPermission)`
`static javax.servlet.ServletContext`	`getServletContext(Portlet portlet, javax.servlet.ServletContext servletContext)`
`static SocialEquityActionMapping`	`getSocialEquityActionMapping(String name, String actionId)`
`static List<SocialEquityActionMapping>`	`getSocialEquityActionMappings(String name)`
`static String[]`	`getSocialEquityClassNames()`
`static String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri)`
`static String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, long timestamp)`
`static String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, String queryString)`
`static String`	`getStaticResourceURL(javax.servlet.http.HttpServletRequest request, String uri, String queryString, long timestamp)`
`static String`	`getStrutsAction(javax.servlet.http.HttpServletRequest request)`
`static String[]`	`getSystemCommunityRoles()`
`static String[]`	`getSystemGroups()`
`static String[]`	`getSystemOrganizationRoles()`
`static String[]`	`getSystemRoles()`
`static UploadPortletRequest`	`getUploadPortletRequest(PortletRequest portletRequest)`
`static UploadServletRequest`	`getUploadServletRequest(javax.servlet.http.HttpServletRequest request)`
`static Date`	`getUptime()`
`static String`	`getURLWithSessionId(String url, String sessionId)`
`static User`	`getUser(javax.servlet.http.HttpServletRequest request)`
`static User`	`getUser(PortletRequest portletRequest)`
`static long`	`getUserId(javax.servlet.http.HttpServletRequest request)`
`static long`	`getUserId(PortletRequest portletRequest)`
`static String`	`getUserName(long userId, String defaultUserName)`
`static String`	`getUserName(long userId, String defaultUserName, javax.servlet.http.HttpServletRequest request)`
`static String`	`getUserName(long userId, String defaultUserName, String userAttribute)`
`static String`	`getUserName(long userId, String defaultUserName, String userAttribute, javax.servlet.http.HttpServletRequest request)`
`static String`	`getUserPassword(javax.servlet.http.HttpServletRequest request)`
`static String`	`getUserPassword(javax.servlet.http.HttpSession session)`
`static String`	`getUserPassword(PortletRequest portletRequest)`
`static String`	`getUserValue(long userId, String param, String defaultValue)`
`static long`	`getValidUserId(long companyId, long userId)`
`static String`	`getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)`
`static boolean`	`isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)`
`static boolean`	`isCommunityAdmin(User user, long groupId)`
`static boolean`	`isCommunityOwner(User user, long groupId)`
`static boolean`	`isCompanyAdmin(User user)`
`static boolean`	`isControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)`
`static boolean`	`isControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)`
`static boolean`	`isLayoutFirstPageable(Layout layout)`
`static boolean`	`isLayoutFirstPageable(String type)`
`static boolean`	`isLayoutFriendliable(Layout layout)`
`static boolean`	`isLayoutFriendliable(String type)`
`static boolean`	`isLayoutParentable(Layout layout)`
`static boolean`	`isLayoutParentable(String type)`
`static boolean`	`isLayoutSitemapable(Layout layout)`
`static boolean`	`isMethodGet(PortletRequest portletRequest)`
`static boolean`	`isMethodPost(PortletRequest portletRequest)`
`static boolean`	`isOmniadmin(long userId)`
`static boolean`	`isReservedParameter(String name)`
`static boolean`	`isSystemGroup(String groupName)`
`static boolean`	`isSystemRole(String roleName)`
`static boolean`	`isUpdateAvailable()`
`static boolean`	`isValidResourceId(String resourceId)`
`void`	`removePortalPortEventListener(PortalPortEventListener portalPortEventListener)`
`static String`	`renderPage(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String path, boolean writeOutput)`
`static String`	`renderPortlet(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, String queryString, boolean writeOutput)`
`static 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)`
`static 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)`
`static void`	`runSQL(String sql)` Deprecated. `DB.runSQL(String)`
`static void`	`sendError(Exception e, ActionRequest actionRequest, ActionResponse actionResponse)`
`static void`	`sendError(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`sendError(int status, Exception e, ActionRequest actionRequest, ActionResponse actionResponse)`
`static void`	`sendError(int status, Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`
`static void`	`setPageDescription(String description, javax.servlet.http.HttpServletRequest request)` Sets the description for a page.
`static void`	`setPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)` Sets the keywords for a page.
`static void`	`setPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)` Sets the subtitle for a page.
`static void`	`setPageTitle(String title, javax.servlet.http.HttpServletRequest request)` Sets the whole title for a page.
`void`	`setPortal(Portal portal)`
`static void`	`setPortalPort(javax.servlet.http.HttpServletRequest request)` Sets the port obtained on the first request to the portal.
`static void`	`storePreferences(PortletPreferences preferences)`
`static String`	`transformCustomSQL(String sql)`
`static PortletMode`	`updatePortletMode(String portletId, User user, Layout layout, PortletMode portletMode, javax.servlet.http.HttpServletRequest request)`
`static 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

PortalUtil

public PortalUtil()

Method Detail

addPageDescription

public static void addPageDescription(String description,
                                      javax.servlet.http.HttpServletRequest request)

Adds the description for a page. This appends to the existing page description.

addPageKeywords

public static void addPageKeywords(String keywords,
                                   javax.servlet.http.HttpServletRequest request)

Adds the keywords for a page. This appends to the existing page keywords.

addPageSubtitle

public static void addPageSubtitle(String subtitle,
                                   javax.servlet.http.HttpServletRequest request)

Adds the subtitle for a page. This appends to the existing page subtitle.

addPageTitle

public static void addPageTitle(String title,
                                javax.servlet.http.HttpServletRequest request)

Adds the whole title for a page. This appends to the existing page whole title.

addPortalPortEventListener

public static void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)

addPortletBreadcrumbEntry

public static void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                                             String title,
                                             String url)

addPortletDefaultResource

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

Throws:: PortalException; SystemException

addPreservedParameters

public static String addPreservedParameters(ThemeDisplay themeDisplay,
                                            Layout layout,
                                            String url,
                                            boolean doAsUser)

Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal. If doAsUser is false, then doAsUserId and doAsUserLanguageId will never be added.

addPreservedParameters

public static String addPreservedParameters(ThemeDisplay themeDisplay,
                                            String url)

Adds preserved parameters such as doAsGroupId, doAsUserId, doAsUserLanguageId, and referrerPlid that should always be preserved as the user navigates through the portal.

clearRequestParameters

public static void clearRequestParameters(RenderRequest renderRequest)

copyRequestParameters

public static void copyRequestParameters(ActionRequest actionRequest,
                                         ActionResponse actionResponse)

escapeRedirect

public static String escapeRedirect(String url)

generateRandomKey

public static String generateRandomKey(javax.servlet.http.HttpServletRequest request,
                                       String input)

getBaseModel

public static BaseModel<?> getBaseModel(Resource resource)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getBaseModel

public static BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getBaseModel

public static BaseModel<?> getBaseModel(String modelName,
                                        String primKey)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getBasicAuthUserId

public static long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getDigestAuthUserId

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

Throws:: PortalException; SystemException

getBasicAuthUserId

public static long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
                                      long companyId)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getCDNHost

public static String getCDNHost()

Deprecated. getCDNHost(boolean)

getCDNHost

public static String getCDNHost(boolean secure)

getCDNHostHttp

public static String getCDNHostHttp()

getCDNHostHttps

public static String getCDNHostHttps()

getClassName

public static String getClassName(long classNameId)

getClassNameId

public static long getClassNameId(Class<?> classObj)

getClassNameId

public static long getClassNameId(String value)

getClassNamePortletId

public static String getClassNamePortletId(String className)

getCommunityLoginURL

public static String getCommunityLoginURL(ThemeDisplay themeDisplay)
                                   throws PortalException,
                                          SystemException

Throws:: PortalException; SystemException

getCommunityPermissions

public static String[] getCommunityPermissions(javax.servlet.http.HttpServletRequest request)

getCommunityPermissions

public static String[] getCommunityPermissions(PortletRequest portletRequest)

getCompany

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

Throws:: PortalException; SystemException

getCompany

public static Company getCompany(PortletRequest portletRequest)
                          throws PortalException,
                                 SystemException

Throws:: PortalException; SystemException

getCompanyId

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

getCompanyId

public static long getCompanyId(PortletRequest portletRequest)

getCompanyIds

public static long[] getCompanyIds()

getComputerAddress

public static String getComputerAddress()

getComputerName

public static String getComputerName()

getControlPanelCategory

public static String getControlPanelCategory(String portletId,
                                             ThemeDisplay themeDisplay)
                                      throws SystemException

Throws:: SystemException

getControlPanelFullURL

public static String getControlPanelFullURL(long scopeGroupId,
                                            String ppid,
                                            Map<String,String[]> params)
                                     throws PortalException,
                                            SystemException

Throws:: PortalException; SystemException

getControlPanelPortlets

public static List<Portlet> getControlPanelPortlets(String category,
                                                    ThemeDisplay themeDisplay)
                                             throws SystemException

Throws:: SystemException

getCurrentCompleteURL

public static String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)

getCurrentURL

public static String getCurrentURL(javax.servlet.http.HttpServletRequest request)

getCurrentURL

public static String getCurrentURL(PortletRequest portletRequest)

getCustomSQLFunctionIsNotNull

public static String getCustomSQLFunctionIsNotNull()

getCustomSQLFunctionIsNull

public static String getCustomSQLFunctionIsNull()

getDate

public static Date getDate(int month,
                           int day,
                           int year)

getDate

public static Date getDate(int month,
                           int day,
                           int year,
                           int hour,
                           int min,
                           PortalException pe)
                    throws PortalException

Throws:: PortalException

getDate

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

Throws:: PortalException

getDate

public static Date getDate(int month,
                           int day,
                           int year,
                           PortalException pe)
                    throws PortalException

Throws:: PortalException

getDate

public static Date getDate(int month,
                           int day,
                           int year,
                           TimeZone timeZone,
                           PortalException pe)
                    throws PortalException

Throws:: PortalException

getDB

public static DB getDB()

Deprecated. DBFactoryUtil.getDB()

getDefaultCompanyId

public static long getDefaultCompanyId()

getExpandoBridgeAttributes

public static Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                                  PortletRequest portletRequest)
                                                           throws PortalException,
                                                                  SystemException

Throws:: PortalException; SystemException

getFacebookURL

public static String getFacebookURL(Portlet portlet,
                                    String facebookCanvasPageURL,
                                    ThemeDisplay themeDisplay)
                             throws PortalException,
                                    SystemException

Throws:: PortalException; SystemException

getFirstPageLayoutTypes

public static String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)

getGlobalLibDir

public static String getGlobalLibDir()

getGoogleGadgetURL

public static String getGoogleGadgetURL(Portlet portlet,
                                        ThemeDisplay themeDisplay)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getGuestPermissions

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

getGuestPermissions

public static String[] getGuestPermissions(PortletRequest portletRequest)

getHomeURL

public static String getHomeURL(javax.servlet.http.HttpServletRequest request)
                         throws PortalException,
                                SystemException

Throws:: PortalException; SystemException

getHost

public static String getHost(javax.servlet.http.HttpServletRequest request)

getHost

public static String getHost(PortletRequest portletRequest)

getHttpServletRequest

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

getHttpServletResponse

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

getJsSafePortletId

public static String getJsSafePortletId(String portletId)

getLayoutActualURL

public static String getLayoutActualURL(Layout layout)

getLayoutActualURL

public static String getLayoutActualURL(Layout layout,
                                        String mainPath)

getLayoutActualURL

public static String getLayoutActualURL(long groupId,
                                        boolean privateLayout,
                                        String mainPath,
                                        String friendlyURL)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getLayoutActualURL

public static String getLayoutActualURL(long groupId,
                                        boolean privateLayout,
                                        String mainPath,
                                        String friendlyURL,
                                        Map<String,String[]> params,
                                        Map<String,Object> requestContext)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getLayoutEditPage

public static String getLayoutEditPage(Layout layout)

getLayoutEditPage

public static String getLayoutEditPage(String type)

getLayoutFriendlyURL

public static String getLayoutFriendlyURL(Layout layout,
                                          ThemeDisplay themeDisplay)
                                   throws PortalException,
                                          SystemException

Throws:: PortalException; SystemException

getLayoutFriendlyURL

public static String getLayoutFriendlyURL(Layout layout,
                                          ThemeDisplay themeDisplay,
                                          Locale locale)
                                   throws PortalException,
                                          SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static String getLayoutFullURL(Layout layout,
                                      ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static String getLayoutFullURL(Layout layout,
                                      ThemeDisplay themeDisplay,
                                      boolean doAsUser)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static String getLayoutFullURL(long groupId,
                                      String portletId)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getLayoutFullURL

public static String getLayoutFullURL(ThemeDisplay themeDisplay)
                               throws PortalException,
                                      SystemException

Throws:: PortalException; SystemException

getLayoutSetFriendlyURL

public static String getLayoutSetFriendlyURL(LayoutSet layoutSet,
                                             ThemeDisplay themeDisplay)
                                      throws PortalException,
                                             SystemException

Throws:: PortalException; SystemException

getLayoutTarget

public static String getLayoutTarget(Layout layout)

getLayoutURL

public static String getLayoutURL(Layout layout,
                                  ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getLayoutURL

public static String getLayoutURL(Layout layout,
                                  ThemeDisplay themeDisplay,
                                  boolean doAsUser)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getLayoutURL

public static String getLayoutURL(ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getLayoutViewPage

public static String getLayoutViewPage(Layout layout)

getLayoutViewPage

public static String getLayoutViewPage(String type)

getLiferayPortletResponse

public static LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)

getLocale

public static Locale getLocale(javax.servlet.http.HttpServletRequest request)

getLocale

public static Locale getLocale(RenderRequest renderRequest)

getModel

public static BaseModel<?> getModel(Resource resource)
                             throws PortalException,
                                    SystemException

Deprecated. getBaseModel(Resource)

Throws:: PortalException; SystemException

getModel

public static BaseModel<?> getModel(ResourcePermission resourcePermission)
                             throws PortalException,
                                    SystemException

Deprecated. getBaseModel(ResourcePermission)

Throws:: PortalException; SystemException

getModel

public static BaseModel<?> getModel(String modelName,
                                    String primKey)
                             throws PortalException,
                                    SystemException

Deprecated. getBaseModel(String, String)

Throws:: PortalException; SystemException

getNetvibesURL

public static String getNetvibesURL(Portlet portlet,
                                    ThemeDisplay themeDisplay)
                             throws PortalException,
                                    SystemException

Throws:: PortalException; SystemException

getOriginalServletRequest

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

getParentGroupId

public static long getParentGroupId(long scopeGroupId)
                             throws PortalException,
                                    SystemException

Throws:: PortalException; SystemException

getPathContext

public static String getPathContext()

getPathFriendlyURLPrivateGroup

public static String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

public static String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

public static String getPathFriendlyURLPublic()

getPathImage

public static String getPathImage()

getPathMain

public static String getPathMain()

getPlidFromFriendlyURL

public static long getPlidFromFriendlyURL(long companyId,
                                          String friendlyURL)

getPlidFromPortletId

public static long getPlidFromPortletId(long groupId,
                                        boolean privateLayout,
                                        String portletId)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getPlidFromPortletId

public static long getPlidFromPortletId(long groupId,
                                        String portletId)
                                 throws PortalException,
                                        SystemException

Throws:: PortalException; SystemException

getPortal

public static Portal getPortal()

getPortalLibDir

public static String getPortalLibDir()

getPortalPort

public static int getPortalPort()

getPortalProperties

public static Properties getPortalProperties()

getPortalURL

public static String getPortalURL(javax.servlet.http.HttpServletRequest request)

getPortalURL

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

getPortalURL

public static String getPortalURL(PortletRequest portletRequest)

getPortalURL

public static String getPortalURL(PortletRequest portletRequest,
                                  boolean secure)

getPortalURL

public static String getPortalURL(String serverName,
                                  int serverPort,
                                  boolean secure)

getPortalURL

public static String getPortalURL(ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

getPortalWebDir

public static String getPortalWebDir()

getPortletBreadcrumbList

public static List<KeyValuePair> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)

getPortletDescription

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

getPortletDescription

public static String getPortletDescription(Portlet portlet,
                                           User user)

getPortletDescription

public static String getPortletDescription(String portletId,
                                           Locale locale)

getPortletDescription

public static String getPortletDescription(String portletId,
                                           String languageId)

getPortletDescription

public static String getPortletDescription(String portletId,
                                           User user)

getPortletId

public static String getPortletId(javax.servlet.http.HttpServletRequest request)

getPortletId

public static String getPortletId(PortletRequest portletRequest)

getPortletNamespace

public static String getPortletNamespace(String portletId)

getPortletTitle

public static String getPortletTitle(Portlet portlet,
                                     Locale locale)

getPortletTitle

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

getPortletTitle

public static String getPortletTitle(Portlet portlet,
                                     String languageId)

getPortletTitle

public static String getPortletTitle(Portlet portlet,
                                     User user)

getPortletTitle

public static String getPortletTitle(RenderResponse renderResponse)

getPortletTitle

public static String getPortletTitle(String portletId,
                                     Locale locale)

getPortletTitle

public static String getPortletTitle(String portletId,
                                     String languageId)

getPortletTitle

public static String getPortletTitle(String portletId,
                                     User user)

getPortletXmlFileName

public static String getPortletXmlFileName()
                                    throws SystemException

Throws:: SystemException

getPreferences

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

getPreferencesValidator

public static PreferencesValidator getPreferencesValidator(Portlet portlet)

getScopeGroupId

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

Throws:: PortalException; SystemException

getScopeGroupId

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

Throws:: PortalException; SystemException

getScopeGroupId

public static long getScopeGroupId(Layout layout)

getScopeGroupId

public static long getScopeGroupId(Layout layout,
                                   String portletId)

getScopeGroupId

public static long getScopeGroupId(long plid)

getScopeGroupId

public static long getScopeGroupId(PortletRequest portletRequest)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getSelectedUser

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

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(PortletRequest portletRequest)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getSelectedUser

public static User getSelectedUser(PortletRequest portletRequest,
                                   boolean checkPermission)
                            throws PortalException,
                                   SystemException

Throws:: PortalException; SystemException

getServletContext

public static javax.servlet.ServletContext getServletContext(Portlet portlet,
                                                             javax.servlet.ServletContext servletContext)

getSocialEquityActionMapping

public static SocialEquityActionMapping getSocialEquityActionMapping(String name,
                                                                     String actionId)

getSocialEquityActionMappings

public static List<SocialEquityActionMapping> getSocialEquityActionMappings(String name)

getSocialEquityClassNames

public static String[] getSocialEquityClassNames()

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStrutsAction

public static String getStrutsAction(javax.servlet.http.HttpServletRequest request)

getSystemCommunityRoles

public static String[] getSystemCommunityRoles()

getSystemGroups

public static String[] getSystemGroups()

getSystemOrganizationRoles

public static String[] getSystemOrganizationRoles()

getSystemRoles

public static String[] getSystemRoles()

getUploadServletRequest

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

getUploadPortletRequest

public static UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)

getUptime

public static Date getUptime()

getURLWithSessionId

public static String getURLWithSessionId(String url,
                                         String sessionId)

getUser

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

Throws:: PortalException; SystemException

getUser

public static User getUser(PortletRequest portletRequest)
                    throws PortalException,
                           SystemException

Throws:: PortalException; SystemException

getUserId

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

getUserId

public static long getUserId(PortletRequest portletRequest)

getUserName

public static String getUserName(long userId,
                                 String defaultUserName)

getUserName

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

getUserName

public static String getUserName(long userId,
                                 String defaultUserName,
                                 String userAttribute)

getUserName

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

getUserPassword

public static String getUserPassword(javax.servlet.http.HttpServletRequest request)

getUserPassword

public static String getUserPassword(javax.servlet.http.HttpSession session)

getUserPassword

public static String getUserPassword(PortletRequest portletRequest)

getUserValue

public static String getUserValue(long userId,
                                  String param,
                                  String defaultValue)
                           throws SystemException

Throws:: SystemException

getValidUserId

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

Throws:: PortalException; SystemException

getWidgetURL

public static String getWidgetURL(Portlet portlet,
                                  ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException

Throws:: PortalException; SystemException

isAllowAddPortletDefaultResource

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

Throws:: PortalException; SystemException

isCommunityAdmin

public static boolean isCommunityAdmin(User user,
                                       long groupId)
                                throws Exception

Throws:: Exception

isCommunityOwner

public static boolean isCommunityOwner(User user,
                                       long groupId)
                                throws Exception

Throws:: Exception

isCompanyAdmin

public static boolean isCompanyAdmin(User user)
                              throws Exception

Throws:: Exception

isControlPanelPortlet

public static boolean isControlPanelPortlet(String portletId,
                                            String category,
                                            ThemeDisplay themeDisplay)
                                     throws SystemException

Throws:: SystemException

isControlPanelPortlet

public static boolean isControlPanelPortlet(String portletId,
                                            ThemeDisplay themeDisplay)
                                     throws SystemException

Throws:: SystemException

isLayoutFirstPageable

public static boolean isLayoutFirstPageable(Layout layout)

isLayoutFirstPageable

public static boolean isLayoutFirstPageable(String type)

isLayoutFriendliable

public static boolean isLayoutFriendliable(Layout layout)

isLayoutFriendliable

public static boolean isLayoutFriendliable(String type)

isLayoutParentable

public static boolean isLayoutParentable(Layout layout)

isLayoutParentable

public static boolean isLayoutParentable(String type)

isLayoutSitemapable

public static boolean isLayoutSitemapable(Layout layout)

isMethodGet

public static boolean isMethodGet(PortletRequest portletRequest)

isMethodPost

public static boolean isMethodPost(PortletRequest portletRequest)

isOmniadmin

public static boolean isOmniadmin(long userId)

isReservedParameter

public static boolean isReservedParameter(String name)

isSystemGroup

public static boolean isSystemGroup(String groupName)

isSystemRole

public static boolean isSystemRole(String roleName)

isUpdateAvailable

public static boolean isUpdateAvailable()
                                 throws SystemException

Throws:: SystemException

isValidResourceId

public static boolean isValidResourceId(String resourceId)

removePortalPortEventListener

public void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)

renderPage

public static String renderPage(javax.servlet.ServletContext servletContext,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                String path,
                                boolean writeOutput)
                         throws IOException,
                                javax.servlet.ServletException

Throws:: IOException; javax.servlet.ServletException

renderPortlet

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

Throws:: IOException; javax.servlet.ServletException

renderPortlet

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

Throws:: IOException; javax.servlet.ServletException

renderPortlet

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

Throws:: IOException; javax.servlet.ServletException

runSQL

public static void runSQL(String sql)
                   throws IOException,
                          SQLException

Deprecated. DB.runSQL(String)

Throws:: IOException; SQLException

sendError

public static void sendError(Exception e,
                             ActionRequest actionRequest,
                             ActionResponse actionResponse)
                      throws IOException

Throws:: IOException

sendError

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

Throws:: IOException; javax.servlet.ServletException

sendError

public static void sendError(int status,
                             Exception e,
                             ActionRequest actionRequest,
                             ActionResponse actionResponse)
                      throws IOException

Throws:: IOException

sendError

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

Throws:: IOException; javax.servlet.ServletException

setPageDescription

public static void setPageDescription(String description,
                                      javax.servlet.http.HttpServletRequest request)

Sets the description for a page. This overrides the existing page description.

setPageKeywords

public static void setPageKeywords(String keywords,
                                   javax.servlet.http.HttpServletRequest request)

Sets the keywords for a page. This overrides the existing page keywords.

setPageSubtitle

public static void setPageSubtitle(String subtitle,
                                   javax.servlet.http.HttpServletRequest request)

Sets the subtitle for a page. This overrides the existing page subtitle.

setPageTitle

public static void setPageTitle(String title,
                                javax.servlet.http.HttpServletRequest request)

Sets the whole title for a page. This overrides the existing page whole title.

setPortalPort

public static void setPortalPort(javax.servlet.http.HttpServletRequest request)

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

storePreferences

public static void storePreferences(PortletPreferences preferences)
                             throws IOException,
                                    ValidatorException

Throws:: IOException; ValidatorException

transformCustomSQL

public static String transformCustomSQL(String sql)

updatePortletMode

public static PortletMode updatePortletMode(String portletId,
                                            User user,
                                            Layout layout,
                                            PortletMode portletMode,
                                            javax.servlet.http.HttpServletRequest request)

updateWindowState

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

setPortal

public void setPortal(Portal portal)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.0.5

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.util Class PortalUtil

PortalUtil

addPageDescription

addPageKeywords

addPageSubtitle

addPageTitle

addPortalPortEventListener

addPortletBreadcrumbEntry

addPortletDefaultResource

addPreservedParameters

addPreservedParameters

clearRequestParameters

copyRequestParameters

escapeRedirect

generateRandomKey

getBaseModel

getBaseModel

getBaseModel

getBasicAuthUserId

getDigestAuthUserId

getBasicAuthUserId

getCDNHost

getCDNHost

getCDNHostHttp

getCDNHostHttps

getClassName

getClassNameId

getClassNameId

getClassNamePortletId

getCommunityLoginURL

getCommunityPermissions

getCommunityPermissions

getCompany

getCompany

getCompanyId

getCompanyId

getCompanyIds

getComputerAddress

getComputerName

getControlPanelCategory

getControlPanelFullURL

getControlPanelPortlets

getCurrentCompleteURL

getCurrentURL

getCurrentURL

getCustomSQLFunctionIsNotNull

getCustomSQLFunctionIsNull

getDate

getDate

getDate

getDate

getDate

getDB

getDefaultCompanyId

getExpandoBridgeAttributes

getFacebookURL

getFirstPageLayoutTypes

getGlobalLibDir

getGoogleGadgetURL

getGuestPermissions

getGuestPermissions

getHomeURL

getHost

getHost

getHttpServletRequest

getHttpServletResponse

getJsSafePortletId

getLayoutActualURL

getLayoutActualURL

getLayoutActualURL

getLayoutActualURL

getLayoutEditPage

getLayoutEditPage

getLayoutFriendlyURL

getLayoutFriendlyURL

getLayoutFullURL

getLayoutFullURL

getLayoutFullURL

getLayoutFullURL

getLayoutSetFriendlyURL

com.liferay.portal.util
Class PortalUtil