|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Portal
Field Summary | |
---|---|
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 | |
---|---|
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 |
addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)
Adds the portal port and protocol event listener to the portal. |
void |
addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url)
Adds an entry to the portlet breadcrumbs for the page. |
void |
addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url,
Map<String,Object> data)
Adds an entry to the portlet breadcrumbs for the page. |
void |
addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
Adds the default resource permissions for the portlet to the page. |
void |
addPortletDefaultResource(long companyId,
Layout layout,
Portlet portlet)
|
String |
addPreservedParameters(ThemeDisplay themeDisplay,
Layout layout,
String url,
boolean doAsUser)
Adds the preserved parameters doAsGroupId and refererPlid to the URL, optionally adding doAsUserId and doAsUserLanguageId as well. |
String |
addPreservedParameters(ThemeDisplay themeDisplay,
String url)
Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, refererPlid, and controlPanelCategory to the URL. |
void |
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)
|
Locale[] |
getAlternateLocales(javax.servlet.http.HttpServletRequest request)
Deprecated. As of 6.2.0, replaced by LanguageUtil.getAvailableLocales() |
String |
getAlternateURL(String canonicalURL,
ThemeDisplay themeDisplay,
Locale locale,
Layout layout)
Returns the alternate URL of the page, to distinguish it from its canonical URL. |
Set<String> |
getAuthTokenIgnoreActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions() |
Set<String> |
getAuthTokenIgnorePortlets()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelist() |
BaseModel<?> |
getBaseModel(ResourcePermission resourcePermission)
Returns the base model instance for the resource permission. |
BaseModel<?> |
getBaseModel(String modelName,
String primKey)
Returns the base model instance for the model name and primary key. |
long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
Returns the user's ID from the HTTP authentication headers after validating their credentials. |
long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
long companyId)
Returns the user's ID from the HTTP authentication headers after validation their credentials. |
String |
getCanonicalURL(String completeURL,
ThemeDisplay themeDisplay,
Layout layout)
Returns the canonical URL of the page, to distinguish it among its translations. |
String |
getCanonicalURL(String completeURL,
ThemeDisplay themeDisplay,
Layout layout,
boolean forceLayoutFriendlyURL)
Returns the canonical URL of the page, to distinguish it among its translations. |
String |
getCDNHost()
Deprecated. As of 6.2.0, replaced by the more general getCDNHost(boolean) |
String |
getCDNHost(boolean secure)
Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal. |
String |
getCDNHost(javax.servlet.http.HttpServletRequest request)
|
String |
getCDNHostHttp(long companyId)
Returns the insecure (HTTP) content distribution network (CDN) host address |
String |
getCDNHostHttps(long companyId)
Returns the secure (HTTPS) content distribution network (CDN) host address |
String |
getClassName(long classNameId)
Returns the fully qualified name of the class from its ID. |
long |
getClassNameId(Class<?> clazz)
Returns the ID of the class from its class object. |
long |
getClassNameId(String value)
Returns the ID of the class from its fully qualified name. |
String |
getClassNamePortletId(String className)
Returns the ID of certain portlets from the fully qualified name of one of their classes. |
Company |
getCompany(javax.servlet.http.HttpServletRequest request)
|
Company |
getCompany(PortletRequest portletRequest)
|
long |
getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
|
long |
getCompanyId(PortletRequest portletRequest)
|
long[] |
getCompanyIds()
|
String |
getComputerAddress()
Deprecated. As of 7.0.0, replaced by getComputerAddresses() |
Set<String> |
getComputerAddresses()
|
String |
getComputerName()
|
Map<String,List<Portlet>> |
getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request)
|
String |
getControlPanelCategory(String portletId,
ThemeDisplay themeDisplay)
|
String |
getControlPanelFullURL(long scopeGroupId,
String ppid,
Map<String,String[]> params)
|
long |
getControlPanelPlid(long companyId)
|
long |
getControlPanelPlid(PortletRequest portletRequest)
|
Set<Portlet> |
getControlPanelPortlets(long companyId,
String category)
|
List<Portlet> |
getControlPanelPortlets(String category,
ThemeDisplay themeDisplay)
|
PortletURL |
getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request,
String portletId,
long referrerPlid,
String lifecycle)
|
PortletURL |
getControlPanelPortletURL(PortletRequest portletRequest,
String portletId,
long referrerPlid,
String lifecycle)
|
String |
getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
|
String |
getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
|
String |
getCurrentURL(javax.servlet.http.HttpServletRequest request)
|
String |
getCurrentURL(PortletRequest portletRequest)
|
String |
getCustomSQLFunctionIsNotNull()
|
String |
getCustomSQLFunctionIsNull()
|
Date |
getDate(int month,
int day,
int year)
Returns the date object for the specified month, day, and year. |
Date |
getDate(int month,
int day,
int year,
Class<? extends PortalException> clazz)
Returns the date object for the specified month, day, and year, optionally throwing an exception if the date is invalid. |
Date |
getDate(int month,
int day,
int year,
int hour,
int min,
Class<? extends PortalException> clazz)
Returns the date object for the specified month, day, year, hour, and minute, optionally throwing an exception if the date is invalid. |
Date |
getDate(int month,
int day,
int year,
int hour,
int min,
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)
|
String |
getDisplayURL(Group group,
ThemeDisplay themeDisplay)
|
String |
getDisplayURL(Group group,
ThemeDisplay themeDisplay,
boolean privateLayout)
|
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)
|
Portlet |
getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
|
String |
getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
|
Portlet |
getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
|
String |
getFullName(String firstName,
String middleName,
String lastName)
|
String |
getGlobalLibDir()
|
String |
getGoogleGadgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
String |
getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay)
|
String |
getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay,
Locale locale)
|
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)
|
Layout |
getJournalArticleLayout(long groupId,
boolean privateLayout,
String friendlyURL)
|
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)
|
LayoutFriendlyURLComposite |
getLayoutFriendlyURLComposite(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 |
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)
|
String |
getLayoutViewPage(Layout layout)
|
String |
getLayoutViewPage(String type)
|
LiferayPortletRequest |
getLiferayPortletRequest(PortletRequest portletRequest)
|
LiferayPortletResponse |
getLiferayPortletResponse(PortletResponse portletResponse)
|
Locale |
getLocale(javax.servlet.http.HttpServletRequest request)
|
Locale |
getLocale(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean initialize)
|
Locale |
getLocale(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)
|
long |
getParentGroupId(long scopeGroupId)
Deprecated. As of 6.2.0 renamed to getSiteGroupId(long) |
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)
|
String |
getPortalLibDir()
|
int |
getPortalPort()
Deprecated. As of 6.2.0, replaced by the more general getPortalPort(boolean) |
int |
getPortalPort(boolean secure)
|
Properties |
getPortalProperties()
|
String |
getPortalURL(javax.servlet.http.HttpServletRequest request)
|
String |
getPortalURL(javax.servlet.http.HttpServletRequest request,
boolean secure)
|
String |
getPortalURL(Layout layout,
ThemeDisplay themeDisplay)
|
String |
getPortalURL(PortletRequest portletRequest)
|
String |
getPortalURL(PortletRequest portletRequest,
boolean secure)
|
String |
getPortalURL(String serverName,
int serverPort,
boolean secure)
|
String |
getPortalURL(ThemeDisplay themeDisplay)
|
String |
getPortalWebDir()
|
Set<String> |
getPortletAddDefaultResourceCheckWhitelist()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelist() |
Set<String> |
getPortletAddDefaultResourceCheckWhitelistActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions() |
List<BreadcrumbEntry> |
getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
Deprecated. As of 6.2.0, replaced by getPortletBreadcrumbs(HttpServletRequest) |
List<BreadcrumbEntry> |
getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
|
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(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
String |
getPortletTitle(Portlet portlet,
String languageId)
|
String |
getPortletTitle(Portlet portlet,
User user)
|
String |
getPortletTitle(RenderRequest renderRequest)
|
String |
getPortletTitle(RenderResponse renderResponse)
|
String |
getPortletTitle(String portletId,
Locale locale)
|
String |
getPortletTitle(String portletId,
String languageId)
|
String |
getPortletTitle(String portletId,
User user)
|
String |
getPortletXmlFileName()
|
PortletPreferences |
getPreferences(javax.servlet.http.HttpServletRequest request)
|
PreferencesValidator |
getPreferencesValidator(Portlet portlet)
|
String |
getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
|
long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request)
|
long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId)
|
long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId,
boolean checkStagingGroup)
|
long |
getScopeGroupId(Layout layout)
|
long |
getScopeGroupId(Layout layout,
String portletId)
|
long |
getScopeGroupId(long plid)
|
long |
getScopeGroupId(PortletRequest portletRequest)
|
User |
getSelectedUser(javax.servlet.http.HttpServletRequest request)
|
User |
getSelectedUser(javax.servlet.http.HttpServletRequest request,
boolean checkPermission)
|
User |
getSelectedUser(PortletRequest portletRequest)
|
User |
getSelectedUser(PortletRequest portletRequest,
boolean checkPermission)
|
String |
getServletContextName()
|
long[] |
getSharedContentSiteGroupIds(long companyId,
long groupId,
long userId)
|
Map<String,List<Portlet>> |
getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request)
|
PortletURL |
getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
|
PortletURL |
getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay,
String portletName)
|
PortletURL |
getSiteAdministrationURL(PortletResponse portletResponse,
ThemeDisplay themeDisplay)
|
PortletURL |
getSiteAdministrationURL(PortletResponse portletResponse,
ThemeDisplay themeDisplay,
String portletName)
|
long[] |
getSiteAndCompanyGroupIds(long groupId)
|
long[] |
getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
|
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)
|
String |
getValidPortalDomain(long companyId,
String domain)
|
long |
getValidUserId(long companyId,
long userId)
|
String |
getVirtualLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
LayoutFriendlyURLComposite |
getVirtualLayoutFriendlyURLComposite(boolean privateLayout,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
String |
getWidgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
void |
initCustomSQL()
|
User |
initUser(javax.servlet.http.HttpServletRequest request)
|
void |
invokeTaglibDiscussion(PortletConfig portletConfig,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
boolean |
isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
Deprecated. As of 6.2.0 with no direct replacement |
boolean |
isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
|
boolean |
isCDNDynamicResourcesEnabled(long companyId)
|
boolean |
isCommunityAdmin(User user,
long groupId)
Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long) |
boolean |
isCommunityOwner(User user,
long groupId)
Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long) |
boolean |
isCompanyAdmin(User user)
|
boolean |
isCompanyControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
boolean |
isCompanyControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
boolean |
isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
|
boolean |
isControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
boolean |
isControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
boolean |
isGroupAdmin(User user,
long groupId)
|
boolean |
isGroupFriendlyURL(String fullURL,
String groupFriendlyURL,
String layoutFriendlyURL)
|
boolean |
isGroupOwner(User user,
long groupId)
|
boolean |
isLayoutDescendant(Layout layout,
long layoutId)
|
boolean |
isLayoutFirstPageable(Layout layout)
|
boolean |
isLayoutFirstPageable(String type)
|
boolean |
isLayoutFriendliable(Layout layout)
|
boolean |
isLayoutFriendliable(String type)
|
boolean |
isLayoutParentable(Layout layout)
|
boolean |
isLayoutParentable(String type)
|
boolean |
isLayoutSitemapable(Layout layout)
|
boolean |
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 |
isReservedParameter(String name)
|
boolean |
isRightToLeft(javax.servlet.http.HttpServletRequest request)
|
boolean |
isRSSFeedsEnabled()
|
boolean |
isSecure(javax.servlet.http.HttpServletRequest request)
|
boolean |
isSystemGroup(String groupName)
|
boolean |
isSystemRole(String roleName)
|
boolean |
isUpdateAvailable()
|
boolean |
isValidResourceId(String resourceId)
|
void |
removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
|
void |
resetCDNHosts()
|
Set<String> |
resetPortletAddDefaultResourceCheckWhitelist()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelist() |
Set<String> |
resetPortletAddDefaultResourceCheckWhitelistActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions() |
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 |
setPortalPort(javax.servlet.http.HttpServletRequest request)
Sets the port obtained on the first request to the portal. |
void |
storePreferences(PortletPreferences portletPreferences)
|
String[] |
stripURLAnchor(String url,
String separator)
|
String |
transformCustomSQL(String sql)
|
String |
transformSQL(String sql)
|
PortletMode |
updatePortletMode(String portletId,
User user,
Layout layout,
PortletMode portletMode,
javax.servlet.http.HttpServletRequest request)
|
String |
updateRedirect(String redirect,
String oldPath,
String newPath)
|
WindowState |
updateWindowState(String portletId,
User user,
Layout layout,
WindowState windowState,
javax.servlet.http.HttpServletRequest request)
|
Field Detail |
---|
static final String FRIENDLY_URL_SEPARATOR
static final String JSESSIONID
static final String PATH_IMAGE
static final String PATH_MAIN
static final String PATH_MODULE
static final String PATH_PORTAL_LAYOUT
static final String PORTAL_REALM
static final String PORTLET_XML_FILE_NAME_CUSTOM
static final String PORTLET_XML_FILE_NAME_STANDARD
static final String TEMP_OBFUSCATION_VALUE
Method Detail |
---|
void addPageDescription(String description, javax.servlet.http.HttpServletRequest request)
description
- the description to append to the current meta
descriptionrequest
- the servlet request for the pagevoid addPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)
keywords
- the keywords to add to the current meta keywords
(comma-separated)request
- the servlet request for the pagevoid addPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)
subtitle
- the subtitle to append to the current subtitlerequest
- the servlet request for the pagevoid addPageTitle(String title, javax.servlet.http.HttpServletRequest request)
title
- the title to append to the current titlerequest
- the servlet request for the pagevoid addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
portalPortEventListener
- the portal port event listener to addvoid addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)
portalPortEventListener
- the portal port and protocol event listener to addvoid addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url)
request
- the servlet request for the pagetitle
- the title of the new breakcrumb entryurl
- the URL of the new breadcrumb entryvoid addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request, String title, String url, Map<String,Object> data)
request
- 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 entryvoid addPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet) throws PortalException, SystemException
request
- the servlet request for the pageportlet
- the portlet
PortalException
- if adding the default resource permissions failed
SystemException
- if a system exception occurredvoid addPortletDefaultResource(long companyId, Layout layout, Portlet portlet) throws PortalException, SystemException
PortalException
SystemException
String addPreservedParameters(ThemeDisplay themeDisplay, Layout layout, String url, boolean doAsUser)
Preserved parameters are parameters that should be sent with every request as the user navigates the portal.
themeDisplay
- 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.
String addPreservedParameters(ThemeDisplay themeDisplay, String url)
themeDisplay
- the current theme displayurl
- the URL
void addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)
void clearRequestParameters(RenderRequest renderRequest)
renderRequest
- the render requestvoid copyRequestParameters(ActionRequest actionRequest, ActionResponse actionResponse)
actionRequest
- the request from which to get the request parametersactionResponse
- the response to receive the render parametersString escapeRedirect(String url)
url
- the URL to escape
null
if the URL is not an
allowed for redirectsString generateRandomKey(javax.servlet.http.HttpServletRequest request, String input)
request
- the servlet request for the pageinput
- 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) throws PortalException, SystemException
PortalException
SystemException
String getActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException, SystemException
PortalException
SystemException
Locale[] getAlternateLocales(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
LanguageUtil.getAvailableLocales()
request
- the servlet request for the page
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredString getAlternateURL(String canonicalURL, ThemeDisplay themeDisplay, Locale locale, Layout layout) throws PortalException, SystemException
canonicalURL
- the canonical URL previously obtainedthemeDisplay
- the theme displaylocale
- the locale of the translated pagelayout
- the layout
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredSet<String> getAuthTokenIgnoreActions()
AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions()
Set<String> getAuthTokenIgnorePortlets()
AuthTokenWhitelistUtil.getPortletCSRFWhitelist()
BaseModel<?> getBaseModel(ResourcePermission resourcePermission) throws PortalException, SystemException
resourcePermission
- 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 occurredBaseModel<?> getBaseModel(String modelName, String primKey) throws PortalException, SystemException
modelName
- 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 occurredlong getBasicAuthUserId(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
request
- the servlet request from which to retrieve the HTTP
authentication headers
PortalException
- if an authentication exception occurred
SystemException
- if a system exception occurredlong getBasicAuthUserId(javax.servlet.http.HttpServletRequest request, long companyId) throws PortalException, SystemException
request
- the servlet request to retrieve the HTTP authentication
headers fromcompanyId
- unused
PortalException
- if an authentication exception occurred
SystemException
- if a system exception occurredString getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout) throws PortalException, SystemException
completeURL
- the complete URL of the pagethemeDisplay
- the current theme displaylayout
- the layout. If it is null
, then it is
generated for the current layout
PortalException
- if a friendly URL or the group could not be
retrieved
SystemException
- if a system exception occurredString getCanonicalURL(String completeURL, ThemeDisplay themeDisplay, Layout layout, boolean forceLayoutFriendlyURL) throws PortalException, SystemException
completeURL
- the complete URL of the pagethemeDisplay
- the current theme displaylayout
- the layout. If it is null
, then it is
generated for the current layoutforceLayoutFriendlyURL
- adds the page friendly URL to the
canonical URL even if it is not needed
PortalException
- if a friendly URL or the group could not be
retrieved
SystemException
- if a system exception occurredString getCDNHost()
getCDNHost(boolean)
String getCDNHost(boolean secure)
secure
- whether to get the secure or insecure CDN host address
String getCDNHost(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
String getCDNHostHttp(long companyId)
companyId
- the company ID of a site
String getCDNHostHttps(long companyId)
companyId
- the company ID of a site
String getClassName(long classNameId)
classNameId
- the ID of the class
long getClassNameId(Class<?> clazz)
clazz
- the class object
long getClassNameId(String value)
value
- the fully qualified name of the class
String getClassNamePortletId(String className)
className
- the fully qualified name of a class in a portlet
Company getCompany(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
Company getCompany(PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
long getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
long getCompanyId(PortletRequest portletRequest)
long[] getCompanyIds()
@Deprecated String getComputerAddress()
getComputerAddresses()
Set<String> getComputerAddresses()
String getComputerName()
Map<String,List<Portlet>> getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request) throws SystemException
SystemException
String getControlPanelCategory(String portletId, ThemeDisplay themeDisplay) throws SystemException
SystemException
String getControlPanelFullURL(long scopeGroupId, String ppid, Map<String,String[]> params) throws PortalException, SystemException
PortalException
SystemException
long getControlPanelPlid(long companyId) throws PortalException, SystemException
PortalException
SystemException
long getControlPanelPlid(PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
Set<Portlet> getControlPanelPortlets(long companyId, String category) throws SystemException
SystemException
List<Portlet> getControlPanelPortlets(String category, ThemeDisplay themeDisplay) throws SystemException
SystemException
PortletURL getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request, String portletId, long referrerPlid, String lifecycle)
PortletURL getControlPanelPortletURL(PortletRequest portletRequest, String portletId, long referrerPlid, String lifecycle)
String getCreateAccountURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay) throws Exception
Exception
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)
month
- the month (0-based, meaning 0 for January)day
- the day of the monthyear
- the year
Date getDate(int month, int day, int year, Class<? extends PortalException> clazz) throws PortalException
month
- the month (0-based, meaning 0 for January)day
- the day of the monthyear
- the yearclazz
- the exception class 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
Date getDate(int month, int day, int year, int hour, int min, Class<? extends PortalException> clazz) throws PortalException
month
- 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 hourclazz
- the exception class 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
Date getDate(int month, int day, int year, int hour, int min, TimeZone timeZone, Class<? extends PortalException> clazz) throws PortalException
month
- 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 dateclazz
- the exception class 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
Date getDate(int month, int day, int year, TimeZone timeZone, Class<? extends PortalException> clazz) throws PortalException
month
- the month (0-based, meaning 0 for January)day
- the day of the monthyear
- the yeartimeZone
- the time zone of the dateclazz
- the exception class 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
long getDefaultCompanyId()
long getDigestAuthUserId(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
String getDisplayURL(Group group, ThemeDisplay themeDisplay) throws PortalException
PortalException
String getDisplayURL(Group group, ThemeDisplay themeDisplay, boolean privateLayout) throws PortalException
PortalException
String getEmailFromAddress(PortletPreferences preferences, long companyId, String defaultValue) throws SystemException
SystemException
String getEmailFromName(PortletPreferences preferences, long companyId, String defaultValue) throws SystemException
SystemException
Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge, PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
Map<String,Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge, UploadPortletRequest uploadPortletRequest) throws PortalException, SystemException
PortalException
SystemException
Serializable getExpandoValue(javax.servlet.http.HttpServletRequest request, String name, int type, String displayType) throws PortalException, SystemException
PortalException
SystemException
Serializable getExpandoValue(PortletRequest portletRequest, String name, int type, String displayType) throws PortalException, SystemException
PortalException
SystemException
Serializable getExpandoValue(UploadPortletRequest uploadPortletRequest, String name, int type, String displayType) throws PortalException, SystemException
PortalException
SystemException
String getFacebookURL(Portlet portlet, String facebookCanvasPageURL, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
Portlet getFirstMyAccountPortlet(ThemeDisplay themeDisplay) throws SystemException
SystemException
String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
Portlet getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay) throws SystemException
SystemException
String getFullName(String firstName, String middleName, String lastName)
String getGlobalLibDir()
String getGoogleGadgetURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getGroupFriendlyURL(Group group, boolean privateLayoutSet, ThemeDisplay themeDisplay, Locale locale) throws PortalException, SystemException
PortalException
SystemException
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) throws PortalException, SystemException
PortalException
SystemException
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) throws PortalException, SystemException
PortalException
SystemException
Layout getJournalArticleLayout(long groupId, boolean privateLayout, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
String getJsSafePortletId(String portletId)
String getLayoutActualURL(Layout layout)
String getLayoutActualURL(Layout layout, String mainPath)
String getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL) throws PortalException, SystemException
PortalException
SystemException
String getLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException, SystemException
PortalException
SystemException
String getLayoutEditPage(Layout layout)
String getLayoutEditPage(String type)
String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay, Locale locale) throws PortalException, SystemException
PortalException
SystemException
LayoutFriendlyURLComposite getLayoutFriendlyURLComposite(long groupId, boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFullURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFullURL(long groupId, String portletId) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFullURL(long groupId, String portletId, boolean secure) throws PortalException, SystemException
PortalException
SystemException
String getLayoutFullURL(ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutTarget(Layout layout)
String getLayoutURL(Layout layout, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser) throws PortalException, SystemException
PortalException
SystemException
String getLayoutURL(Layout layout, ThemeDisplay themeDisplay, Locale locale) throws PortalException, SystemException
PortalException
SystemException
String getLayoutURL(ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getLayoutViewPage(Layout layout)
String getLayoutViewPage(String type)
LiferayPortletRequest getLiferayPortletRequest(PortletRequest portletRequest)
LiferayPortletResponse getLiferayPortletResponse(PortletResponse portletResponse)
Locale getLocale(javax.servlet.http.HttpServletRequest request)
Locale getLocale(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean initialize)
Locale getLocale(PortletRequest portletRequest)
String getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request, Layout layout, Locale locale, Locale originalLocale) throws Exception
Exception
String getMailId(String mx, String popPortletPrefix, Object... ids)
String getNetvibesURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getNewPortletTitle(String portletTitle, String oldScopeName, String newScopeName)
javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
long getParentGroupId(long scopeGroupId) throws PortalException, SystemException
getSiteGroupId(long)
PortalException
SystemException
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) throws PortalException, SystemException
PortalException
SystemException
long getPlidFromPortletId(long groupId, String portletId) throws PortalException, SystemException
PortalException
SystemException
String getPortalLibDir()
int getPortalPort()
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) throws PortalException, SystemException
PortalException
SystemException
String getPortalURL(PortletRequest portletRequest)
String getPortalURL(PortletRequest portletRequest, boolean secure)
String getPortalURL(String serverName, int serverPort, boolean secure)
String getPortalURL(ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
String getPortalWebDir()
Set<String> getPortletAddDefaultResourceCheckWhitelist()
AuthTokenWhitelistUtil.getPortletInvocationWhitelist()
Set<String> getPortletAddDefaultResourceCheckWhitelistActions()
AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions()
List<BreadcrumbEntry> getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
getPortletBreadcrumbs(HttpServletRequest)
List<BreadcrumbEntry> getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
PortletConfig getPortletConfig(long companyId, String portletId, javax.servlet.ServletContext servletContext) throws PortletException, SystemException
PortletException
SystemException
String getPortletDescription(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
String getPortletDescription(Portlet portlet, User user)
String getPortletDescription(String portletId, Locale locale)
String getPortletDescription(String portletId, String languageId)
String getPortletDescription(String portletId, User user)
String getPortletId(javax.servlet.http.HttpServletRequest request)
String getPortletId(PortletRequest portletRequest)
String getPortletLongTitle(Portlet portlet, Locale locale)
String getPortletLongTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
String getPortletLongTitle(Portlet portlet, String languageId)
String getPortletLongTitle(Portlet portlet, User user)
String getPortletLongTitle(String portletId, Locale locale)
String getPortletLongTitle(String portletId, String languageId)
String getPortletLongTitle(String portletId, User user)
String getPortletNamespace(String portletId)
String getPortletTitle(Portlet portlet, Locale locale)
String getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, Locale locale)
String getPortletTitle(Portlet portlet, String languageId)
String getPortletTitle(Portlet portlet, User user)
String getPortletTitle(RenderRequest renderRequest)
String getPortletTitle(RenderResponse renderResponse)
String getPortletTitle(String portletId, Locale locale)
String getPortletTitle(String portletId, String languageId)
String getPortletTitle(String portletId, User user)
String getPortletXmlFileName() throws SystemException
SystemException
PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)
PreferencesValidator getPreferencesValidator(Portlet portlet)
String getRelativeHomeURL(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
long getScopeGroupId(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
long getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId) throws PortalException, SystemException
PortalException
SystemException
long getScopeGroupId(javax.servlet.http.HttpServletRequest request, String portletId, boolean checkStagingGroup) throws PortalException, SystemException
PortalException
SystemException
long getScopeGroupId(Layout layout)
long getScopeGroupId(Layout layout, String portletId)
long getScopeGroupId(long plid)
long getScopeGroupId(PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
User getSelectedUser(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
User getSelectedUser(javax.servlet.http.HttpServletRequest request, boolean checkPermission) throws PortalException, SystemException
PortalException
SystemException
User getSelectedUser(PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
User getSelectedUser(PortletRequest portletRequest, boolean checkPermission) throws PortalException, SystemException
PortalException
SystemException
String getServletContextName()
long[] getSharedContentSiteGroupIds(long companyId, long groupId, long userId) throws PortalException, SystemException
PortalException
SystemException
Map<String,List<Portlet>> getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request) throws SystemException
SystemException
PortletURL getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay) throws SystemException
SystemException
PortletURL getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request, ThemeDisplay themeDisplay, String portletName)
PortletURL getSiteAdministrationURL(PortletResponse portletResponse, ThemeDisplay themeDisplay) throws SystemException
SystemException
PortletURL getSiteAdministrationURL(PortletResponse portletResponse, ThemeDisplay themeDisplay, String portletName)
long[] getSiteAndCompanyGroupIds(long groupId) throws PortalException, SystemException
PortalException
SystemException
long[] getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
Locale getSiteDefaultLocale(long groupId) throws PortalException, SystemException
PortalException
SystemException
long getSiteGroupId(long groupId) throws PortalException, SystemException
PortalException
SystemException
String getSiteLoginURL(ThemeDisplay themeDisplay) throws PortalException, SystemException
themeDisplay
- the theme display for the current page
null
if one is not available
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredString 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) throws PortalException, SystemException
PortalException
SystemException
User getUser(PortletRequest portletRequest) throws PortalException, SystemException
PortalException
SystemException
String getUserEmailAddress(long userId) throws SystemException
SystemException
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) throws SystemException
SystemException
String getValidPortalDomain(long companyId, String domain)
long getValidUserId(long companyId, long userId) throws PortalException, SystemException
PortalException
SystemException
String getVirtualLayoutActualURL(long groupId, boolean privateLayout, String mainPath, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException, SystemException
PortalException
SystemException
LayoutFriendlyURLComposite getVirtualLayoutFriendlyURLComposite(boolean privateLayout, String friendlyURL, Map<String,String[]> params, Map<String,Object> requestContext) throws PortalException, SystemException
PortalException
SystemException
String getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
void initCustomSQL()
User initUser(javax.servlet.http.HttpServletRequest request) throws Exception
Exception
void invokeTaglibDiscussion(PortletConfig portletConfig, ActionRequest actionRequest, ActionResponse actionResponse) throws Exception
Exception
boolean isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request, Portlet portlet) throws PortalException, SystemException
PortalException
SystemException
boolean isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
boolean isCDNDynamicResourcesEnabled(long companyId)
boolean isCommunityAdmin(User user, long groupId) throws Exception
isGroupAdmin(User, long)
Exception
boolean isCommunityOwner(User user, long groupId) throws Exception
isGroupOwner(User, long)
Exception
boolean isCompanyAdmin(User user) throws Exception
Exception
boolean isCompanyControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
boolean isCompanyControlPanelPortlet(String portletId, ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
boolean isCompanyControlPanelVisible(ThemeDisplay themeDisplay) throws PortalException, SystemException
PortalException
SystemException
boolean isControlPanelPortlet(String portletId, String category, ThemeDisplay themeDisplay) throws SystemException
SystemException
boolean isControlPanelPortlet(String portletId, ThemeDisplay themeDisplay) throws SystemException
SystemException
boolean isGroupAdmin(User user, long groupId) throws Exception
Exception
boolean isGroupFriendlyURL(String fullURL, String groupFriendlyURL, String layoutFriendlyURL)
boolean isGroupOwner(User user, long groupId) throws Exception
Exception
boolean isLayoutDescendant(Layout layout, long layoutId) throws PortalException, SystemException
PortalException
SystemException
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 isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request) throws SystemException
SystemException
boolean isMethodGet(PortletRequest portletRequest)
boolean isMethodPost(PortletRequest portletRequest)
boolean isMultipartRequest(javax.servlet.http.HttpServletRequest request)
boolean isOmniadmin(long userId)
boolean isReservedParameter(String name)
boolean isRightToLeft(javax.servlet.http.HttpServletRequest request)
boolean isRSSFeedsEnabled()
boolean isSecure(javax.servlet.http.HttpServletRequest request)
boolean isSystemGroup(String groupName)
boolean isSystemRole(String roleName)
boolean isUpdateAvailable() throws SystemException
SystemException
boolean isValidResourceId(String resourceId)
void removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
void resetCDNHosts()
Set<String> resetPortletAddDefaultResourceCheckWhitelist()
AuthTokenWhitelistUtil.resetPortletInvocationWhitelist()
Set<String> resetPortletAddDefaultResourceCheckWhitelistActions()
AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions()
String resetPortletParameters(String url, String portletId)
void sendError(Exception e, ActionRequest actionRequest, ActionResponse actionResponse) throws IOException
IOException
void sendError(Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
void sendError(int status, Exception e, ActionRequest actionRequest, ActionResponse actionResponse) throws IOException
IOException
void sendError(int status, Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
void sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
void sendRSSFeedsDisabledError(PortletRequest portletRequest, PortletResponse portletResponse) throws IOException, javax.servlet.ServletException
IOException
javax.servlet.ServletException
void setPageDescription(String description, javax.servlet.http.HttpServletRequest request)
void setPageKeywords(String keywords, javax.servlet.http.HttpServletRequest request)
void setPageSubtitle(String subtitle, javax.servlet.http.HttpServletRequest request)
void setPageTitle(String title, javax.servlet.http.HttpServletRequest request)
void setPortalPort(javax.servlet.http.HttpServletRequest request)
void storePreferences(PortletPreferences portletPreferences) throws IOException, ValidatorException
IOException
ValidatorException
String[] stripURLAnchor(String url, String separator)
String transformCustomSQL(String sql)
String transformSQL(String sql)
PortletMode updatePortletMode(String portletId, User user, Layout layout, PortletMode portletMode, javax.servlet.http.HttpServletRequest request) throws PortalException, SystemException
PortalException
SystemException
String updateRedirect(String redirect, String oldPath, String newPath)
WindowState updateWindowState(String portletId, User user, Layout layout, WindowState windowState, javax.servlet.http.HttpServletRequest request)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |