com.liferay.portal.kernel.util

Interface Portal

@ProviderType
public interface Portal

Author:

Brian Wing Shun Chan, Eduardo Lundgren, Marco Leo

Field Summary

Fields

Modifier and Type	Field and Description
static String	FRIENDLY_URL_SEPARATOR
static String	JSESSIONID
static String	PATH_IMAGE
static String	PATH_MAIN
static String	PATH_MODULE
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

Modifier and Type	Method and Description
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.
boolean	addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)
void	addPortalPortEventListener(PortalPortEventListener portalPortEventListener) Deprecated. As of Wilberforce (7.0.x), replaced by addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)
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	addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url, Map<String,Object> data, boolean portletBreadcrumbEntry) 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, and refererPlid to the URL.
String	addPreservedParameters(ThemeDisplay themeDisplay, String url, boolean typeControlPanel, boolean doAsUser)
void	addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)
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	getAbsoluteURL(javax.servlet.http.HttpServletRequest request, String url)
LayoutQueryStringComposite	getActualLayoutQueryStringComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
String	getActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
String	getAlternateURL(String canonicalURL, ThemeDisplay themeDisplay, Locale locale, Layout layout) Returns the alternate URL for the requested canonical URL in the given locale.
Map<Locale,String>	getAlternateURLs(String canonicalURL, ThemeDisplay themeDisplay, Layout layout)
long[]	getAncestorSiteGroupIds(long groupId)
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) Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)
long	getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId) Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)
List<Group>	getBrowsableScopeGroups(long userId, long companyId, long groupId, String portletId)
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	getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL, boolean includeQueryString) Returns the canonical URL of the page.
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.
Company	getCompany(javax.servlet.http.HttpServletRequest request)
Company	getCompany(PortletRequest portletRequest)
long	getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
long	getCompanyId(PortletRequest portletRequest)
long[]	getCompanyIds()
Set<String>	getComputerAddresses()
String	getComputerName()
String	getControlPanelFullURL(long scopeGroupId, String ppid, Map<String,String[]> params)
long	getControlPanelPlid(long companyId)
long	getControlPanelPlid(PortletRequest portletRequest)
PortletURL	getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, Group group, String portletId, long refererGroupId, long refererPlid, String lifecycle)
PortletURL	getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, String portletId, String lifecycle)
PortletURL	getControlPanelPortletURL(PortletRequest portletRequest, Group group, String portletId, long refererGroupId, long refererPlid, String lifecycle)
PortletURL	getControlPanelPortletURL(PortletRequest portletRequest, String portletId, String lifecycle)
String	getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay)
long[]	getCurrentAndAncestorSiteGroupIds(long groupId)
long[]	getCurrentAndAncestorSiteGroupIds(long[] groupIds)
long[]	getCurrentAndAncestorSiteGroupIds(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
long[]	getCurrentAndAncestorSiteGroupIds(long groupId, boolean checkContentSharingWithChildrenEnabled)
List<Group>	getCurrentAndAncestorSiteGroups(long groupId)
List<Group>	getCurrentAndAncestorSiteGroups(long[] groupIds)
List<Group>	getCurrentAndAncestorSiteGroups(long[] groupIds, boolean checkContentSharingWithChildrenEnabled)
List<Group>	getCurrentAndAncestorSiteGroups(long groupId, boolean checkContentSharingWithChildrenEnabled)
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, or null if the date is invalid.
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, 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, 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.
long	getDefaultCompanyId()
long	getDigestAuthUserId(javax.servlet.http.HttpServletRequest request) Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getDigestUserId( HttpServletRequest)
String	getEmailFromAddress(PortletPreferences preferences, long companyId, String defaultValue)
String	getEmailFromName(PortletPreferences preferences, long companyId, String defaultValue)
Map<String,Serializable>	getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.servlet.http.HttpServletRequest request)
Map<String,Serializable>	getExpandoBridgeAttributes(ExpandoBridge expandoBridge, PortletRequest portletRequest)
Map<String,Serializable>	getExpandoBridgeAttributes(ExpandoBridge expandoBridge, UploadPortletRequest uploadPortletRequest)
Serializable	getExpandoValue(javax.servlet.http.HttpServletRequest request, String name, int type, String displayType)
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.http.HttpServletRequest request)
String	getForwardedHost(javax.servlet.http.HttpServletRequest request)
int	getForwardedPort(javax.servlet.http.HttpServletRequest request)
String	getFullName(String firstName, String middleName, String lastName)
String	getGlobalLibDir()
String	getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay)
String	getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)
String	getGroupFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay, Locale locale)
int[]	getGroupFriendlyURLIndex(String requestURI)
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	getI18nPathLanguageId(Locale locale, String defaultI18nPathLanguageId)
String	getJournalArticleActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
Layout	getJournalArticleLayout(long groupId, boolean privateLayout, String friendlyURL) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
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	getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
String	getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, Locale locale)
String	getLayoutFriendlyURL(ThemeDisplay themeDisplay)
LayoutFriendlyURLComposite	getLayoutFriendlyURLComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) Deprecated. As of Judson (7.1.x), replaced by #getLayoutFriendlyURLSeparatorComposite(long, boolean, String, Map, Map)
LayoutFriendlyURLSeparatorComposite	getLayoutFriendlyURLSeparatorComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext)
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	getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay)
String	getLayoutRelativeURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
String	getLayoutSetDisplayURL(LayoutSet layoutSet, boolean secureConnection)
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(Layout layout, ThemeDisplay themeDisplay, Locale locale)
String	getLayoutURL(ThemeDisplay themeDisplay)
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(PortletRequest portletRequest)
String	getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request, Layout layout, Locale locale, Locale originalLocale)
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)
String	getPathContext()
String	getPathContext(javax.servlet.http.HttpServletRequest request)
String	getPathContext(PortletRequest portletRequest)
String	getPathContext(String contextPath)
String	getPathFriendlyURLPrivateGroup()
String	getPathFriendlyURLPrivateUser()
String	getPathFriendlyURLPublic()
String	getPathImage()
String	getPathMain()
String	getPathModule()
String	getPathProxy()
long	getPlidFromFriendlyURL(long companyId, String friendlyURL)
long	getPlidFromPortletId(long groupId, boolean privateLayout, String portletId)
long	getPlidFromPortletId(long groupId, String portletId)
PortalInetSocketAddressEventListener[]	getPortalInetSocketAddressEventListeners()
String	getPortalLibDir()
InetAddress	getPortalLocalInetAddress(boolean secure)
int	getPortalLocalPort(boolean secure)
int	getPortalPort(boolean secure) Deprecated. As of Wilberforce (7.0.x), replaced by getPortalServerPort(boolean)
Properties	getPortalProperties()
InetAddress	getPortalServerInetAddress(boolean secure)
int	getPortalServerPort(boolean secure)
String	getPortalURL(javax.servlet.http.HttpServletRequest request)
String	getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)
String	getPortalURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)
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()
List<BreadcrumbEntry>	getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request) Deprecated. As of Wilberforce (7.0.x), replaced by BreadcrumbUtil.getPortletBreadcrumbEntries( HttpServletRequest)
PortletConfig	getPortletConfig(long companyId, String portletId, javax.servlet.ServletContext servletContext)
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(PortletRequest portletRequest)
String	getPortletTitle(PortletResponse portletResponse)
String	getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
String	getPortletTitle(Portlet portlet, String languageId)
String	getPortletTitle(Portlet portlet, User user)
String	getPortletTitle(String portletId, Locale locale)
String	getPortletTitle(String portletId, ResourceBundle resourceBundle)
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)
ResourceBundle	getResourceBundle(Locale locale)
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)
String	getServletContextName()
long[]	getSharedContentSiteGroupIds(long companyId, long groupId, long userId)
PortletURL	getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, String portletId) Deprecated. As of Wilberforce (7.0.x), replaced by #getControlPanelPortletURL(PortletRequest, Group, String, long, String)
PortletURL	getSiteAdministrationURL(PortletResponse portletResponse, ThemeDisplay themeDisplay, String portletName) Deprecated. As of Wilberforce (7.0.x), replaced by #getControlPanelPortletURL(PortletRequest, Group, String, long, String)
String	getSiteAdminURL(Company company, Group group, String ppid, Map<String,String[]> params) Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)
String	getSiteAdminURL(Group group, String ppid, Map<String,String[]> params) Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)
String	getSiteAdminURL(ThemeDisplay themeDisplay, String ppid, Map<String,String[]> params)
long[]	getSiteAndCompanyGroupIds(long groupId) Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)
long[]	getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay) Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)
Locale	getSiteDefaultLocale(Group group)
Locale	getSiteDefaultLocale(long groupId)
long	getSiteGroupId(long groupId)
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) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
String	getValidPortalDomain(long companyId, String domain)
long	getValidUserId(long companyId, long userId)
String	getVirtualHostname(LayoutSet layoutSet)
String	getVirtualLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
LayoutFriendlyURLComposite	getVirtualLayoutFriendlyURLComposite(boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
String	getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
void	initCustomSQL()
User	initUser(javax.servlet.http.HttpServletRequest request)
void	invokeTaglibDiscussion(PortletConfig portletConfig, ActionRequest actionRequest, ActionResponse actionResponse) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
void	invokeTaglibDiscussionPagination(PortletConfig portletConfig, ResourceRequest resourceRequest, ResourceResponse resourceResponse) Deprecated. As of Wilberforce (7.0.x), with no direct replacement
boolean	isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
boolean	isCDNDynamicResourcesEnabled(long companyId)
boolean	isCompanyAdmin(User user)
boolean	isCompanyControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)
boolean	isCompanyControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)
boolean	isControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay)
boolean	isControlPanelPortlet(String portletId, ThemeDisplay themeDisplay)
boolean	isCustomPortletMode(PortletMode portletMode)
boolean	isForwardedSecure(javax.servlet.http.HttpServletRequest request)
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	isLayoutSitemapable(Layout layout)
boolean	isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request)
boolean	isMethodGet(PortletRequest portletRequest)
boolean	isMethodPost(PortletRequest portletRequest)
boolean	isMultipartRequest(javax.servlet.http.HttpServletRequest request)
boolean	isOmniadmin(long userId)
boolean	isOmniadmin(User user)
boolean	isReservedParameter(String name)
boolean	isRightToLeft(javax.servlet.http.HttpServletRequest request)
boolean	isRSSFeedsEnabled()
boolean	isSecure(javax.servlet.http.HttpServletRequest request)
boolean	isSkipPortletContentProcessing(Group group, javax.servlet.http.HttpServletRequest httpServletRequest, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, String portletName)
boolean	isSkipPortletContentRendering(Group group, LayoutTypePortlet layoutTypePortlet, PortletDisplay portletDisplay, String portletName)
boolean	isSystemGroup(String groupName)
boolean	isSystemRole(String roleName)
boolean	isUpdateAvailable()
boolean	isValidResourceId(String resourceId)
boolean	removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)
void	removePortalPortEventListener(PortalPortEventListener portalPortEventListener) Deprecated. As of Wilberforce (7.0.x), replaced by removePortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)
void	resetCDNHosts()
String	resetPortletParameters(String url, String portletId)
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	sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	sendRSSFeedsDisabledError(PortletRequest portletRequest, PortletResponse portletResponse)
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	setPortalInetSocketAddresses(javax.servlet.http.HttpServletRequest request)
void	setPortalPort(javax.servlet.http.HttpServletRequest request) Deprecated. As of Wilberforce (7.0.x), replaced by setPortalInetSocketAddresses(HttpServletRequest)
void	storePreferences(PortletPreferences portletPreferences)
String[]	stripURLAnchor(String url, String separator)
String	transformCustomSQL(String sql)
String	transformSQL(String sql)
void	updateImageId(BaseModel<?> baseModel, boolean image, byte[] bytes, String fieldName, long maxSize, int maxHeight, int maxWidth)
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

