com.liferay.portal.util
Interface Portal

All Known Implementing Classes:

PortalImpl

public interface Portal

Field Summary

static String	FRIENDLY_URL_SEPARATOR
static String	PATH_IMAGE
static String	PATH_MAIN
static String	PATH_PORTAL_LAYOUT
static String	PORTAL_REALM
static String	PORTLET_XML_FILE_NAME_CUSTOM
static String	PORTLET_XML_FILE_NAME_STANDARD
static String	TEMP_OBFUSCATION_VALUE

Method Summary

void	addPageDescription(String description, javax.servlet.http.HttpServletRequest request) Adds the description for a page.
void	addPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request) Adds the keywords for a page.
void	addPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request) Adds the subtitle for a page.
void	addPageTitle(String title, javax.servlet.http.HttpServletRequest request) Adds the whole title for a page.
void	addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
void	addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url)
void	addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)
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.
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.
void	clearRequestParameters(RenderRequest renderRequest)
void	copyRequestParameters(ActionRequest actionRequest, ActionResponse actionResponse)
String	escapeRedirect(String url)
String	generateRandomKey(javax.servlet.http.HttpServletRequest request, String input)
BaseModel<?>	getBaseModel(Resource resource)
BaseModel<?>	getBaseModel(ResourcePermission resourcePermission)
BaseModel<?>	getBaseModel(String modelName, String primKey)
long	getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
long	getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId)
String	getCDNHost() Deprecated. getCDNHost(boolean)
String	getCDNHost(boolean secure)
String	getCDNHostHttp()
String	getCDNHostHttps()
String	getClassName(long classNameId)
long	getClassNameId(Class<?> classObj)
long	getClassNameId(String value)
String	getClassNamePortletId(String className)
String	getCommunityLoginURL(ThemeDisplay themeDisplay)
String[]	getCommunityPermissions(javax.servlet.http.HttpServletRequest request)
String[]	getCommunityPermissions(PortletRequest portletRequest)
Company	getCompany(javax.servlet.http.HttpServletRequest request)
Company	getCompany(PortletRequest portletRequest)
long	getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
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)
List<Portlet>	getControlPanelPortlets(String category, 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)
Date	getDate(int month, int day, int year, int hour, int min, PortalException pe)
Date	getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, PortalException pe)
Date	getDate(int month, int day, int year, PortalException pe)
Date	getDate(int month, int day, int year, TimeZone timeZone, PortalException pe)
long	getDefaultCompanyId()
long	getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
Map<String,Serializable>	getExpandoBridgeAttributes(ExpandoBridge expandoBridge, PortletRequest portletRequest)
String	getFacebookURL(Portlet portlet, String facebookCanvasPageURL, ThemeDisplay themeDisplay)
String	getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
String	getGlobalLibDir()
String	getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
String[]	getGuestPermissions(javax.servlet.http.HttpServletRequest request)
String[]	getGuestPermissions(PortletRequest portletRequest)
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	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(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)
LiferayPortletResponse	getLiferayPortletResponse(PortletResponse portletResponse)
Locale	getLocale(javax.servlet.http.HttpServletRequest request)
Locale	getLocale(RenderRequest renderRequest)
String	getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay)
javax.servlet.http.HttpServletRequest	getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
long	getParentGroupId(long scopeGroupId)
String	getPathContext()
String	getPathFriendlyURLPrivateGroup()
String	getPathFriendlyURLPrivateUser()
String	getPathFriendlyURLPublic()
String	getPathImage()
String	getPathMain()
long	getPlidFromFriendlyURL(long companyId, String friendlyURL)
long	getPlidFromPortletId(long groupId, boolean privateLayout, String portletId)
long	getPlidFromPortletId(long groupId, String portletId)
String	getPortalLibDir()
int	getPortalPort()
Properties	getPortalProperties()
String	getPortalURL(javax.servlet.http.HttpServletRequest request)
String	getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)
String	getPortalURL(PortletRequest portletRequest)
String	getPortalURL(PortletRequest portletRequest, boolean secure)
String	getPortalURL(String serverName, int serverPort, boolean secure)
String	getPortalURL(ThemeDisplay themeDisplay)
String	getPortalWebDir()
List<KeyValuePair>	getPortletBreadcrumbList(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)
String	getPortletId(javax.servlet.http.HttpServletRequest request)
String	getPortletId(PortletRequest portletRequest)
String	getPortletNamespace(String portletId)
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)
long	getScopeGroupId(javax.servlet.http.HttpServletRequest request)
long	getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId)
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)
SocialEquityActionMapping	getSocialEquityActionMapping(String name, String actionId)
List<SocialEquityActionMapping>	getSocialEquityActionMappings(String name)
String[]	getSocialEquityClassNames()
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[]	getSystemCommunityRoles()
String[]	getSystemGroups()
String[]	getSystemOrganizationRoles()
String[]	getSystemRoles()
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)
long	getUserId(javax.servlet.http.HttpServletRequest request)
long	getUserId(PortletRequest portletRequest)
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	getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
boolean	isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet)
boolean	isCommunityAdmin(User user, long groupId)
boolean	isCommunityOwner(User user, long groupId)
boolean	isCompanyAdmin(User user)
boolean	isControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)
boolean	isControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)
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	isOmniadmin(long userId)
boolean	isReservedParameter(String name)
boolean	isSystemGroup(String groupName)
boolean	isSystemRole(String roleName)
boolean	isUpdateAvailable()
boolean	isValidResourceId(String resourceId)
void	removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
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	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)
void	setPageDescription(String description, javax.servlet.http.HttpServletRequest request) Sets the description for a page.
void	setPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request) Sets the keywords for a page.
void	setPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request) Sets the subtitle for a page.
void	setPageTitle(String title, javax.servlet.http.HttpServletRequest request) Sets the whole title for a page.
void	setPortalPort(javax.servlet.http.HttpServletRequest request) Sets the port obtained on the first request to the portal.
void	storePreferences(PortletPreferences preferences)
String	transformCustomSQL(String sql)
PortletMode	updatePortletMode(String portletId, User user, Layout layout, PortletMode portletMode, javax.servlet.http.HttpServletRequest request)
WindowState	updateWindowState(String portletId, User user, Layout layout, WindowState windowState, javax.servlet.http.HttpServletRequest request)

Field Detail

FRIENDLY_URL_SEPARATOR

static final String FRIENDLY_URL_SEPARATOR

See Also:

Constant Field Values

PATH_IMAGE

static final String PATH_IMAGE

See Also:

Constant Field Values

PATH_MAIN

static final String PATH_MAIN

See Also:

Constant Field Values

PATH_PORTAL_LAYOUT

static final String PATH_PORTAL_LAYOUT

See Also:

Constant Field Values

PORTAL_REALM

static final String PORTAL_REALM

See Also:

Constant Field Values

PORTLET_XML_FILE_NAME_CUSTOM

static final String PORTLET_XML_FILE_NAME_CUSTOM

See Also:

Constant Field Values

PORTLET_XML_FILE_NAME_STANDARD

static final String PORTLET_XML_FILE_NAME_STANDARD

See Also:

Constant Field Values

TEMP_OBFUSCATION_VALUE

static final String TEMP_OBFUSCATION_VALUE

See Also:

Constant Field Values

Method Detail

addPageDescription

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

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

addPageKeywords

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

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

addPageSubtitle

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

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

addPageTitle

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

void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)

addPortletBreadcrumbEntry

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

addPortletDefaultResource

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

Throws:

PortalException

SystemException

addPreservedParameters

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

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

void clearRequestParameters(RenderRequest renderRequest)

copyRequestParameters

void copyRequestParameters(ActionRequest actionRequest,
                           ActionResponse actionResponse)

escapeRedirect

String escapeRedirect(String url)

generateRandomKey

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

getBaseModel

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

Throws:

PortalException

SystemException

getBaseModel

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

Throws:

PortalException

SystemException

getBaseModel

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

Throws:

PortalException

SystemException

getBasicAuthUserId

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

Throws:

PortalException

SystemException

getBasicAuthUserId

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

Throws:

PortalException

SystemException

getCDNHost

String getCDNHost()

Deprecated. getCDNHost(boolean)

getCDNHost

String getCDNHost(boolean secure)

getCDNHostHttp

String getCDNHostHttp()

getCDNHostHttps

String getCDNHostHttps()

getClassName

String getClassName(long classNameId)

getClassNameId

long getClassNameId(Class<?> classObj)

getClassNameId

long getClassNameId(String value)

getClassNamePortletId

String getClassNamePortletId(String className)

getCommunityLoginURL

String getCommunityLoginURL(ThemeDisplay themeDisplay)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getCommunityPermissions

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

getCommunityPermissions

String[] getCommunityPermissions(PortletRequest portletRequest)

getCompany

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

Throws:

PortalException

SystemException

getCompany

Company getCompany(PortletRequest portletRequest)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getCompanyId

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

getCompanyId

long getCompanyId(PortletRequest portletRequest)

getCompanyIds

long[] getCompanyIds()

getComputerAddress

String getComputerAddress()

getComputerName

String getComputerName()

getControlPanelCategory

String getControlPanelCategory(String portletId,
                               ThemeDisplay themeDisplay)
                               throws SystemException

Throws:

SystemException

getControlPanelFullURL

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

Throws:

PortalException

SystemException

getControlPanelPortlets

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

Throws:

SystemException

getCurrentCompleteURL

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

