|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portal.util.PortalImpl
public class PortalImpl
| Field Summary |
|---|
| Fields inherited from interface com.liferay.portal.util.Portal |
|---|
FRIENDLY_URL_SEPARATOR, PATH_IMAGE, PATH_MAIN, PATH_PORTAL_LAYOUT, PORTAL_REALM, PORTLET_XML_FILE_NAME_CUSTOM, PORTLET_XML_FILE_NAME_STANDARD, TEMP_OBFUSCATION_VALUE |
| Constructor Summary | |
|---|---|
PortalImpl()
|
|
| Method Summary | |
|---|---|
protected void |
addDefaultResource(ThemeDisplay themeDisplay,
Layout layout,
Portlet portlet,
boolean portletActions)
|
void |
addPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Appends the description to the current meta description of the page. |
void |
addPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Appends the keywords to the current meta keywords of the page. |
void |
addPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Appends the subtitle to the current subtitle of the page. |
void |
addPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Appends the title to the current title of the page. |
void |
addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
Adds the portal port event listener to the portal. |
void |
addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url)
Adds an entry to the portlet breadcrumbs for the page. |
void |
addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url,
Map<String,Object> data)
Adds an entry to the portlet breadcrumbs for the page. |
void |
addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
Adds the default resource permissions for the portlet to the page. |
String |
addPreservedParameters(ThemeDisplay themeDisplay,
Layout layout,
String url,
boolean doAsUser)
Adds the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well. |
String |
addPreservedParameters(ThemeDisplay themeDisplay,
String url)
Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, refererPlid, and controlPanelCategory to the URL. |
void |
clearRequestParameters(RenderRequest renderRequest)
Clears the render parameters in the request if the portlet is in the action phase. |
void |
copyRequestParameters(ActionRequest actionRequest,
ActionResponse actionResponse)
Copies the request parameters to the render parameters, unless a parameter with that name already exists in the render parameters. |
String |
escapeRedirect(String url)
Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects. |
protected List<Portlet> |
filterControlPanelPortlets(Set<Portlet> portlets,
String category,
ThemeDisplay themeDisplay)
|
String |
generateRandomKey(javax.servlet.http.HttpServletRequest request,
String input)
Generates a random key to identify the request based on the input string. |
String |
getActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
Set<String> |
getAuthTokenIgnoreActions()
Returns the set of struts actions that should not be checked for an authentication token. |
Set<String> |
getAuthTokenIgnorePortlets()
Returns the set of IDs of portlets that should not be checked for an authentication token. |
BaseModel<?> |
getBaseModel(Resource resource)
Returns the base model instance for the resource. |
BaseModel<?> |
getBaseModel(ResourcePermission resourcePermission)
Returns the base model instance for the resource permission. |
BaseModel<?> |
getBaseModel(String modelName,
String primKey)
Returns the base model instance for the model name and primary key. |
long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
Returns the user's ID from the HTTP authentication headers after validating their credentials. |
long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
long companyId)
Returns the user's ID from the HTTP authentication headers after validation their credentials. |
String |
getCanonicalAlternateURL(javax.servlet.http.HttpServletRequest request,
String url,
Locale locale)
Returns the alternate URL of the page, to distinguish it from its canonical URL. |
String |
getCanonicalURL(javax.servlet.http.HttpServletRequest request)
Returns the canonical URL of the page, to distinguish it among its translations. |
String |
getCDNHost()
Deprecated. getCDNHost(boolean) |
String |
getCDNHost(boolean secure)
Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal. |
String |
getCDNHostHttp(long companyId)
Returns the insecure (HTTP) content distribution network (CDN) host address |
String |
getCDNHostHttps(long companyId)
Returns the secure (HTTPS) content distribution network (CDN) host address |
String |
getClassName(long classNameId)
Returns the fully qualified name of the class from its ID. |
long |
getClassNameId(Class<?> clazz)
Returns the ID of the class from its class object. |
long |
getClassNameId(String value)
Returns the ID of the class from its fully qualified name. |
String |
getClassNamePortletId(String className)
Returns the ID of certain portlets from the fully qualified name of one of their classes. |
Company |
getCompany(javax.servlet.http.HttpServletRequest request)
|
Company |
getCompany(PortletRequest portletRequest)
|
long |
getCompanyId(javax.servlet.http.HttpServletRequest request)
|
long |
getCompanyId(PortletRequest portletRequest)
|
long[] |
getCompanyIds()
|
String |
getComputerAddress()
|
String |
getComputerName()
|
String |
getControlPanelCategory(String portletId,
ThemeDisplay themeDisplay)
|
String |
getControlPanelFullURL(long scopeGroupId,
String ppid,
Map<String,String[]> params)
|
Set<Portlet> |
getControlPanelPortlets(long companyId,
String category)
|
List<Portlet> |
getControlPanelPortlets(String category,
ThemeDisplay themeDisplay)
|
String |
getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
|
String |
getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
|
String |
getCurrentURL(javax.servlet.http.HttpServletRequest request)
|
String |
getCurrentURL(PortletRequest portletRequest)
|
String |
getCustomSQLFunctionIsNotNull()
|
String |
getCustomSQLFunctionIsNull()
|
Date |
getDate(int month,
int day,
int year)
Returns the date object for the specified month, day, and year. |
Date |
getDate(int month,
int day,
int year,
int hour,
int min,
PortalException pe)
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,
PortalException pe)
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,
PortalException pe)
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,
TimeZone timeZone,
PortalException pe)
Returns the date object for the specified month, day, year, and time zone, optionally throwing an exception if the date is invalid. |
long |
getDefaultCompanyId()
|
protected long |
getDefaultScopeGroupId(long companyId)
|
long |
getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
|
protected long |
getDoAsUserId(javax.servlet.http.HttpServletRequest request,
String doAsUserIdString,
boolean alwaysAllowDoAsUser)
|
String |
getEmailFromAddress(PortletPreferences preferences,
long companyId,
String defaultValue)
|
String |
getEmailFromName(PortletPreferences preferences,
long companyId,
String defaultValue)
|
Map<String,Serializable> |
getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
PortletRequest portletRequest)
|
Serializable |
getExpandoValue(PortletRequest portletRequest,
String name,
int type,
String displayType)
|
String |
getFacebookURL(Portlet portlet,
String facebookCanvasPageURL,
ThemeDisplay themeDisplay)
|
String |
getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
|
String |
getGlobalLibDir()
|
String |
getGoogleGadgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
String |
getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay)
|
String[] |
getGroupPermissions(javax.servlet.http.HttpServletRequest request)
|
String[] |
getGroupPermissions(PortletRequest portletRequest)
|
String[] |
getGuestPermissions(javax.servlet.http.HttpServletRequest request)
|
String[] |
getGuestPermissions(PortletRequest portletRequest)
|
String |
getHomeURL(javax.servlet.http.HttpServletRequest request)
|
String |
getHost(javax.servlet.http.HttpServletRequest request)
|
String |
getHost(PortletRequest portletRequest)
|
javax.servlet.http.HttpServletRequest |
getHttpServletRequest(PortletRequest portletRequest)
|
javax.servlet.http.HttpServletResponse |
getHttpServletResponse(PortletResponse portletResponse)
|
String |
getJournalArticleActualURL(long groupId,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
String |
getJsSafePortletId(String portletId)
|
String |
getLayoutActualURL(Layout layout)
|
String |
getLayoutActualURL(Layout layout,
String mainPath)
|
String |
getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL)
|
String |
getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
String |
getLayoutEditPage(Layout layout)
|
String |
getLayoutEditPage(String type)
|
String |
getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay)
|
String |
getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay,
Locale locale)
|
String |
getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay)
|
String |
getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
|
String |
getLayoutFullURL(long groupId,
String portletId)
|
String |
getLayoutFullURL(long groupId,
String portletId,
boolean secure)
|
String |
getLayoutFullURL(ThemeDisplay themeDisplay)
|
String |
getLayoutSetFriendlyURL(LayoutSet layoutSet,
ThemeDisplay themeDisplay)
|
String |
getLayoutTarget(Layout layout)
|
String |
getLayoutURL(Layout layout,
ThemeDisplay themeDisplay)
|
String |
getLayoutURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
|
String |
getLayoutURL(ThemeDisplay themeDisplay)
|
String |
getLayoutViewPage(Layout layout)
|
String |
getLayoutViewPage(String type)
|
LiferayPortletRequest |
getLiferayPortletRequest(PortletRequest portletRequest)
|
LiferayPortletResponse |
getLiferayPortletResponse(PortletResponse portletResponse)
|
Locale |
getLocale(javax.servlet.http.HttpServletRequest request)
|
Locale |
getLocale(RenderRequest renderRequest)
|
String |
getMailId(String mx,
String popPortletPrefix,
Object... ids)
|
String |
getNetvibesURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
String |
getNewPortletTitle(String portletTitle,
String oldScopeName,
String newScopeName)
|
javax.servlet.http.HttpServletRequest |
getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
|
String |
getOuterPortletId(javax.servlet.http.HttpServletRequest request)
|
long |
getParentGroupId(long groupId)
|
String |
getPathContext()
|
String |
getPathFriendlyURLPrivateGroup()
|
String |
getPathFriendlyURLPrivateUser()
|
String |
getPathFriendlyURLPublic()
|
String |
getPathImage()
|
String |
getPathMain()
|
String |
getPathProxy()
|
long |
getPlidFromFriendlyURL(long companyId,
String friendlyURL)
|
long |
getPlidFromPortletId(long groupId,
boolean privateLayout,
String portletId)
|
long |
getPlidFromPortletId(long groupId,
String portletId)
|
String |
getPortalLibDir()
|
int |
getPortalPort()
Deprecated. getPortalPort(boolean) |
int |
getPortalPort(boolean secure)
|
Properties |
getPortalProperties()
|
String |
getPortalURL(javax.servlet.http.HttpServletRequest request)
|
String |
getPortalURL(javax.servlet.http.HttpServletRequest request,
boolean secure)
|
String |
getPortalURL(Layout layout,
ThemeDisplay themeDisplay)
|
String |
getPortalURL(PortletRequest portletRequest)
|
String |
getPortalURL(PortletRequest portletRequest,
boolean secure)
|
String |
getPortalURL(String serverName,
int serverPort,
boolean secure)
|
String |
getPortalURL(ThemeDisplay themeDisplay)
|
String |
getPortalWebDir()
|
Set<String> |
getPortletAddDefaultResourceCheckWhitelist()
|
Set<String> |
getPortletAddDefaultResourceCheckWhitelistActions()
|
List<BreadcrumbEntry> |
getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
Deprecated. getPortletBreadcrumbs(HttpServletRequest) |
List<BreadcrumbEntry> |
getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
|
String |
getPortletDescription(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
String |
getPortletDescription(Portlet portlet,
User user)
|
String |
getPortletDescription(String portletId,
Locale locale)
|
String |
getPortletDescription(String portletId,
String languageId)
|
String |
getPortletDescription(String portletId,
User user)
|
Object[] |
getPortletFriendlyURLMapper(long groupId,
boolean privateLayout,
String url,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
String |
getPortletId(javax.servlet.http.HttpServletRequest request)
|
String |
getPortletId(PortletRequest portletRequest)
|
String |
getPortletNamespace(String portletId)
|
String |
getPortletTitle(Portlet portlet,
Locale locale)
|
String |
getPortletTitle(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
String |
getPortletTitle(Portlet portlet,
String languageId)
|
String |
getPortletTitle(Portlet portlet,
User user)
|
String |
getPortletTitle(RenderResponse renderResponse)
|
String |
getPortletTitle(String portletId,
Locale locale)
|
String |
getPortletTitle(String portletId,
String languageId)
|
String |
getPortletTitle(String portletId,
User user)
|
String |
getPortletXmlFileName()
|
PortletPreferences |
getPreferences(javax.servlet.http.HttpServletRequest request)
|
PreferencesValidator |
getPreferencesValidator(Portlet portlet)
|
String |
getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
|
long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request)
|
long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId)
|
long |
getScopeGroupId(Layout layout)
|
long |
getScopeGroupId(Layout layout,
String portletId)
|
long |
getScopeGroupId(long plid)
|
long |
getScopeGroupId(PortletRequest portletRequest)
|
User |
getSelectedUser(javax.servlet.http.HttpServletRequest request)
|
User |
getSelectedUser(javax.servlet.http.HttpServletRequest request,
boolean checkPermission)
|
User |
getSelectedUser(PortletRequest portletRequest)
|
User |
getSelectedUser(PortletRequest portletRequest,
boolean checkPermission)
|
javax.servlet.ServletContext |
getServletContext(Portlet portlet,
javax.servlet.ServletContext servletContext)
|
String |
getSiteLoginURL(ThemeDisplay themeDisplay)
Returns the URL of the login page for the current site if one is available. |
String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri)
|
String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
long timestamp)
|
String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString)
|
String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString,
long timestamp)
|
String |
getStrutsAction(javax.servlet.http.HttpServletRequest request)
|
String[] |
getSystemGroups()
|
String[] |
getSystemOrganizationRoles()
|
String[] |
getSystemRoles()
|
String[] |
getSystemSiteRoles()
|
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(long userId,
String defaultUserName)
|
String |
getUserName(long userId,
String defaultUserName,
javax.servlet.http.HttpServletRequest request)
|
String |
getUserName(long userId,
String defaultUserName,
String userAttribute)
|
String |
getUserName(long userId,
String defaultUserName,
String userAttribute,
javax.servlet.http.HttpServletRequest request)
|
String |
getUserPassword(javax.servlet.http.HttpServletRequest request)
|
String |
getUserPassword(javax.servlet.http.HttpSession session)
|
String |
getUserPassword(PortletRequest portletRequest)
|
String |
getUserValue(long userId,
String param,
String defaultValue)
|
long |
getValidUserId(long companyId,
long userId)
|
String |
getWidgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
boolean |
isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
|
protected boolean |
isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)
|
boolean |
isCommunityAdmin(User user,
long groupId)
Deprecated. As of 6.1, renamed to isGroupAdmin(User, long) |
boolean |
isCommunityOwner(User user,
long groupId)
Deprecated. As of 6.1, renamed to isGroupOwner(User, long) |
boolean |
isCompanyAdmin(User user)
|
boolean |
isCompanyControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
boolean |
isCompanyControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
boolean |
isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
|
boolean |
isControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
boolean |
isControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
boolean |
isGroupAdmin(User user,
long groupId)
|
boolean |
isGroupOwner(User user,
long groupId)
|
boolean |
isLayoutDescendant(Layout layout,
long layoutId)
|
boolean |
isLayoutFirstPageable(Layout layout)
|
boolean |
isLayoutFirstPageable(String type)
|
boolean |
isLayoutFriendliable(Layout layout)
|
boolean |
isLayoutFriendliable(String type)
|
boolean |
isLayoutParentable(Layout layout)
|
boolean |
isLayoutParentable(String type)
|
boolean |
isLayoutSitemapable(Layout layout)
|
boolean |
isMethodGet(PortletRequest portletRequest)
|
boolean |
isMethodPost(PortletRequest portletRequest)
|
boolean |
isMultipartRequest(javax.servlet.http.HttpServletRequest request)
|
boolean |
isOmniadmin(long userId)
|
boolean |
isReservedParameter(String name)
|
boolean |
isSecure(javax.servlet.http.HttpServletRequest request)
|
boolean |
isSystemGroup(String groupName)
|
boolean |
isSystemRole(String roleName)
|
boolean |
isUpdateAvailable()
|
boolean |
isValidResourceId(String resourceId)
|
protected void |
notifyPortalPortEventListeners(int portalPort)
|
void |
removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
|
String |
renderPage(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String path)
|
String |
renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
boolean writeOutput)
|
String |
renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
String columnId,
Integer columnPos,
Integer columnCount,
boolean writeOutput)
|
String |
renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
String columnId,
Integer columnPos,
Integer columnCount,
String path,
boolean writeOutput)
|
void |
resetCDNHosts()
|
Set<String> |
resetPortletAddDefaultResourceCheckWhitelist()
|
Set<String> |
resetPortletAddDefaultResourceCheckWhitelistActions()
|
void |
sendError(Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
void |
sendError(Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
sendError(int status,
Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
void |
sendError(int status,
Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
void |
setPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Sets the description for the page, overriding the existing page description. |
void |
setPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Sets the keywords for the page, overriding the existing page keywords. |
void |
setPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Sets the subtitle for the page, overriding the existing page subtitle. |
void |
setPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Sets the whole title for the page, overriding the existing page whole title. |
void |
setPortalPort(javax.servlet.http.HttpServletRequest request)
Sets the port obtained on the first request to the portal. |
void |
storePreferences(PortletPreferences portletPreferences)
|
String[] |
stripURLAnchor(String url,
String separator)
|
String |
transformCustomSQL(String sql)
|
PortletMode |
updatePortletMode(String portletId,
User user,
Layout layout,
PortletMode portletMode,
javax.servlet.http.HttpServletRequest request)
|
String |
updateRedirect(String redirect,
String oldPath,
String newPath)
|
WindowState |
updateWindowState(String portletId,
User user,
Layout layout,
WindowState windowState,
javax.servlet.http.HttpServletRequest request)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PortalImpl()
| Method Detail |
|---|
public void addPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Portal
addPageDescription in interface Portaldescription - the description to append to the current meta
descriptionrequest - the servlet request for the page
public void addPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Portal
addPageKeywords in interface Portalkeywords - the keywords to add to the current meta keywords
(comma-separated)request - the servlet request for the page
public void addPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Portal
addPageSubtitle in interface Portalsubtitle - the subtitle to append to the current subtitlerequest - the servlet request for the page
public void addPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Portal
addPageTitle in interface Portaltitle - the title to append to the current titlerequest - the servlet request for the pagepublic void addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
Portal
addPortalPortEventListener in interface PortalportalPortEventListener - the portal port event listener to add
public void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url)
Portal
addPortletBreadcrumbEntry in interface Portalrequest - the servlet request for the pagetitle - the title of the new breakcrumb entryurl - the URL of the new breadcrumb entry
public void addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url,
Map<String,Object> data)
Portal
addPortletBreadcrumbEntry in interface Portalrequest - the servlet request for the pagetitle - the title of the new breakcrumb entryurl - the URL of the new breadcrumb entrydata - the HTML5 data parameters of the new breadcrumb entry
public void addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
throws PortalException,
SystemException
Portal
addPortletDefaultResource in interface Portalrequest - the servlet request for the pageportlet - the portlet
PortalException - if adding the default resource permissions
failed
SystemException - if a system exception occurred
public String addPreservedParameters(ThemeDisplay themeDisplay,
Layout layout,
String url,
boolean doAsUser)
PortalPreserved parameters are parameters that should be sent with every request as the user navigates the portal.
addPreservedParameters in interface PortalthemeDisplay - the current theme displaylayout - the current layouturl - the URLdoAsUser - whether to include doAsUserId and doAsLanguageId in the
URL if they are available. If false, doAsUserId and
doAsUserLanguageId will never be added.
public String addPreservedParameters(ThemeDisplay themeDisplay,
String url)
Portal
addPreservedParameters in interface PortalthemeDisplay - the current theme displayurl - the URL
public void clearRequestParameters(RenderRequest renderRequest)
Portal
clearRequestParameters in interface PortalrenderRequest - the render request
public void copyRequestParameters(ActionRequest actionRequest,
ActionResponse actionResponse)
Portal
copyRequestParameters in interface PortalactionRequest - the request from which to get the request
parametersactionResponse - the response to receive the render parameterspublic String escapeRedirect(String url)
Portal
escapeRedirect in interface Portalurl - the URL to escape
null if the URL is not an
allowed for redirects
public String generateRandomKey(javax.servlet.http.HttpServletRequest request,
String input)
Portal
generateRandomKey in interface Portalrequest - the servlet request for the pageinput - the input string
public String getActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
throws PortalException,
SystemException
getActualURL in interface PortalPortalException
SystemExceptionpublic Set<String> getAuthTokenIgnoreActions()
Portal
getAuthTokenIgnoreActions in interface Portalpublic Set<String> getAuthTokenIgnorePortlets()
Portal
getAuthTokenIgnorePortlets in interface Portal
public BaseModel<?> getBaseModel(Resource resource)
throws PortalException,
SystemException
Portal
getBaseModel in interface Portalresource - the resource
null if the resource
does not have a base model instance (such as if its a portlet)
PortalException - if a base model instance for the resource could
not be found
SystemException - if a system exception occurred
public BaseModel<?> getBaseModel(ResourcePermission resourcePermission)
throws PortalException,
SystemException
Portal
getBaseModel in interface PortalresourcePermission - the resource permission
null if the resource
permission does not have a base model instance (such as if its a
portlet)
PortalException - if a base model instance for the resource
permission could not be found
SystemException - if a system exception occurred
public BaseModel<?> getBaseModel(String modelName,
String primKey)
throws PortalException,
SystemException
Portal
getBaseModel in interface PortalmodelName - the fully qualified class name of the modelprimKey - the primary key of the model instance to get
null if the model does
not have a base model instance (such as if its a portlet)
PortalException - if a base model instance with the primary key
could not be found
SystemException - if a system exception occurred
public long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
Portal
getBasicAuthUserId in interface Portalrequest - the servlet request from which to retrieve the HTTP
authentication headers
PortalException - if an authentication exception occurred
SystemException - if a system exception occurred
public long getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
long companyId)
throws PortalException,
SystemException
Portal
getBasicAuthUserId in interface Portalrequest - the servlet request to retrieve the HTTP authentication
headers fromcompanyId - unused
PortalException - if an authentication exception occurred
SystemException - if a system exception occurred
public String getCanonicalAlternateURL(javax.servlet.http.HttpServletRequest request,
String url,
Locale locale)
throws PortalException,
SystemException
Portal
getCanonicalAlternateURL in interface Portalrequest - the servlet request to retrieve its parameters and
remove those which are not relevanturl - the canonical URL previously obtainedlocale - the locale of the translated page
PortalException - if a friendly URL or the group could not be
retrieved
SystemException - if a system exception occurred
public String getCanonicalURL(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
Portal
getCanonicalURL in interface Portalrequest - the servlet request to retrieve its parameters and
remove those which are not relevant
PortalException - if a friendly URL or the group could not be
retrieved
SystemException - if a system exception occurredpublic String getCDNHost()
getCDNHost(boolean)
getCDNHost in interface Portalpublic String getCDNHost(boolean secure)
Portal
getCDNHost in interface Portalsecure - whether to get the secure or insecure CDN host address
public String getCDNHostHttp(long companyId)
Portal
getCDNHostHttp in interface Portalpublic String getCDNHostHttps(long companyId)
Portal
getCDNHostHttps in interface Portalpublic String getClassName(long classNameId)
Portal
getClassName in interface PortalclassNameId - the ID of the class
public long getClassNameId(Class<?> clazz)
Portal
getClassNameId in interface Portalclazz - the class object
public long getClassNameId(String value)
Portal
getClassNameId in interface Portalvalue - the fully qualified name of the class
public String getClassNamePortletId(String className)
Portal
getClassNamePortletId in interface PortalclassName - the fully qualified name of a class in a portlet
public Company getCompany(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getCompany in interface PortalPortalException
SystemException
public Company getCompany(PortletRequest portletRequest)
throws PortalException,
SystemException
getCompany in interface PortalPortalException
SystemExceptionpublic long getCompanyId(javax.servlet.http.HttpServletRequest request)
getCompanyId in interface Portalpublic long getCompanyId(PortletRequest portletRequest)
getCompanyId in interface Portalpublic long[] getCompanyIds()
getCompanyIds in interface Portalpublic String getComputerAddress()
getComputerAddress in interface Portalpublic String getComputerName()
getComputerName in interface Portal
public String getControlPanelCategory(String portletId,
ThemeDisplay themeDisplay)
throws SystemException
getControlPanelCategory in interface PortalSystemException
public String getControlPanelFullURL(long scopeGroupId,
String ppid,
Map<String,String[]> params)
throws PortalException,
SystemException
getControlPanelFullURL in interface PortalPortalException
SystemException
public Set<Portlet> getControlPanelPortlets(long companyId,
String category)
throws SystemException
getControlPanelPortlets in interface PortalSystemException
public List<Portlet> getControlPanelPortlets(String category,
ThemeDisplay themeDisplay)
throws SystemException
getControlPanelPortlets in interface PortalSystemException
public String getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
throws Exception
getCreateAccountURL in interface PortalExceptionpublic String getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
getCurrentCompleteURL in interface Portalpublic String getCurrentURL(javax.servlet.http.HttpServletRequest request)
getCurrentURL in interface Portalpublic String getCurrentURL(PortletRequest portletRequest)
getCurrentURL in interface Portalpublic String getCustomSQLFunctionIsNotNull()
getCustomSQLFunctionIsNotNull in interface Portalpublic String getCustomSQLFunctionIsNull()
getCustomSQLFunctionIsNull in interface Portal
public Date getDate(int month,
int day,
int year)
Portal
getDate in interface Portalmonth - the month (0-based, meaning 0 for January)day - the day of the monthyear - the year
public Date getDate(int month,
int day,
int year,
int hour,
int min,
PortalException pe)
throws PortalException
Portal
getDate in interface Portalmonth - the month (0-based, meaning 0 for January)day - the day of the monthyear - the yearhour - the hour (0-24)min - the minute of the hourpe - the exception to throw if the date is invalid. If
null, no exception will be thrown for an invalid
date.
null if the date is invalid and
no exception to throw was provided
PortalException - if the date was invalid and pe was
not null
public Date getDate(int month,
int day,
int year,
int hour,
int min,
TimeZone timeZone,
PortalException pe)
throws PortalException
Portal
getDate in interface Portalmonth - the month (0-based, meaning 0 for January)day - the day of the monthyear - the yearhour - the hour (0-24)min - the minute of the hourtimeZone - the time zone of the datepe - the exception to throw if the date is invalid. If
null, no exception will be thrown for an invalid
date.
null if the date is invalid and
no exception to throw was provided
PortalException - if the date was invalid and pe was
not null
public Date getDate(int month,
int day,
int year,
PortalException pe)
throws PortalException
Portal
getDate in interface Portalmonth - the month (0-based, meaning 0 for January)day - the day of the monthyear - the yearpe - the exception to throw if the date is invalid. If
null, no exception will be thrown for an invalid
date.
null if the date is invalid and
no exception to throw was provided
PortalException - if the date was invalid and pe was
not null
public Date getDate(int month,
int day,
int year,
TimeZone timeZone,
PortalException pe)
throws PortalException
Portal
getDate in interface Portalmonth - the month (0-based, meaning 0 for January)day - the day of the monthyear - the yeartimeZone - the time zone of the datepe - the exception to throw if the date is invalid. If
null, no exception will be thrown for an invalid
date.
null if the date is invalid and
no exception to throw was provided
PortalException - if the date was invalid and pe was
not nullpublic long getDefaultCompanyId()
getDefaultCompanyId in interface Portal
public long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getDigestAuthUserId in interface PortalPortalException
SystemException
public String getEmailFromAddress(PortletPreferences preferences,
long companyId,
String defaultValue)
throws SystemException
getEmailFromAddress in interface PortalSystemException
public String getEmailFromName(PortletPreferences preferences,
long companyId,
String defaultValue)
throws SystemException
getEmailFromName in interface PortalSystemException
public Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
PortletRequest portletRequest)
throws PortalException,
SystemException
getExpandoBridgeAttributes in interface PortalPortalException
SystemException
public Serializable getExpandoValue(PortletRequest portletRequest,
String name,
int type,
String displayType)
throws PortalException,
SystemException
getExpandoValue in interface PortalPortalException
SystemException
public String getFacebookURL(Portlet portlet,
String facebookCanvasPageURL,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getFacebookURL in interface PortalPortalException
SystemExceptionpublic String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
getFirstPageLayoutTypes in interface Portalpublic String getGlobalLibDir()
getGlobalLibDir in interface Portal
public String getGoogleGadgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getGoogleGadgetURL in interface PortalPortalException
SystemException
public String getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getGroupFriendlyURL in interface PortalPortalException
SystemExceptionpublic String[] getGroupPermissions(javax.servlet.http.HttpServletRequest request)
getGroupPermissions in interface Portalpublic String[] getGroupPermissions(PortletRequest portletRequest)
getGroupPermissions in interface Portalpublic String[] getGuestPermissions(javax.servlet.http.HttpServletRequest request)
getGuestPermissions in interface Portalpublic String[] getGuestPermissions(PortletRequest portletRequest)
getGuestPermissions in interface Portal
public String getHomeURL(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getHomeURL in interface PortalPortalException
SystemExceptionpublic String getHost(javax.servlet.http.HttpServletRequest request)
getHost in interface Portalpublic String getHost(PortletRequest portletRequest)
getHost in interface Portalpublic javax.servlet.http.HttpServletRequest getHttpServletRequest(PortletRequest portletRequest)
getHttpServletRequest in interface Portalpublic javax.servlet.http.HttpServletResponse getHttpServletResponse(PortletResponse portletResponse)
getHttpServletResponse in interface Portal
public String getJournalArticleActualURL(long groupId,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
throws PortalException,
SystemException
getJournalArticleActualURL in interface PortalPortalException
SystemExceptionpublic String getJsSafePortletId(String portletId)
getJsSafePortletId in interface Portalpublic String getLayoutActualURL(Layout layout)
getLayoutActualURL in interface Portal
public String getLayoutActualURL(Layout layout,
String mainPath)
getLayoutActualURL in interface Portal
public String getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL)
throws PortalException,
SystemException
getLayoutActualURL in interface PortalPortalException
SystemException
public String getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
throws PortalException,
SystemException
getLayoutActualURL in interface PortalPortalException
SystemExceptionpublic String getLayoutEditPage(Layout layout)
getLayoutEditPage in interface Portalpublic String getLayoutEditPage(String type)
getLayoutEditPage in interface Portal
public String getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutFriendlyURL in interface PortalPortalException
SystemException
public String getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay,
Locale locale)
throws PortalException,
SystemException
getLayoutFriendlyURL in interface PortalPortalException
SystemException
public String getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutFullURL in interface PortalPortalException
SystemException
public String getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
throws PortalException,
SystemException
getLayoutFullURL in interface PortalPortalException
SystemException
public String getLayoutFullURL(long groupId,
String portletId)
throws PortalException,
SystemException
getLayoutFullURL in interface PortalPortalException
SystemException
public String getLayoutFullURL(long groupId,
String portletId,
boolean secure)
throws PortalException,
SystemException
getLayoutFullURL in interface PortalPortalException
SystemException
public String getLayoutFullURL(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutFullURL in interface PortalPortalException
SystemException
public String getLayoutSetFriendlyURL(LayoutSet layoutSet,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutSetFriendlyURL in interface PortalPortalException
SystemExceptionpublic String getLayoutTarget(Layout layout)
getLayoutTarget in interface Portal
public String getLayoutURL(Layout layout,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutURL in interface PortalPortalException
SystemException
public String getLayoutURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
throws PortalException,
SystemException
getLayoutURL in interface PortalPortalException
SystemException
public String getLayoutURL(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getLayoutURL in interface PortalPortalException
SystemExceptionpublic String getLayoutViewPage(Layout layout)
getLayoutViewPage in interface Portalpublic String getLayoutViewPage(String type)
getLayoutViewPage in interface Portalpublic LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)
getLiferayPortletRequest in interface Portalpublic LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)
getLiferayPortletResponse in interface Portalpublic Locale getLocale(javax.servlet.http.HttpServletRequest request)
getLocale in interface Portalpublic Locale getLocale(RenderRequest renderRequest)
getLocale in interface Portal
public String getMailId(String mx,
String popPortletPrefix,
Object... ids)
getMailId in interface Portal
public String getNetvibesURL(Portlet portlet,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getNetvibesURL in interface PortalPortalException
SystemException
public String getNewPortletTitle(String portletTitle,
String oldScopeName,
String newScopeName)
getNewPortletTitle in interface Portalpublic javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
getOriginalServletRequest in interface Portalpublic String getOuterPortletId(javax.servlet.http.HttpServletRequest request)
getOuterPortletId in interface Portal
public long getParentGroupId(long groupId)
throws PortalException,
SystemException
getParentGroupId in interface PortalPortalException
SystemExceptionpublic String getPathContext()
getPathContext in interface Portalpublic String getPathFriendlyURLPrivateGroup()
getPathFriendlyURLPrivateGroup in interface Portalpublic String getPathFriendlyURLPrivateUser()
getPathFriendlyURLPrivateUser in interface Portalpublic String getPathFriendlyURLPublic()
getPathFriendlyURLPublic in interface Portalpublic String getPathImage()
getPathImage in interface Portalpublic String getPathMain()
getPathMain in interface Portalpublic String getPathProxy()
getPathProxy in interface Portal
public long getPlidFromFriendlyURL(long companyId,
String friendlyURL)
getPlidFromFriendlyURL in interface Portal
public long getPlidFromPortletId(long groupId,
boolean privateLayout,
String portletId)
throws PortalException,
SystemException
getPlidFromPortletId in interface PortalPortalException
SystemException
public long getPlidFromPortletId(long groupId,
String portletId)
throws PortalException,
SystemException
getPlidFromPortletId in interface PortalPortalException
SystemExceptionpublic String getPortalLibDir()
getPortalLibDir in interface Portalpublic int getPortalPort()
getPortalPort(boolean)
getPortalPort in interface Portalpublic int getPortalPort(boolean secure)
getPortalPort in interface Portalpublic Properties getPortalProperties()
getPortalProperties in interface Portalpublic String getPortalURL(javax.servlet.http.HttpServletRequest request)
getPortalURL in interface Portal
public String getPortalURL(javax.servlet.http.HttpServletRequest request,
boolean secure)
getPortalURL in interface Portalpublic String getPortalURL(PortletRequest portletRequest)
getPortalURL in interface Portal
public String getPortalURL(PortletRequest portletRequest,
boolean secure)
getPortalURL in interface Portal
public String getPortalURL(String serverName,
int serverPort,
boolean secure)
getPortalURL in interface Portal
public String getPortalURL(Layout layout,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getPortalURL in interface PortalPortalException
SystemException
public String getPortalURL(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getPortalURL in interface PortalPortalException
SystemExceptionpublic String getPortalWebDir()
getPortalWebDir in interface Portalpublic Set<String> getPortletAddDefaultResourceCheckWhitelist()
getPortletAddDefaultResourceCheckWhitelist in interface Portalpublic Set<String> getPortletAddDefaultResourceCheckWhitelistActions()
getPortletAddDefaultResourceCheckWhitelistActions in interface Portalpublic List<BreadcrumbEntry> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
getPortletBreadcrumbs(HttpServletRequest)
getPortletBreadcrumbList in interface Portalpublic List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
getPortletBreadcrumbs in interface Portal
public String getPortletDescription(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
getPortletDescription in interface Portal
public String getPortletDescription(Portlet portlet,
User user)
getPortletDescription in interface Portal
public String getPortletDescription(String portletId,
Locale locale)
getPortletDescription in interface Portal
public String getPortletDescription(String portletId,
String languageId)
getPortletDescription in interface Portal
public String getPortletDescription(String portletId,
User user)
getPortletDescription in interface Portal
public Object[] getPortletFriendlyURLMapper(long groupId,
boolean privateLayout,
String url,
Map<String,String[]> params,
Map<String,Object> requestContext)
throws PortalException,
SystemException
PortalException
SystemExceptionpublic String getPortletId(javax.servlet.http.HttpServletRequest request)
getPortletId in interface Portalpublic String getPortletId(PortletRequest portletRequest)
getPortletId in interface Portalpublic String getPortletNamespace(String portletId)
getPortletNamespace in interface Portal
public String getPortletTitle(Portlet portlet,
Locale locale)
getPortletTitle in interface Portal
public String getPortletTitle(Portlet portlet,
String languageId)
getPortletTitle in interface Portal
public String getPortletTitle(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
getPortletTitle in interface Portal
public String getPortletTitle(Portlet portlet,
User user)
getPortletTitle in interface Portalpublic String getPortletTitle(RenderResponse renderResponse)
getPortletTitle in interface Portal
public String getPortletTitle(String portletId,
Locale locale)
getPortletTitle in interface Portal
public String getPortletTitle(String portletId,
String languageId)
getPortletTitle in interface Portal
public String getPortletTitle(String portletId,
User user)
getPortletTitle in interface Portal
public String getPortletXmlFileName()
throws SystemException
getPortletXmlFileName in interface PortalSystemExceptionpublic PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
getPreferences in interface Portalpublic PreferencesValidator getPreferencesValidator(Portlet portlet)
getPreferencesValidator in interface Portal
public String getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getRelativeHomeURL in interface PortalPortalException
SystemException
public long getScopeGroupId(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getScopeGroupId in interface PortalPortalException
SystemException
public long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId)
throws PortalException,
SystemException
getScopeGroupId in interface PortalPortalException
SystemExceptionpublic long getScopeGroupId(Layout layout)
getScopeGroupId in interface Portal
public long getScopeGroupId(Layout layout,
String portletId)
getScopeGroupId in interface Portalpublic long getScopeGroupId(long plid)
getScopeGroupId in interface Portal
public long getScopeGroupId(PortletRequest portletRequest)
throws PortalException,
SystemException
getScopeGroupId in interface PortalPortalException
SystemException
public User getSelectedUser(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getSelectedUser in interface PortalPortalException
SystemException
public User getSelectedUser(javax.servlet.http.HttpServletRequest request,
boolean checkPermission)
throws PortalException,
SystemException
getSelectedUser in interface PortalPortalException
SystemException
public User getSelectedUser(PortletRequest portletRequest)
throws PortalException,
SystemException
getSelectedUser in interface PortalPortalException
SystemException
public User getSelectedUser(PortletRequest portletRequest,
boolean checkPermission)
throws PortalException,
SystemException
getSelectedUser in interface PortalPortalException
SystemException
public javax.servlet.ServletContext getServletContext(Portlet portlet,
javax.servlet.ServletContext servletContext)
getServletContext in interface Portal
public String getSiteLoginURL(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
Portal
getSiteLoginURL in interface PortalthemeDisplay - the theme display for the current page
null if one is not available
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri)
getStaticResourceURL in interface Portal
public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
long timestamp)
getStaticResourceURL in interface Portal
public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString)
getStaticResourceURL in interface Portal
public String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString,
long timestamp)
getStaticResourceURL in interface Portalpublic String getStrutsAction(javax.servlet.http.HttpServletRequest request)
getStrutsAction in interface Portalpublic String[] getSystemGroups()
getSystemGroups in interface Portalpublic String[] getSystemOrganizationRoles()
getSystemOrganizationRoles in interface Portalpublic String[] getSystemRoles()
getSystemRoles in interface Portalpublic String[] getSystemSiteRoles()
getSystemSiteRoles in interface Portalpublic UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest request)
getUploadServletRequest in interface Portalpublic UploadPortletRequest getUploadPortletRequest(PortletRequest portletRequest)
getUploadPortletRequest in interface Portalpublic Date getUptime()
getUptime in interface Portal
public String getURLWithSessionId(String url,
String sessionId)
getURLWithSessionId in interface Portal
public User getUser(javax.servlet.http.HttpServletRequest request)
throws PortalException,
SystemException
getUser in interface PortalPortalException
SystemException
public User getUser(PortletRequest portletRequest)
throws PortalException,
SystemException
getUser in interface PortalPortalException
SystemException
public String getUserEmailAddress(long userId)
throws SystemException
getUserEmailAddress in interface PortalSystemExceptionpublic long getUserId(javax.servlet.http.HttpServletRequest request)
getUserId in interface Portalpublic long getUserId(PortletRequest portletRequest)
getUserId in interface Portal
public String getUserName(long userId,
String defaultUserName)
getUserName in interface Portal
public String getUserName(long userId,
String defaultUserName,
javax.servlet.http.HttpServletRequest request)
getUserName in interface Portal
public String getUserName(long userId,
String defaultUserName,
String userAttribute)
getUserName in interface Portal
public String getUserName(long userId,
String defaultUserName,
String userAttribute,
javax.servlet.http.HttpServletRequest request)
getUserName in interface Portalpublic String getUserPassword(javax.servlet.http.HttpServletRequest request)
getUserPassword in interface Portalpublic String getUserPassword(javax.servlet.http.HttpSession session)
getUserPassword in interface Portalpublic String getUserPassword(PortletRequest portletRequest)
getUserPassword in interface Portal
public String getUserValue(long userId,
String param,
String defaultValue)
throws SystemException
getUserValue in interface PortalSystemException
public long getValidUserId(long companyId,
long userId)
throws PortalException,
SystemException
getValidUserId in interface PortalPortalException
SystemException
public String getWidgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
getWidgetURL in interface PortalPortalException
SystemException
public boolean isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
throws PortalException,
SystemException
isAllowAddPortletDefaultResource in interface PortalPortalException
SystemException
public boolean isCommunityAdmin(User user,
long groupId)
throws Exception
isGroupAdmin(User, long)
isCommunityAdmin in interface PortalException
public boolean isCommunityOwner(User user,
long groupId)
throws Exception
isGroupOwner(User, long)
isCommunityOwner in interface PortalException
public boolean isCompanyAdmin(User user)
throws Exception
isCompanyAdmin in interface PortalException
public boolean isCompanyControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
isCompanyControlPanelPortlet in interface PortalPortalException
SystemException
public boolean isCompanyControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
throws PortalException,
SystemException
isCompanyControlPanelPortlet in interface PortalPortalException
SystemException
public boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
throws PortalException,
SystemException
isCompanyControlPanelVisible in interface PortalPortalException
SystemException
public boolean isControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
throws SystemException
isControlPanelPortlet in interface PortalSystemException
public boolean isControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
throws SystemException
isControlPanelPortlet in interface PortalSystemExceptionpublic boolean isSecure(javax.servlet.http.HttpServletRequest request)
isSecure in interface Portal
public boolean isGroupAdmin(User user,
long groupId)
throws Exception
isGroupAdmin in interface PortalException
public boolean isGroupOwner(User user,
long groupId)
throws Exception
isGroupOwner in interface PortalException
public boolean isLayoutDescendant(Layout layout,
long layoutId)
throws PortalException,
SystemException
isLayoutDescendant in interface PortalPortalException
SystemExceptionpublic boolean isLayoutFirstPageable(Layout layout)
isLayoutFirstPageable in interface Portalpublic boolean isLayoutFirstPageable(String type)
isLayoutFirstPageable in interface Portalpublic boolean isLayoutFriendliable(Layout layout)
isLayoutFriendliable in interface Portalpublic boolean isLayoutFriendliable(String type)
isLayoutFriendliable in interface Portalpublic boolean isLayoutParentable(Layout layout)
isLayoutParentable in interface Portalpublic boolean isLayoutParentable(String type)
isLayoutParentable in interface Portalpublic boolean isLayoutSitemapable(Layout layout)
isLayoutSitemapable in interface Portalpublic boolean isMethodGet(PortletRequest portletRequest)
isMethodGet in interface Portalpublic boolean isMethodPost(PortletRequest portletRequest)
isMethodPost in interface Portalpublic boolean isMultipartRequest(javax.servlet.http.HttpServletRequest request)
isMultipartRequest in interface Portalpublic boolean isOmniadmin(long userId)
isOmniadmin in interface Portalpublic boolean isReservedParameter(String name)
isReservedParameter in interface Portalpublic boolean isSystemGroup(String groupName)
isSystemGroup in interface Portalpublic boolean isSystemRole(String roleName)
isSystemRole in interface Portal
public boolean isUpdateAvailable()
throws SystemException
isUpdateAvailable in interface PortalSystemExceptionpublic boolean isValidResourceId(String resourceId)
isValidResourceId in interface Portalpublic void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
removePortalPortEventListener in interface Portal
public String renderPage(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String path)
throws IOException,
javax.servlet.ServletException
renderPage in interface PortalIOException
javax.servlet.ServletException
public String renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
boolean writeOutput)
throws IOException,
javax.servlet.ServletException
renderPortlet in interface PortalIOException
javax.servlet.ServletException
public String renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
String columnId,
Integer columnPos,
Integer columnCount,
boolean writeOutput)
throws IOException,
javax.servlet.ServletException
renderPortlet in interface PortalIOException
javax.servlet.ServletException
public String renderPortlet(javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
Portlet portlet,
String queryString,
String columnId,
Integer columnPos,
Integer columnCount,
String path,
boolean writeOutput)
throws IOException,
javax.servlet.ServletException
renderPortlet in interface PortalIOException
javax.servlet.ServletExceptionpublic void resetCDNHosts()
resetCDNHosts in interface Portalpublic Set<String> resetPortletAddDefaultResourceCheckWhitelist()
resetPortletAddDefaultResourceCheckWhitelist in interface Portalpublic Set<String> resetPortletAddDefaultResourceCheckWhitelistActions()
resetPortletAddDefaultResourceCheckWhitelistActions in interface Portal
public void sendError(Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
throws IOException
sendError in interface PortalIOException
public void sendError(Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws IOException,
javax.servlet.ServletException
sendError in interface PortalIOException
javax.servlet.ServletException
public void sendError(int status,
Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
throws IOException
sendError in interface PortalIOException
public void sendError(int status,
Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws IOException,
javax.servlet.ServletException
sendError in interface PortalIOException
javax.servlet.ServletException
public void setPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Portal
setPageDescription in interface Portal
public void setPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Portal
setPageKeywords in interface Portal
public void setPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Portal
setPageSubtitle in interface Portal
public void setPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Portal
setPageTitle in interface Portalpublic void setPortalPort(javax.servlet.http.HttpServletRequest request)
Portal
setPortalPort in interface Portal
public void storePreferences(PortletPreferences portletPreferences)
throws IOException,
ValidatorException
storePreferences in interface PortalIOException
ValidatorException
public String[] stripURLAnchor(String url,
String separator)
stripURLAnchor in interface Portalpublic String transformCustomSQL(String sql)
transformCustomSQL in interface Portal
public PortletMode updatePortletMode(String portletId,
User user,
Layout layout,
PortletMode portletMode,
javax.servlet.http.HttpServletRequest request)
updatePortletMode in interface Portal
public String updateRedirect(String redirect,
String oldPath,
String newPath)
updateRedirect in interface Portal
public WindowState updateWindowState(String portletId,
User user,
Layout layout,
WindowState windowState,
javax.servlet.http.HttpServletRequest request)
updateWindowState in interface Portal
protected void addDefaultResource(ThemeDisplay themeDisplay,
Layout layout,
Portlet portlet,
boolean portletActions)
throws PortalException,
SystemException
PortalException
SystemException
protected List<Portlet> filterControlPanelPortlets(Set<Portlet> portlets,
String category,
ThemeDisplay themeDisplay)
protected long getDefaultScopeGroupId(long companyId)
throws PortalException,
SystemException
PortalException
SystemException
protected long getDoAsUserId(javax.servlet.http.HttpServletRequest request,
String doAsUserIdString,
boolean alwaysAllowDoAsUser)
throws Exception
Exception
protected boolean isAlwaysAllowDoAsUser(javax.servlet.http.HttpServletRequest request)
throws Exception
Exceptionprotected void notifyPortalPortEventListeners(int portalPort)
|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||