JSESSIONID

static final String JSESSIONID

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_MODULE

static final String PATH_MODULE

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

addPortalInetSocketAddressEventListener

boolean addPortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

addPortalPortEventListener

@Deprecated
void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)

Deprecated. As of Wilberforce (7.0.x), replaced by addPortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)

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

addPortletBreadcrumbEntry

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

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

portletBreadcrumbEntry - whether the entry is a portlet breadcrumb entry

addPortletDefaultResource

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

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 a portal exception occurred

addPortletDefaultResource

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

Throws:

PortalException

addPreservedParameters

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

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

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

Parameters:

themeDisplay - the current theme display

layout - the current layout

url - the URL

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

Returns:

the URL with the preserved parameters added

addPreservedParameters

String addPreservedParameters(ThemeDisplay themeDisplay,
                              String url)

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

Parameters:

themeDisplay - the current theme display

url - the URL

Returns:

the URL with the preserved parameters added

addPreservedParameters

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

addUserLocaleOptionsMessage

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

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

getAbsoluteURL

String getAbsoluteURL(javax.servlet.http.HttpServletRequest request,
                      String url)

getActualLayoutQueryStringComposite

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

Throws:

PortalException

getActualURL

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

Throws:

PortalException

getAlternateURL

String getAlternateURL(String canonicalURL,
                       ThemeDisplay themeDisplay,
                       Locale locale,
                       Layout layout)
                throws PortalException

