com.liferay.portal.util
Interface Portal

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

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)

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

Parameters:

description - the description to append to the current meta description

request - the servlet request for the page

addPageKeywords

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

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

Parameters:

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

request - the servlet request for the page

addPageSubtitle

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

Appends the subtitle to the current subtitle of the page.

Parameters:

subtitle - the subtitle to append to the current subtitle

request - the servlet request for the page

addPageTitle

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

Appends the title to the current title of the page.

Parameters:

title - the title to append to the current title

request - the servlet request for the page

addPortalPortEventListener

void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)

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

Parameters:

portalPortEventListener - the portal port event listener to add

addPortletBreadcrumbEntry

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

Adds an entry to the portlet breadcrumbs for the page.

Parameters:

request - the servlet request for the page

title - the title of the new breakcrumb entry

url - the URL of the new breadcrumb entry

addPortletBreadcrumbEntry

void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
                               String title,
                               String url,
                               Map<String,Object> data)

Adds an entry to the portlet breadcrumbs for the page.

Parameters:

request - the servlet request for the page

title - the title of the new breakcrumb entry

url - the URL of the new breadcrumb entry

data - the HTML5 data parameters of the new breadcrumb entry

addPortletDefaultResource

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

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

Parameters:

request - the servlet request for the page

portlet - the portlet

Throws:

PortalException - if adding the default resource permissions failed

SystemException - if a system exception occurred

addPortletDefaultResource

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

Throws:

PortalException

SystemException

addPreservedParameters

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

Adds the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well.

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

Parameters:

themeDisplay - the current theme display

layout - the current layout

url - the URL

doAsUser - whether to include doAsUserId and doAsLanguageId in the URL if they are available. If false, doAsUserId and doAsUserLanguageId will never be added.

Returns:

the URL with the preserved parameters added

addPreservedParameters

String addPreservedParameters(ThemeDisplay themeDisplay,
                              String url)

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

Parameters:

themeDisplay - the current theme display

url - the URL

Returns:

the URL with the preserved parameters added

clearRequestParameters

void clearRequestParameters(RenderRequest renderRequest)

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

Parameters:

renderRequest - the render request

copyRequestParameters

void copyRequestParameters(ActionRequest actionRequest,
                           ActionResponse actionResponse)

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

Parameters:

actionRequest - the request from which to get the request parameters

actionResponse - the response to receive the render parameters

escapeRedirect

String escapeRedirect(String url)

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

Parameters:

url - the URL to escape

Returns:

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

generateRandomKey

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

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

Parameters:

request - the servlet request for the page

input - the input string

Returns:

the generated key

getActualURL

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

Throws:

PortalException

SystemException

getAlternateLocales

Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request)
                             throws PortalException,
                                    SystemException

Returns an array with the alternate locales, considering if the page is showing just a content and the translations of this content.

Parameters:

request - the servlet request for the page

Returns:

the array of alternate locales

Throws:

PortalException

SystemException

getAlternateURL

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

Deprecated. getAlternateURL(String, ThemeDisplay, Locale)

getAlternateURL

String getAlternateURL(String canonicalURL,
                       ThemeDisplay themeDisplay,
                       Locale locale)

Returns the alternate URL of the page, to distinguish it from its canonical URL.

Parameters:

canonicalURL - the canonical URL previously obtained

themeDisplay - the theme display

locale - the locale of the translated page

Returns:

the alternate URL

getAuthTokenIgnoreActions

Set<String> getAuthTokenIgnoreActions()

Returns the set of struts actions that should not be checked for an authentication token.

Returns:

the set of struts actions that should not be checked for an authentication token

getAuthTokenIgnorePortlets

Set<String> getAuthTokenIgnorePortlets()

Returns the set of IDs of portlets that should not be checked for an authentication token.

Returns:

the set of IDs of portlets that should not be checked for an authentication token

getBaseModel

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

Returns the base model instance for the resource.

Parameters:

resource - the resource

Returns:

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

Throws:

PortalException - if a base model instance for the resource could not be found

SystemException - if a system exception occurred

getBaseModel

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

Returns the base model instance for the resource permission.

Parameters:

resourcePermission - the resource permission

Returns:

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

Throws:

PortalException - if a base model instance for the resource permission could not be found