getCurrentURL

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

getCurrentURL

String getCurrentURL(PortletRequest portletRequest)

getCustomSQLFunctionIsNotNull

String getCustomSQLFunctionIsNotNull()

getCustomSQLFunctionIsNull

String getCustomSQLFunctionIsNull()

getDate

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

getDate

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

Throws:

PortalException

getDate

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

Throws:

PortalException

getDate

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

Throws:

PortalException

getDate

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

Throws:

PortalException

getDefaultCompanyId

long getDefaultCompanyId()

getDigestAuthUserId

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

Throws:

PortalException

SystemException

getExpandoBridgeAttributes

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

Throws:

PortalException

SystemException

getFacebookURL

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

Throws:

PortalException

SystemException

getFirstPageLayoutTypes

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

getGlobalLibDir

String getGlobalLibDir()

getGoogleGadgetURL

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

Throws:

PortalException

SystemException

getGuestPermissions

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

getGuestPermissions

String[] getGuestPermissions(PortletRequest portletRequest)

getHomeURL

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

Throws:

PortalException

SystemException

getHost

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

getHost

String getHost(PortletRequest portletRequest)

getHttpServletRequest

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

getHttpServletResponse

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

getJsSafePortletId

String getJsSafePortletId(String portletId)

getLayoutActualURL

String getLayoutActualURL(Layout layout)

getLayoutActualURL

String getLayoutActualURL(Layout layout,
                          String mainPath)

getLayoutActualURL

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

Throws:

PortalException

SystemException

getLayoutActualURL

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

String getLayoutEditPage(Layout layout)

getLayoutEditPage

String getLayoutEditPage(String type)

getLayoutFriendlyURL

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

Throws:

PortalException

SystemException

getLayoutFriendlyURL

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

Throws:

PortalException

SystemException

getLayoutFullURL

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

Throws:

PortalException

SystemException

getLayoutFullURL

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

Throws:

PortalException

SystemException

getLayoutFullURL

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

Throws:

PortalException

SystemException

getLayoutFullURL

String getLayoutFullURL(ThemeDisplay themeDisplay)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getLayoutSetFriendlyURL

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

Throws:

PortalException

SystemException

getLayoutTarget

String getLayoutTarget(Layout layout)

getLayoutURL

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

Throws:

PortalException

SystemException

getLayoutURL

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

Throws:

PortalException

SystemException

getLayoutURL

String getLayoutURL(ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getLayoutViewPage

String getLayoutViewPage(Layout layout)

getLayoutViewPage

String getLayoutViewPage(String type)

getLiferayPortletResponse

LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)

getLocale

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

getLocale

Locale getLocale(RenderRequest renderRequest)

getNetvibesURL

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

Throws:

PortalException

SystemException

getOriginalServletRequest

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

getParentGroupId

long getParentGroupId(long scopeGroupId)
                      throws SystemException,
                             PortalException

Throws:

SystemException

PortalException

getPathContext

String getPathContext()

getPathFriendlyURLPrivateGroup

String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

String getPathFriendlyURLPublic()

getPathImage

String getPathImage()

getPathMain

String getPathMain()

getPlidFromFriendlyURL

long getPlidFromFriendlyURL(long companyId,
                            String friendlyURL)

getPlidFromPortletId

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

Throws:

PortalException

SystemException

getPlidFromPortletId

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

Throws:

PortalException

SystemException

getPortalLibDir

String getPortalLibDir()

getPortalPort

int getPortalPort()

getPortalProperties

Properties getPortalProperties()

getPortalURL

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

getPortalURL

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

getPortalURL

String getPortalURL(PortletRequest portletRequest)

getPortalURL

String getPortalURL(PortletRequest portletRequest,
                    boolean secure)

getPortalURL

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

getPortalURL

String getPortalURL(ThemeDisplay themeDisplay)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getPortalWebDir

String getPortalWebDir()

getPortletBreadcrumbList

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

getPortletDescription

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

getPortletDescription

String getPortletDescription(Portlet portlet,
                             User user)

getPortletDescription

String getPortletDescription(String portletId,
                             Locale locale)

getPortletDescription

String getPortletDescription(String portletId,
                             String languageId)

getPortletDescription

String getPortletDescription(String portletId,
                             User user)

getPortletId

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

getPortletId

String getPortletId(PortletRequest portletRequest)

getPortletNamespace

String getPortletNamespace(String portletId)

getPortletTitle

String getPortletTitle(Portlet portlet,
                       Locale locale)

getPortletTitle

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

getPortletTitle

String getPortletTitle(Portlet portlet,
                       String languageId)

getPortletTitle

String getPortletTitle(Portlet portlet,
                       User user)

getPortletTitle

String getPortletTitle(RenderResponse renderResponse)

getPortletTitle