Returns the alternate URL for the requested canonical URL in the given locale.

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

Parameters:

canonicalURL - the canonical URL being requested. For more information, see getCanonicalURL(java.lang.String, com.liferay.portal.kernel.theme.ThemeDisplay, com.liferay.portal.kernel.model.Layout).

themeDisplay - the theme display

locale - the locale of the alternate (translated) page

layout - the page being requested

Returns:

the alternate URL for the requested canonical URL in the given locale

Throws:

PortalException - if a portal exception occurred

getAlternateURLs

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

Throws:

PortalException

getAncestorSiteGroupIds

long[] getAncestorSiteGroupIds(long groupId)
                        throws PortalException

Throws:

PortalException

getBaseModel

BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
                   throws PortalException

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 portal exception occurred

getBaseModel

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

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 portal exception occurred

getBasicAuthUserId

@Deprecated
long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
                             throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)

Throws:

PortalException

getBasicAuthUserId

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

Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getBasicUserId( HttpServletRequest)

Throws:

PortalException

getBrowsableScopeGroups

List<Group> getBrowsableScopeGroups(long userId,
                                    long companyId,
                                    long groupId,
                                    String portletId)
                             throws PortalException

Throws:

PortalException

getCanonicalURL

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

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

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL

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

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

Parameters:

completeURL - the complete URL of the page

themeDisplay - the current theme display

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

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

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCanonicalURL

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

Returns the canonical URL of the page. The canonical URL is often used to distinguish a preferred page from its translations.

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

Parameters:

completeURL - the complete URL of the page

themeDisplay - the theme display

layout - the page being requested (optionally null). If null is specified, the current page is used.

forceLayoutFriendlyURL - whether to add the page's friendly URL to the canonical URL

includeQueryString - whether to add the URL query string to the canonical URL

Returns:

the canonical URL

Throws:

PortalException - if a portal exception occurred

getCDNHost

String getCDNHost(boolean secure)

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

Parameters:

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

Returns:

the CDN host address

getCDNHost

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

Throws:

PortalException

getCDNHostHttp

String getCDNHostHttp(long companyId)

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

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getCDNHostHttps

String getCDNHostHttps(long companyId)

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

Parameters:

companyId - the company ID of a site

Returns:

the CDN host address

getClassName

String getClassName(long classNameId)

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

Parameters:

classNameId - the ID of the class

Returns:

the fully qualified name of the class

getClassNameId

long getClassNameId(Class<?> clazz)

Returns the ID of the class from its class object.

Parameters:

clazz - the class object

Returns:

the ID of the class

getClassNameId

long getClassNameId(String value)

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

Parameters:

value - the fully qualified name of the class

Returns:

the ID of the class

getCompany

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

Throws:

PortalException

getCompany

Company getCompany(PortletRequest portletRequest)
            throws PortalException

Throws:

PortalException

getCompanyId

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

getCompanyId

long getCompanyId(PortletRequest portletRequest)

getCompanyIds

long[] getCompanyIds()

getComputerAddresses

Set<String> getComputerAddresses()

getComputerName

String getComputerName()

getControlPanelFullURL

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

Throws:

PortalException

getControlPanelPlid

long getControlPanelPlid(long companyId)
                  throws PortalException

Throws:

PortalException

getControlPanelPlid

long getControlPanelPlid(PortletRequest portletRequest)
                  throws PortalException

Throws:

PortalException

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getControlPanelPortletURL

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

getCreateAccountURL

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

Throws:

Exception

getCurrentAndAncestorSiteGroupIds

long[] getCurrentAndAncestorSiteGroupIds(long groupId)
                                  throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroupIds

long[] getCurrentAndAncestorSiteGroupIds(long groupId,
                                         boolean checkContentSharingWithChildrenEnabled)
                                  throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroupIds

long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds)
                                  throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroupIds

long[] getCurrentAndAncestorSiteGroupIds(long[] groupIds,
                                         boolean checkContentSharingWithChildrenEnabled)
                                  throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroups

List<Group> getCurrentAndAncestorSiteGroups(long groupId)
                                     throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroups

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

Throws:

PortalException