SystemException - if a system exception occurred

getBaseModel

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

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

Parameters:

modelName - the fully qualified class name of the model

primKey - the primary key of the model instance to get

Returns:

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

Throws:

PortalException - if a base model instance with the primary key could not be found

SystemException - if a system exception occurred

getBasicAuthUserId

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

Returns the user's ID from the HTTP authentication headers after validating their credentials.

Parameters:

request - the servlet request from which to retrieve the HTTP authentication headers

Returns:

the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise

Throws:

PortalException - if an authentication exception occurred

SystemException - if a system exception occurred

getBasicAuthUserId

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

Returns the user's ID from the HTTP authentication headers after validation their credentials.

Parameters:

request - the servlet request to retrieve the HTTP authentication headers from

companyId - unused

Returns:

the user's ID if HTTP authentication headers are present and their credentials are valid; 0 otherwise

Throws:

PortalException - if an authentication exception occurred

SystemException - if a system exception occurred

getCanonicalURL

String getCanonicalURL(String completeURL,
                       ThemeDisplay themeDisplay)
                       throws PortalException,
                              SystemException

Deprecated. getCanonicalURL(String, ThemeDisplay, Layout)

Throws:

PortalException

SystemException

getCanonicalURL

String getCanonicalURL(String completeURL,
                       ThemeDisplay themeDisplay,
                       Layout layout)
                       throws PortalException,
                              SystemException

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

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

Returns:

the canonical URL

Throws:

PortalException - if a friendly URL or the group could not be retrieved

SystemException - if a system exception occurred

getCanonicalURL

String getCanonicalURL(String completeURL,
                       ThemeDisplay themeDisplay,
                       Layout layout,
                       boolean forceLayoutFriendlyURL)
                       throws PortalException,
                              SystemException

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

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

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

Returns:

the canonical URL

Throws:

PortalException - if a friendly URL or the group could not be retrieved

SystemException - if a system exception occurred

getCDNHost

String getCDNHost()

Deprecated. Replaced by the more general getCDNHost(boolean)

getCDNHost

String getCDNHost(boolean secure)

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

Parameters:

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

Returns:

the CDN host address

getCDNHost

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

Throws:

PortalException

SystemException

getCDNHostHttp

String getCDNHostHttp(long companyId)

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

Returns:

the CDN host address

getCDNHostHttps

String getCDNHostHttps(long companyId)

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

Returns:

the CDN host address

getClassName

String getClassName(long classNameId)

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

Parameters:

classNameId - the ID of the class

Returns:

the fully qualified name of the class

getClassNameId

long getClassNameId(Class<?> clazz)

Returns the ID of the class from its class object.

Parameters:

clazz - the class object

Returns:

the ID of the class

getClassNameId

long getClassNameId(String value)

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

Parameters:

value - the fully qualified name of the class

Returns:

the ID of the class

getClassNamePortletId

String getClassNamePortletId(String className)

Returns the ID of certain portlets from the fully qualified name of one of their classes. The portlets this method supports are: blogs, bookmarks, calendar, document library, image gallery, journal, message boards, and wiki.

Parameters:

className - the fully qualified name of a class in a portlet

Returns:

the ID of the portlet the class is a part of, or an empty string if the class is not supported

getCompany

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

Set<Portlet> getControlPanelPortlets(long companyId,
                                     String category)
                                     throws SystemException

Throws:

SystemException

getControlPanelPortlets

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

Throws:

SystemException

getCreateAccountURL

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

Throws:

Exception

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)

Returns the date object for the specified month, day, and year.

Parameters:

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

day - the day of the month

year - the year

Returns:

the date object

getDate

Date getDate(int month,
             int day,
             int year,
             Class<? extends PortalException> clazz)
             throws PortalException

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

Parameters:

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

day - the day of the month

year - the year

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

Date getDate(int month,
             int day,
             int year,
             int hour,
             int min,
             Class<? extends PortalException> clazz)
             throws PortalException

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

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

Deprecated. getDate(int, int, int, int, int, Class)

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

Date getDate(int month,
             int day,
             int year,
             int hour,
             int min,
             TimeZone timeZone,
             Class<? extends PortalException> clazz)
             throws PortalException

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

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