String getPortletTitle(String portletId,
                       Locale locale)

getPortletTitle

String getPortletTitle(String portletId,
                       String languageId)

getPortletTitle

String getPortletTitle(String portletId,
                       User user)

getPortletXmlFileName

String getPortletXmlFileName()
                             throws SystemException

Throws:

SystemException

getPreferences

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

getPreferencesValidator

PreferencesValidator getPreferencesValidator(Portlet portlet)

getScopeGroupId

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

Throws:

PortalException

SystemException

getScopeGroupId

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

Throws:

PortalException

SystemException

getScopeGroupId

long getScopeGroupId(Layout layout)

getScopeGroupId

long getScopeGroupId(Layout layout,
                     String portletId)

getScopeGroupId

long getScopeGroupId(long plid)

getScopeGroupId

long getScopeGroupId(PortletRequest portletRequest)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getSelectedUser

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

Throws:

PortalException

SystemException

getSelectedUser

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

Throws:

PortalException

SystemException

getSelectedUser

User getSelectedUser(PortletRequest portletRequest)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getSelectedUser

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

Throws:

PortalException

SystemException

getServletContext

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

getSocialEquityActionMapping

SocialEquityActionMapping getSocialEquityActionMapping(String name,
                                                       String actionId)

getSocialEquityActionMappings

List<SocialEquityActionMapping> getSocialEquityActionMappings(String name)

getSocialEquityClassNames

String[] getSocialEquityClassNames()

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStaticResourceURL

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

getStrutsAction

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

getSystemCommunityRoles

String[] getSystemCommunityRoles()

getSystemGroups

String[] getSystemGroups()

getSystemOrganizationRoles

String[] getSystemOrganizationRoles()

getSystemRoles

String[] getSystemRoles()

getUploadServletRequest

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

getUploadPortletRequest

UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)

getUptime

Date getUptime()

getURLWithSessionId

String getURLWithSessionId(String url,
                           String sessionId)

getUser

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

Throws:

PortalException

SystemException

getUser

User getUser(PortletRequest portletRequest)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

getUserId

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

getUserId

long getUserId(PortletRequest portletRequest)

getUserName

String getUserName(long userId,
                   String defaultUserName)

getUserName

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

getUserName

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

getUserName

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

getUserPassword

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

getUserPassword

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

getUserPassword

String getUserPassword(PortletRequest portletRequest)

getUserValue

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

Throws:

SystemException

getValidUserId

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

Throws:

PortalException

SystemException

getWidgetURL

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

Throws:

PortalException

SystemException

isAllowAddPortletDefaultResource

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

Throws:

PortalException

SystemException

isCommunityAdmin

boolean isCommunityAdmin(User user,
                         long groupId)
                         throws Exception

Throws:

Exception

isCommunityOwner

boolean isCommunityOwner(User user,
                         long groupId)
                         throws Exception

Throws:

Exception

isCompanyAdmin

boolean isCompanyAdmin(User user)
                       throws Exception

Throws:

Exception

isControlPanelPortlet

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

Throws:

SystemException

isControlPanelPortlet

boolean isControlPanelPortlet(String portletId,
                              ThemeDisplay themeDisplay)
                              throws SystemException

Throws:

SystemException

isLayoutFirstPageable

boolean isLayoutFirstPageable(Layout layout)

isLayoutFirstPageable

boolean isLayoutFirstPageable(String type)

isLayoutFriendliable

boolean isLayoutFriendliable(Layout layout)

isLayoutFriendliable

boolean isLayoutFriendliable(String type)

isLayoutParentable

boolean isLayoutParentable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(String type)

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

isMethodGet

boolean isMethodGet(PortletRequest portletRequest)

isMethodPost

boolean isMethodPost(PortletRequest portletRequest)

isOmniadmin

boolean isOmniadmin(long userId)

isReservedParameter

boolean isReservedParameter(String name)

isSystemGroup

boolean isSystemGroup(String groupName)

isSystemRole

boolean isSystemRole(String roleName)

isUpdateAvailable

boolean isUpdateAvailable()
                          throws SystemException

Throws:

SystemException

isValidResourceId

boolean isValidResourceId(String resourceId)

removePortalPortEventListener

void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)

renderPage

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

Throws:

IOException

javax.servlet.ServletException

renderPortlet

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

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

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

sendError

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

Throws:

IOException

sendError

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

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

Throws:

IOException

sendError

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

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

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

setPageKeywords

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

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

setPageSubtitle

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

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

setPageTitle

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

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

setPortalPort

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

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

storePreferences

void storePreferences(PortletPreferences preferences)
                      throws IOException,
                             ValidatorException

Throws:

IOException

ValidatorException

transformCustomSQL

String transformCustomSQL(String sql)

updatePortletMode

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

updateWindowState

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