getCurrentAndAncestorSiteGroups

List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds)
                                     throws PortalException

Throws:

PortalException

getCurrentAndAncestorSiteGroups

List<Group> getCurrentAndAncestorSiteGroups(long[] groupIds,
                                            boolean checkContentSharingWithChildrenEnabled)
                                     throws PortalException

Throws:

PortalException

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, or null if the date is invalid.

Parameters:

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

day - the day of the month

year - the year

Returns:

the date object, or null if the date is invalid

getDate

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

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

Parameters:

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

day - the day of the month

year - the year

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate

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

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate

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

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

Parameters:

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

day - the day of the month

year - the year

hour - the hour (0-24)

min - the minute of the hour

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDate

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

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

Parameters:

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

day - the day of the month

year - the year

timeZone - the time zone of the date

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

Returns:

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

Throws:

PortalException - if a portal exception occurred

getDefaultCompanyId

long getDefaultCompanyId()

getDigestAuthUserId

@Deprecated
long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
                              throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by HttpAuthManagerUtil.getDigestUserId( HttpServletRequest)

Throws:

PortalException

getEmailFromAddress

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

getEmailFromName

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

getExpandoBridgeAttributes

Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws PortalException

Throws:

PortalException

getExpandoBridgeAttributes

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

Throws:

PortalException

getExpandoBridgeAttributes

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

Throws:

PortalException

getExpandoValue

Serializable getExpandoValue(javax.servlet.http.HttpServletRequest request,
                             String name,
                             int type,
                             String displayType)
                      throws PortalException

Throws:

PortalException

getExpandoValue

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

Throws:

PortalException

getExpandoValue

Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest,
                             String name,
                             int type,
                             String displayType)
                      throws PortalException

Throws:

PortalException

getFacebookURL

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

Throws:

PortalException

getFirstPageLayoutTypes

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

getForwardedHost

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

getForwardedPort

int getForwardedPort(javax.servlet.http.HttpServletRequest request)

getFullName

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

getGlobalLibDir

String getGlobalLibDir()

getGoogleGadgetURL

String getGoogleGadgetURL(Portlet portlet,
                          ThemeDisplay themeDisplay)
                   throws PortalException

Throws:

PortalException

getGroupFriendlyURL

String getGroupFriendlyURL(LayoutSet layoutSet,
                           ThemeDisplay themeDisplay)
                    throws PortalException

Throws:

PortalException

getGroupFriendlyURL

String getGroupFriendlyURL(LayoutSet layoutSet,
                           ThemeDisplay themeDisplay,
                           Locale locale)
                    throws PortalException

Throws:

PortalException

getGroupFriendlyURLIndex

int[] getGroupFriendlyURLIndex(String requestURI)

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

Throws:

PortalException

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)

getI18nPathLanguageId

String getI18nPathLanguageId(Locale locale,
                             String defaultI18nPathLanguageId)

getJournalArticleActualURL

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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

PortalException

getJournalArticleLayout

@Deprecated
Layout getJournalArticleLayout(long groupId,
                                           boolean privateLayout,
                                           String friendlyURL)
                                    throws PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

PortalException

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

Throws:

PortalException

getLayoutActualURL

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

Throws:

PortalException

getLayoutFriendlyURL

String getLayoutFriendlyURL(Layout layout,
                            ThemeDisplay themeDisplay)
                     throws PortalException

Throws:

PortalException

getLayoutFriendlyURL

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

Throws:

PortalException

getLayoutFriendlyURL

String getLayoutFriendlyURL(ThemeDisplay themeDisplay)
                     throws PortalException

Throws:

PortalException

getLayoutFriendlyURLComposite

@Deprecated
LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(long groupId,
                                                                     boolean privateLayout,
                                                                     String friendlyURL,
                                                                     Map<String,String[]> params,
                                                                     Map<String,Object> requestContext)
                                                              throws PortalException

Deprecated. As of Judson (7.1.x), replaced by #getLayoutFriendlyURLSeparatorComposite(long, boolean, String, Map, Map)

Throws:

PortalException

getLayoutFriendlyURLSeparatorComposite

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

Throws:

PortalException

getLayoutFullURL

String getLayoutFullURL(Layout layout,
                        ThemeDisplay themeDisplay)
                 throws PortalException

Throws:

PortalException

getLayoutFullURL

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

Throws:

PortalException

getLayoutFullURL

String getLayoutFullURL(long groupId,
                        String portletId)
                 throws PortalException