Deprecated. getDate(int, int, int, int, int, TimeZone, Class)

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

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

Deprecated. getDate(int, int, int, Class)

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

Parameters:

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

day - the day of the month

year - the year

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

Date getDate(int month,
             int day,
             int year,
             TimeZone timeZone,
             Class<? extends PortalException> clazz)
             throws PortalException

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

Parameters:

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

day - the day of the month

year - the year

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDate

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

Deprecated. getDate(int, int, int, TimeZone, Class)

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

Parameters:

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

day - the day of the month

year - the year

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if the date was invalid and pe was not null

getDefaultCompanyId

long getDefaultCompanyId()

getDigestAuthUserId

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

Throws:

PortalException

SystemException

getEmailFromAddress

String getEmailFromAddress(PortletPreferences preferences,
                           long companyId,
                           String defaultValue)
                           throws SystemException

Throws:

SystemException

getEmailFromName

String getEmailFromName(PortletPreferences preferences,
                        long companyId,
                        String defaultValue)
                        throws SystemException

Throws:

SystemException

getExpandoBridgeAttributes

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

Throws:

PortalException

SystemException

getExpandoBridgeAttributes

Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                    UploadPortletRequest uploadPortletRequest)
                                                    throws PortalException,
                                                           SystemException

Throws:

PortalException

SystemException

getExpandoValue

Serializable getExpandoValue(PortletRequest portletRequest,
                             String name,
                             int type,
                             String displayType)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getExpandoValue

Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest,
                             String name,
                             int type,
                             String displayType)
                             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

getGroupFriendlyURL

String getGroupFriendlyURL(Group group,
                           boolean privateLayoutSet,
                           ThemeDisplay themeDisplay)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getGroupFriendlyURL

String getGroupFriendlyURL(Group group,
                           boolean privateLayoutSet,
                           ThemeDisplay themeDisplay,
                           Locale locale)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getGroupPermissions

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

getGroupPermissions

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

getGroupPermissions

String[] getGroupPermissions(PortletRequest portletRequest)

getGroupPermissions

String[] getGroupPermissions(PortletRequest portletRequest,
                             String className)

getGuestPermissions

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

getGuestPermissions

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

getGuestPermissions

String[] getGuestPermissions(PortletRequest portletRequest)

getGuestPermissions

String[] getGuestPermissions(PortletRequest portletRequest,
                             String className)

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)

getJournalArticleActualURL

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

Throws:

PortalException

SystemException

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(long groupId,
                        String portletId,
                        boolean secure)
                        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)

getLiferayPortletRequest

LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)

getLiferayPortletResponse

LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)

getLocale

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

getLocale

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

getLocale

Locale getLocale(RenderRequest renderRequest)

getMailId

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

getNetvibesURL

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

Throws:

PortalException

SystemException

getNewPortletTitle

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

getOriginalServletRequest

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

getParentGroupId

long getParentGroupId(long scopeGroupId)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getPathContext

String getPathContext()

getPathFriendlyURLPrivateGroup

String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

String getPathFriendlyURLPublic()

getPathImage

String getPathImage()

getPathMain

String getPathMain()

getPathProxy

String getPathProxy()

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

Deprecated. Replaced by the more general getPortalPort(boolean)

getPortalPort

int getPortalPort(boolean secure)

getPortalProperties

Properties getPortalProperties()

getPortalURL

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

getPortalURL

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

getPortalURL

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

Throws:

PortalException

SystemException

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

getPortletAddDefaultResourceCheckWhitelist

Set<String> getPortletAddDefaultResourceCheckWhitelist()

getPortletAddDefaultResourceCheckWhitelistActions

Set<String> getPortletAddDefaultResourceCheckWhitelistActions()

getPortletBreadcrumbList

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

Deprecated. Renamed to getPortletBreadcrumbs(HttpServletRequest)

getPortletBreadcrumbs

List<BreadcrumbEntry> getPortletBreadcrumbs(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)

getPortletLongTitle

String getPortletLongTitle(Portlet portlet,
                           Locale locale)

getPortletLongTitle

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

getPortletLongTitle

String getPortletLongTitle(Portlet portlet,
                           String languageId)

getPortletLongTitle

String getPortletLongTitle(Portlet portlet,
                           User user)

getPortletLongTitle