Throws:

PortalException

getLayoutFullURL

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

Throws:

PortalException

getLayoutFullURL

String getLayoutFullURL(ThemeDisplay themeDisplay)
                 throws PortalException

Throws:

PortalException

getLayoutRelativeURL

String getLayoutRelativeURL(Layout layout,
                            ThemeDisplay themeDisplay)
                     throws PortalException

Throws:

PortalException

getLayoutRelativeURL

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

Throws:

PortalException

getLayoutSetDisplayURL

String getLayoutSetDisplayURL(LayoutSet layoutSet,
                              boolean secureConnection)
                       throws PortalException

Throws:

PortalException

getLayoutSetFriendlyURL

String getLayoutSetFriendlyURL(LayoutSet layoutSet,
                               ThemeDisplay themeDisplay)
                        throws PortalException

Throws:

PortalException

getLayoutTarget

String getLayoutTarget(Layout layout)

getLayoutURL

String getLayoutURL(Layout layout,
                    ThemeDisplay themeDisplay)
             throws PortalException

Throws:

PortalException

getLayoutURL

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

Throws:

PortalException

getLayoutURL

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

Throws:

PortalException

getLayoutURL

String getLayoutURL(ThemeDisplay themeDisplay)
             throws PortalException

Throws:

PortalException

getLiferayPortletRequest

LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)

getLiferayPortletResponse

LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)

getLocale

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

getLocale

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

getLocale

Locale getLocale(PortletRequest portletRequest)

getLocalizedFriendlyURL

String getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request,
                               Layout layout,
                               Locale locale,
                               Locale originalLocale)
                        throws Exception

Throws:

Exception

getMailId

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

getNetvibesURL

String getNetvibesURL(Portlet portlet,
                      ThemeDisplay themeDisplay)
               throws PortalException

Throws:

PortalException

getNewPortletTitle

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

getOriginalServletRequest

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

getPathContext

String getPathContext()

getPathContext

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

getPathContext

String getPathContext(PortletRequest portletRequest)

getPathContext

String getPathContext(String contextPath)

getPathFriendlyURLPrivateGroup

String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

String getPathFriendlyURLPublic()

getPathImage

String getPathImage()

getPathMain

String getPathMain()

getPathModule

String getPathModule()

getPathProxy

String getPathProxy()

getPlidFromFriendlyURL

long getPlidFromFriendlyURL(long companyId,
                            String friendlyURL)

getPlidFromPortletId

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

Throws:

PortalException

getPlidFromPortletId

long getPlidFromPortletId(long groupId,
                          String portletId)
                   throws PortalException

Throws:

PortalException

getPortalInetSocketAddressEventListeners

PortalInetSocketAddressEventListener[] getPortalInetSocketAddressEventListeners()

getPortalLibDir

String getPortalLibDir()

getPortalLocalInetAddress

InetAddress getPortalLocalInetAddress(boolean secure)

getPortalLocalPort

int getPortalLocalPort(boolean secure)

getPortalPort

@Deprecated
int getPortalPort(boolean secure)

Deprecated. As of Wilberforce (7.0.x), replaced by getPortalServerPort(boolean)

getPortalProperties

Properties getPortalProperties()

getPortalServerInetAddress

InetAddress getPortalServerInetAddress(boolean secure)

getPortalServerPort

int getPortalServerPort(boolean secure)

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

Throws:

PortalException

getPortalURL

String getPortalURL(LayoutSet layoutSet,
                    ThemeDisplay themeDisplay)

getPortalURL

String getPortalURL(PortletRequest portletRequest)

getPortalURL

String getPortalURL(PortletRequest portletRequest,
                    boolean secure)

getPortalURL

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

getPortalURL

String getPortalURL(ThemeDisplay themeDisplay)
             throws PortalException

Throws:

PortalException

getPortalWebDir

String getPortalWebDir()

getPortletBreadcrumbs

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

Deprecated. As of Wilberforce (7.0.x), replaced by BreadcrumbUtil.getPortletBreadcrumbEntries( HttpServletRequest)

getPortletConfig

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

Throws:

PortletException

getPortletDescription

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

getPortletDescription

String getPortletDescription(Portlet portlet,
                             User user)

getPortletDescription

String getPortletDescription(String portletId,
                             Locale locale)

getPortletDescription

String getPortletDescription(String portletId,
                             String languageId)

getPortletDescription

String getPortletDescription(String portletId,
                             User user)

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

getPortletTitle

String getPortletTitle(PortletResponse portletResponse)

getPortletTitle

String getPortletTitle(String portletId,
                       Locale locale)

getPortletTitle

String getPortletTitle(String portletId,
                       ResourceBundle resourceBundle)

getPortletTitle

String getPortletTitle(String portletId,
                       String languageId)

getPortletTitle

String getPortletTitle(String portletId,
                       User user)

getPortletXmlFileName

String getPortletXmlFileName()

getPreferences

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

getPreferencesValidator

PreferencesValidator getPreferencesValidator(Portlet portlet)

getRelativeHomeURL

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

Throws:

PortalException

getResourceBundle

ResourceBundle getResourceBundle(Locale locale)

getScopeGroupId

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

Throws:

PortalException

getScopeGroupId

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

Throws:

PortalException

getScopeGroupId

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

Throws:

PortalException

getScopeGroupId

long getScopeGroupId(Layout layout)

getScopeGroupId

long getScopeGroupId(Layout layout,
                     String portletId)

getScopeGroupId

long getScopeGroupId(long plid)

getScopeGroupId

long getScopeGroupId(PortletRequest portletRequest)
              throws PortalException

Throws:

PortalException

getSelectedUser

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

Throws:

PortalException

getSelectedUser

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

Throws:

PortalException

getSelectedUser

User getSelectedUser(PortletRequest portletRequest)
              throws PortalException

Throws:

PortalException

getSelectedUser

User getSelectedUser(PortletRequest portletRequest,
                     boolean checkPermission)
              throws PortalException

Throws:

PortalException

getServletContextName

String getServletContextName()

getSharedContentSiteGroupIds

long[] getSharedContentSiteGroupIds(long companyId,
                                    long groupId,
                                    long userId)
                             throws PortalException

Throws:

PortalException

getSiteAdministrationURL

@Deprecated
PortletURL getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
                                                ThemeDisplay themeDisplay,
                                                String portletId)

Deprecated. As of Wilberforce (7.0.x), replaced by #getControlPanelPortletURL(PortletRequest, Group, String, long, String)

getSiteAdministrationURL

@Deprecated
PortletURL getSiteAdministrationURL(PortletResponse portletResponse,
                                                ThemeDisplay themeDisplay,
                                                String portletName)

Deprecated. As of Wilberforce (7.0.x), replaced by #getControlPanelPortletURL(PortletRequest, Group, String, long, String)

getSiteAdminURL

@Deprecated
String getSiteAdminURL(Company company,
                                   Group group,
                                   String ppid,
                                   Map<String,String[]> params)
                            throws PortalException

Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)

Throws:

PortalException

getSiteAdminURL

@Deprecated
String getSiteAdminURL(Group group,
                                   String ppid,
                                   Map<String,String[]> params)
                            throws PortalException

Deprecated. As of Judson (7.1.x), replaced by getSiteAdminURL(ThemeDisplay, String, Map)

Throws:

PortalException

getSiteAdminURL

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

Throws:

PortalException

getSiteAndCompanyGroupIds

@Deprecated
long[] getSiteAndCompanyGroupIds(long groupId)
                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Throws:

PortalException

getSiteAndCompanyGroupIds

@Deprecated
long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getCurrentAndAncestorSiteGroupIds(long)

Throws:

PortalException

getSiteDefaultLocale

Locale getSiteDefaultLocale(Group group)
                     throws PortalException

Throws:

PortalException

getSiteDefaultLocale

Locale getSiteDefaultLocale(long groupId)
                     throws PortalException

Throws:

PortalException

getSiteGroupId

long getSiteGroupId(long groupId)

getSiteLoginURL

String getSiteLoginURL(ThemeDisplay themeDisplay)
                throws PortalException

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

Parameters:

themeDisplay - the theme display for the current page

Returns:

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

Throws:

PortalException - if a portal exception occurred

getStaticResourceURL