String getPortletLongTitle(String portletId,
                           Locale locale)

getPortletLongTitle

String getPortletLongTitle(String portletId,
                           String languageId)

getPortletLongTitle

String getPortletLongTitle(String portletId,
                           User user)

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)

getRelativeHomeURL

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

Throws:

PortalException

SystemException

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(javax.servlet.http.HttpServletRequest request,
                     String portletId,
                     boolean checkStagingGroup)
                     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)

getSiteLoginURL

String getSiteLoginURL(ThemeDisplay themeDisplay)
                       throws PortalException,
                              SystemException

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

Parameters:

themeDisplay - the theme display for the current page

Returns:

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

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

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)

getSystemGroups

String[] getSystemGroups()

getSystemOrganizationRoles

String[] getSystemOrganizationRoles()

getSystemRoles

String[] getSystemRoles()

getSystemSiteRoles

String[] getSystemSiteRoles()

getUniqueElementId

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

getUniqueElementId

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

getUploadPortletRequest

UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)

getUploadServletRequest

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

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

getUserEmailAddress

String getUserEmailAddress(long userId)
                           throws SystemException

Throws:

SystemException

getUserId

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

getUserId

long getUserId(PortletRequest portletRequest)

getUserName

String getUserName(BaseModel<?> baseModel)

getUserName

String getUserName(long userId,
                   String defaultUserName)

getUserName

String getUserName(long userId,
                   String defaultUserName,
                   javax.servlet.http.HttpServletRequest 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

getVirtualLayoutActualURL

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

Throws:

PortalException

SystemException

getWidgetURL

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

Throws:

PortalException

SystemException

initCustomSQL

void initCustomSQL()

initUser

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

Throws:

Exception

isAllowAddPortletDefaultResource

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

Throws:

PortalException

SystemException

isCDNDynamicResourcesEnabled

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

Throws:

PortalException

SystemException

isCDNDynamicResourcesEnabled

boolean isCDNDynamicResourcesEnabled(long companyId)

isCommunityAdmin

boolean isCommunityAdmin(User user,
                         long groupId)
                         throws Exception

Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long)

Throws:

Exception

isCommunityOwner

boolean isCommunityOwner(User user,
                         long groupId)
                         throws Exception

Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long)

Throws:

Exception

isCompanyAdmin

boolean isCompanyAdmin(User user)
                       throws Exception

Throws:

Exception

isCompanyControlPanelPortlet

boolean isCompanyControlPanelPortlet(String portletId,
                                     String category,
                                     ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

isCompanyControlPanelPortlet

boolean isCompanyControlPanelPortlet(String portletId,
                                     ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

isCompanyControlPanelVisible

boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

isControlPanelPortlet

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

Throws:

SystemException

isControlPanelPortlet

boolean isControlPanelPortlet(String portletId,
                              ThemeDisplay themeDisplay)
                              throws SystemException

Throws:

SystemException

isGroupAdmin

boolean isGroupAdmin(User user,
                     long groupId)
                     throws Exception

Throws:

Exception

isGroupFriendlyURL

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

isGroupOwner

boolean isGroupOwner(User user,
                     long groupId)
                     throws Exception

Throws:

Exception

isLayoutDescendant

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

Throws:

PortalException

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)

isMultipartRequest

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

isOmniadmin

boolean isOmniadmin(long userId)

isReservedParameter

boolean isReservedParameter(String name)

isSecure

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

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

resetCDNHosts

void resetCDNHosts()

resetPortletAddDefaultResourceCheckWhitelist

Set<String> resetPortletAddDefaultResourceCheckWhitelist()

resetPortletAddDefaultResourceCheckWhitelistActions

Set<String> resetPortletAddDefaultResourceCheckWhitelistActions()

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 the page, overriding the existing page description.

setPageKeywords

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

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

setPageSubtitle

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

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

setPageTitle

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

Sets the whole title for the page, overriding 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 portletPreferences)
                      throws IOException,
                             ValidatorException

Throws:

IOException

ValidatorException

stripURLAnchor

String[] stripURLAnchor(String url,
                        String separator)

transformCustomSQL

String transformCustomSQL(String sql)

transformSQL

String transformSQL(String sql)

updatePortletMode

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

updateRedirect

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

updateWindowState

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