String getStaticResourceURL(javax.servlet.http.HttpServletRequest 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

Throws:

PortalException

getUser

User getUser(PortletRequest portletRequest)
      throws PortalException

Throws:

PortalException

getUserEmailAddress

String getUserEmailAddress(long userId)

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

@Deprecated
String getUserValue(long userId,
                                String param,
                                String defaultValue)

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

getValidPortalDomain

String getValidPortalDomain(long companyId,
                            String domain)

getValidUserId

long getValidUserId(long companyId,
                    long userId)
             throws PortalException

Throws:

PortalException

getVirtualHostname

String getVirtualHostname(LayoutSet layoutSet)

getVirtualLayoutActualURL

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

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

PortalException

getVirtualLayoutFriendlyURLComposite

@Deprecated
LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(boolean privateLayout,
                                                                            String friendlyURL,
                                                                            Map<String,String[]> params,
                                                                            Map<String,Object> requestContext)
                                                                     throws PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

PortalException

getWidgetURL

String getWidgetURL(Portlet portlet,
                    ThemeDisplay themeDisplay)
             throws PortalException

Throws:

PortalException

initCustomSQL

void initCustomSQL()

initUser

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

Throws:

Exception

invokeTaglibDiscussion

@Deprecated
void invokeTaglibDiscussion(PortletConfig portletConfig,
                                        ActionRequest actionRequest,
                                        ActionResponse actionResponse)
                                 throws Exception

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

Exception

invokeTaglibDiscussionPagination

@Deprecated
void invokeTaglibDiscussionPagination(PortletConfig portletConfig,
                                                  ResourceRequest resourceRequest,
                                                  ResourceResponse resourceResponse)
                                           throws IOException,
                                                  PortletException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:

IOException

PortletException

isCDNDynamicResourcesEnabled

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

Throws:

PortalException

isCDNDynamicResourcesEnabled

boolean isCDNDynamicResourcesEnabled(long companyId)

isCompanyAdmin

boolean isCompanyAdmin(User user)
                throws Exception

Throws:

Exception

isCompanyControlPanelPortlet

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

Throws:

PortalException

isCompanyControlPanelPortlet

boolean isCompanyControlPanelPortlet(String portletId,
                                     ThemeDisplay themeDisplay)
                              throws PortalException

Throws:

PortalException

isControlPanelPortlet

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

isControlPanelPortlet

boolean isControlPanelPortlet(String portletId,
                              ThemeDisplay themeDisplay)

isCustomPortletMode

boolean isCustomPortletMode(PortletMode portletMode)

isForwardedSecure

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

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

Throws:

PortalException

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

isLoginRedirectRequired

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

isMethodGet

boolean isMethodGet(PortletRequest portletRequest)

isMethodPost

boolean isMethodPost(PortletRequest portletRequest)

isMultipartRequest

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

isOmniadmin

boolean isOmniadmin(long userId)

isOmniadmin

boolean isOmniadmin(User user)

isReservedParameter

boolean isReservedParameter(String name)

isRightToLeft

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

isRSSFeedsEnabled

boolean isRSSFeedsEnabled()

isSecure

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

isSkipPortletContentProcessing

boolean isSkipPortletContentProcessing(Group group,
                                       javax.servlet.http.HttpServletRequest httpServletRequest,
                                       LayoutTypePortlet layoutTypePortlet,
                                       PortletDisplay portletDisplay,
                                       String portletName)
                                throws Exception

Throws:

Exception

isSkipPortletContentRendering

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

isSystemGroup

boolean isSystemGroup(String groupName)

isSystemRole

boolean isSystemRole(String roleName)

isUpdateAvailable

boolean isUpdateAvailable()

isValidResourceId

boolean isValidResourceId(String resourceId)

removePortalInetSocketAddressEventListener

boolean removePortalInetSocketAddressEventListener(PortalInetSocketAddressEventListener portalInetSocketAddressEventListener)

removePortalPortEventListener

@Deprecated
void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)

Deprecated. As of Wilberforce (7.0.x), replaced by removePortalInetSocketAddressEventListener( PortalInetSocketAddressEventListener)

resetCDNHosts

void resetCDNHosts()

resetPortletParameters

String resetPortletParameters(String url,
                              String portletId)

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

sendRSSFeedsDisabledError

void sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws IOException,
                               javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

sendRSSFeedsDisabledError

void sendRSSFeedsDisabledError(PortletRequest portletRequest,
                               PortletResponse portletResponse)
                        throws IOException,
                               javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

setPageDescription

void setPageDescription(String description,
                        javax.servlet.http.HttpServletRequest 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.

setPortalInetSocketAddresses

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

setPortalPort

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

Deprecated. As of Wilberforce (7.0.x), replaced by setPortalInetSocketAddresses(HttpServletRequest)

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)

updateImageId

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

Throws:

PortalException

updatePortletMode

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

Throws:

PortalException

updateRedirect

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

updateWindowState

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