|
Liferay 6.2.0 | |||||||||
| 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 | |
|---|---|
abstract void |
addPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Appends the description to the current meta description of the page. |
abstract void |
addPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Appends the keywords to the current meta keywords of the page. |
abstract void |
addPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Appends the subtitle to the current subtitle of the page. |
abstract void |
addPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Appends the title to the current title of the page. |
abstract void |
addPortalPortEventListener(PortalPortEventListener portalPortEventListener)
Adds the portal port event listener to the portal. |
abstract void |
addPortalPortProtocolEventListener(PortalPortProtocolEventListener portalPortProtocolEventListener)
Adds the portal port and protocol event listener to the portal. |
abstract void |
addPortletBreadcrumbEntry(javax.servlet.http.HttpServletRequest request,
String title,
String url)
Adds an entry to the portlet breadcrumbs for the page. |
abstract 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. |
abstract void |
addPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
Adds the default resource permissions for the portlet to the page. |
abstract void |
addPortletDefaultResource(long companyId,
Layout layout,
Portlet portlet)
|
abstract 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. |
abstract String |
addPreservedParameters(ThemeDisplay themeDisplay,
String url)
Adds the preserved parameters doAsUserId, doAsUserLanguageId, doAsGroupId, refererPlid, and controlPanelCategory to the URL. |
abstract void |
addUserLocaleOptionsMessage(javax.servlet.http.HttpServletRequest request)
|
abstract void |
clearRequestParameters(RenderRequest renderRequest)
Clears the render parameters in the request if the portlet is in the action phase. |
abstract 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. |
abstract String |
escapeRedirect(String url)
Escapes the URL for use in a redirect and checks that security settings allow the URL is allowed for redirects. |
abstract String |
generateRandomKey(javax.servlet.http.HttpServletRequest request,
String input)
Generates a random key to identify the request based on the input string. |
abstract String |
getAbsoluteURL(javax.servlet.http.HttpServletRequest request,
String url)
|
abstract LayoutQueryStringComposite |
getActualLayoutQueryStringComposite(long groupId,
boolean privateLayout,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract String |
getActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract Locale[] |
getAlternateLocales(javax.servlet.http.HttpServletRequest request)
Deprecated. As of 6.2.0, replaced by LanguageUtil.getAvailableLocales() |
abstract String |
getAlternateURL(String canonicalURL,
ThemeDisplay themeDisplay,
Locale locale,
Layout layout)
Returns the alternate URL of the page, to distinguish it from its canonical URL. |
abstract Set<String> |
getAuthTokenIgnoreActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelistActions() |
abstract Set<String> |
getAuthTokenIgnorePortlets()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletCSRFWhitelist() |
abstract BaseModel<?> |
getBaseModel(ResourcePermission resourcePermission)
Returns the base model instance for the resource permission. |
abstract BaseModel<?> |
getBaseModel(String modelName,
String primKey)
Returns the base model instance for the model name and primary key. |
abstract long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request)
Returns the user's ID from the HTTP authentication headers after validating their credentials. |
abstract long |
getBasicAuthUserId(javax.servlet.http.HttpServletRequest request,
long companyId)
Returns the user's ID from the HTTP authentication headers after validation their credentials. |
abstract String |
getCanonicalURL(String completeURL,
ThemeDisplay themeDisplay,
Layout layout)
Returns the canonical URL of the page, to distinguish it among its translations. |
abstract String |
getCanonicalURL(String completeURL,
ThemeDisplay themeDisplay,
Layout layout,
boolean forceLayoutFriendlyURL)
Returns the canonical URL of the page, to distinguish it among its translations. |
abstract String |
getCDNHost()
Deprecated. As of 6.2.0, replaced by the more general getCDNHost(boolean) |
abstract String |
getCDNHost(boolean secure)
Returns the secure (HTTPS) or insecure (HTTP) content distribution network (CDN) host address for this portal. |
abstract String |
getCDNHost(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getCDNHostHttp(long companyId)
Returns the insecure (HTTP) content distribution network (CDN) host address |
abstract String |
getCDNHostHttps(long companyId)
Returns the secure (HTTPS) content distribution network (CDN) host address |
abstract String |
getClassName(long classNameId)
Returns the fully qualified name of the class from its ID. |
abstract long |
getClassNameId(Class<?> clazz)
Returns the ID of the class from its class object. |
abstract long |
getClassNameId(String value)
Returns the ID of the class from its fully qualified name. |
abstract String |
getClassNamePortletId(String className)
Returns the ID of certain portlets from the fully qualified name of one of their classes. |
abstract Company |
getCompany(javax.servlet.http.HttpServletRequest request)
|
abstract Company |
getCompany(PortletRequest portletRequest)
|
abstract long |
getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
|
abstract long |
getCompanyId(PortletRequest portletRequest)
|
abstract long[] |
getCompanyIds()
|
abstract String |
getComputerAddress()
Deprecated. As of 7.0.0, replaced by getComputerAddresses() |
abstract Set<String> |
getComputerAddresses()
|
abstract String |
getComputerName()
|
abstract Map<String,List<Portlet>> |
getControlPanelCategoriesMap(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getControlPanelCategory(String portletId,
ThemeDisplay themeDisplay)
|
abstract String |
getControlPanelFullURL(long scopeGroupId,
String ppid,
Map<String,String[]> params)
|
abstract long |
getControlPanelPlid(long companyId)
|
abstract long |
getControlPanelPlid(PortletRequest portletRequest)
|
abstract Set<Portlet> |
getControlPanelPortlets(long companyId,
String category)
|
abstract List<Portlet> |
getControlPanelPortlets(String category,
ThemeDisplay themeDisplay)
|
abstract PortletURL |
getControlPanelPortletURL(javax.servlet.http.HttpServletRequest request,
String portletId,
long referrerPlid,
String lifecycle)
|
abstract PortletURL |
getControlPanelPortletURL(PortletRequest portletRequest,
String portletId,
long referrerPlid,
String lifecycle)
|
abstract String |
getCreateAccountURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
|
abstract String |
getCurrentCompleteURL(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getCurrentURL(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getCurrentURL(PortletRequest portletRequest)
|
abstract String |
getCustomSQLFunctionIsNotNull()
|
abstract String |
getCustomSQLFunctionIsNull()
|
abstract Date |
getDate(int month,
int day,
int year)
Returns the date object for the specified month, day, and year. |
abstract 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. |
abstract 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. |
abstract 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. |
abstract 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. |
abstract long |
getDefaultCompanyId()
|
abstract long |
getDigestAuthUserId(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getDisplayURL(Group group,
ThemeDisplay themeDisplay)
|
abstract String |
getDisplayURL(Group group,
ThemeDisplay themeDisplay,
boolean privateLayout)
|
abstract String |
getEmailFromAddress(PortletPreferences preferences,
long companyId,
String defaultValue)
|
abstract String |
getEmailFromName(PortletPreferences preferences,
long companyId,
String defaultValue)
|
abstract Map<String,Serializable> |
getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
javax.servlet.http.HttpServletRequest request)
|
abstract Map<String,Serializable> |
getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
PortletRequest portletRequest)
|
abstract Map<String,Serializable> |
getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
UploadPortletRequest uploadPortletRequest)
|
abstract Serializable |
getExpandoValue(javax.servlet.http.HttpServletRequest request,
String name,
int type,
String displayType)
|
abstract Serializable |
getExpandoValue(PortletRequest portletRequest,
String name,
int type,
String displayType)
|
abstract Serializable |
getExpandoValue(UploadPortletRequest uploadPortletRequest,
String name,
int type,
String displayType)
|
abstract String |
getFacebookURL(Portlet portlet,
String facebookCanvasPageURL,
ThemeDisplay themeDisplay)
|
abstract Portlet |
getFirstMyAccountPortlet(ThemeDisplay themeDisplay)
|
abstract String |
getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
|
abstract Portlet |
getFirstSiteAdministrationPortlet(ThemeDisplay themeDisplay)
|
abstract String |
getFullName(String firstName,
String middleName,
String lastName)
|
abstract String |
getGlobalLibDir()
|
abstract String |
getGoogleGadgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
abstract String |
getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay)
|
abstract String |
getGroupFriendlyURL(Group group,
boolean privateLayoutSet,
ThemeDisplay themeDisplay,
Locale locale)
|
abstract int[] |
getGroupFriendlyURLIndex(String requestURI)
|
abstract String[] |
getGroupPermissions(javax.servlet.http.HttpServletRequest request)
|
abstract String[] |
getGroupPermissions(javax.servlet.http.HttpServletRequest request,
String className)
|
abstract String[] |
getGroupPermissions(PortletRequest portletRequest)
|
abstract String[] |
getGroupPermissions(PortletRequest portletRequest,
String className)
|
abstract String[] |
getGuestPermissions(javax.servlet.http.HttpServletRequest request)
|
abstract String[] |
getGuestPermissions(javax.servlet.http.HttpServletRequest request,
String className)
|
abstract String[] |
getGuestPermissions(PortletRequest portletRequest)
|
abstract String[] |
getGuestPermissions(PortletRequest portletRequest,
String className)
|
abstract String |
getHomeURL(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getHost(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getHost(PortletRequest portletRequest)
|
abstract javax.servlet.http.HttpServletRequest |
getHttpServletRequest(PortletRequest portletRequest)
|
abstract javax.servlet.http.HttpServletResponse |
getHttpServletResponse(PortletResponse portletResponse)
|
abstract String |
getI18nPathLanguageId(Locale locale,
String defaultI18nPathLanguageId)
|
abstract String |
getJournalArticleActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract Layout |
getJournalArticleLayout(long groupId,
boolean privateLayout,
String friendlyURL)
|
abstract String |
getJsSafePortletId(String portletId)
|
abstract String |
getLayoutActualURL(Layout layout)
|
abstract String |
getLayoutActualURL(Layout layout,
String mainPath)
|
abstract String |
getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL)
|
abstract String |
getLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract String |
getLayoutEditPage(Layout layout)
|
abstract String |
getLayoutEditPage(String type)
|
abstract String |
getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay)
|
abstract String |
getLayoutFriendlyURL(Layout layout,
ThemeDisplay themeDisplay,
Locale locale)
|
abstract LayoutFriendlyURLComposite |
getLayoutFriendlyURLComposite(long groupId,
boolean privateLayout,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract String |
getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay)
|
abstract String |
getLayoutFullURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
|
abstract String |
getLayoutFullURL(long groupId,
String portletId)
|
abstract String |
getLayoutFullURL(long groupId,
String portletId,
boolean secure)
|
abstract String |
getLayoutFullURL(ThemeDisplay themeDisplay)
|
abstract String |
getLayoutSetFriendlyURL(LayoutSet layoutSet,
ThemeDisplay themeDisplay)
|
abstract String |
getLayoutTarget(Layout layout)
|
abstract String |
getLayoutURL(Layout layout,
ThemeDisplay themeDisplay)
|
abstract String |
getLayoutURL(Layout layout,
ThemeDisplay themeDisplay,
boolean doAsUser)
|
abstract String |
getLayoutURL(Layout layout,
ThemeDisplay themeDisplay,
Locale locale)
|
abstract String |
getLayoutURL(ThemeDisplay themeDisplay)
|
abstract String |
getLayoutViewPage(Layout layout)
|
abstract String |
getLayoutViewPage(String type)
|
abstract LiferayPortletRequest |
getLiferayPortletRequest(PortletRequest portletRequest)
|
abstract LiferayPortletResponse |
getLiferayPortletResponse(PortletResponse portletResponse)
|
abstract Locale |
getLocale(javax.servlet.http.HttpServletRequest request)
|
abstract Locale |
getLocale(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
boolean initialize)
|
abstract Locale |
getLocale(PortletRequest portletRequest)
|
abstract String |
getLocalizedFriendlyURL(javax.servlet.http.HttpServletRequest request,
Layout layout,
Locale locale,
Locale originalLocale)
|
abstract String |
getMailId(String mx,
String popPortletPrefix,
Object... ids)
|
abstract String |
getNetvibesURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
abstract String |
getNewPortletTitle(String portletTitle,
String oldScopeName,
String newScopeName)
|
abstract javax.servlet.http.HttpServletRequest |
getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
|
abstract long |
getParentGroupId(long scopeGroupId)
Deprecated. As of 6.2.0 renamed to getSiteGroupId(long) |
abstract String |
getPathContext()
|
abstract String |
getPathContext(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getPathContext(PortletRequest portletRequest)
|
abstract String |
getPathContext(String contextPath)
|
abstract String |
getPathFriendlyURLPrivateGroup()
|
abstract String |
getPathFriendlyURLPrivateUser()
|
abstract String |
getPathFriendlyURLPublic()
|
abstract String |
getPathImage()
|
abstract String |
getPathMain()
|
abstract String |
getPathModule()
|
abstract String |
getPathProxy()
|
abstract long |
getPlidFromFriendlyURL(long companyId,
String friendlyURL)
|
abstract long |
getPlidFromPortletId(long groupId,
boolean privateLayout,
String portletId)
|
abstract long |
getPlidFromPortletId(long groupId,
String portletId)
|
abstract String |
getPortalLibDir()
|
abstract int |
getPortalPort()
Deprecated. As of 6.2.0, replaced by the more general getPortalPort(boolean) |
abstract int |
getPortalPort(boolean secure)
|
abstract Properties |
getPortalProperties()
|
abstract String |
getPortalURL(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getPortalURL(javax.servlet.http.HttpServletRequest request,
boolean secure)
|
abstract String |
getPortalURL(LayoutSet layoutSet,
ThemeDisplay themeDisplay)
|
abstract String |
getPortalURL(Layout layout,
ThemeDisplay themeDisplay)
|
abstract String |
getPortalURL(PortletRequest portletRequest)
|
abstract String |
getPortalURL(PortletRequest portletRequest,
boolean secure)
|
abstract String |
getPortalURL(String serverName,
int serverPort,
boolean secure)
|
abstract String |
getPortalURL(ThemeDisplay themeDisplay)
|
abstract String |
getPortalWebDir()
|
abstract Set<String> |
getPortletAddDefaultResourceCheckWhitelist()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelist() |
abstract Set<String> |
getPortletAddDefaultResourceCheckWhitelistActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.getPortletInvocationWhitelistActions() |
abstract List<BreadcrumbEntry> |
getPortletBreadcrumbList(javax.servlet.http.HttpServletRequest request)
Deprecated. As of 6.2.0, replaced by getPortletBreadcrumbs(HttpServletRequest) |
abstract List<BreadcrumbEntry> |
getPortletBreadcrumbs(javax.servlet.http.HttpServletRequest request)
|
abstract PortletConfig |
getPortletConfig(long companyId,
String portletId,
javax.servlet.ServletContext servletContext)
|
abstract String |
getPortletDescription(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
abstract String |
getPortletDescription(Portlet portlet,
User user)
|
abstract String |
getPortletDescription(String portletId,
Locale locale)
|
abstract String |
getPortletDescription(String portletId,
String languageId)
|
abstract String |
getPortletDescription(String portletId,
User user)
|
abstract String |
getPortletId(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getPortletId(PortletRequest portletRequest)
|
abstract String |
getPortletLongTitle(Portlet portlet,
Locale locale)
|
abstract String |
getPortletLongTitle(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
abstract String |
getPortletLongTitle(Portlet portlet,
String languageId)
|
abstract String |
getPortletLongTitle(Portlet portlet,
User user)
|
abstract String |
getPortletLongTitle(String portletId,
Locale locale)
|
abstract String |
getPortletLongTitle(String portletId,
String languageId)
|
abstract String |
getPortletLongTitle(String portletId,
User user)
|
abstract String |
getPortletNamespace(String portletId)
|
abstract String |
getPortletTitle(Portlet portlet,
Locale locale)
|
abstract String |
getPortletTitle(Portlet portlet,
javax.servlet.ServletContext servletContext,
Locale locale)
|
abstract String |
getPortletTitle(Portlet portlet,
String languageId)
|
abstract String |
getPortletTitle(Portlet portlet,
User user)
|
abstract String |
getPortletTitle(RenderRequest renderRequest)
|
abstract String |
getPortletTitle(RenderResponse renderResponse)
|
abstract String |
getPortletTitle(String portletId,
Locale locale)
|
abstract String |
getPortletTitle(String portletId,
String languageId)
|
abstract String |
getPortletTitle(String portletId,
User user)
|
abstract String |
getPortletXmlFileName()
|
abstract PortletPreferences |
getPreferences(javax.servlet.http.HttpServletRequest request)
|
abstract PreferencesValidator |
getPreferencesValidator(Portlet portlet)
|
abstract String |
getRelativeHomeURL(javax.servlet.http.HttpServletRequest request)
|
abstract long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request)
|
abstract long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId)
|
abstract long |
getScopeGroupId(javax.servlet.http.HttpServletRequest request,
String portletId,
boolean checkStagingGroup)
|
abstract long |
getScopeGroupId(Layout layout)
|
abstract long |
getScopeGroupId(Layout layout,
String portletId)
|
abstract long |
getScopeGroupId(long plid)
|
abstract long |
getScopeGroupId(PortletRequest portletRequest)
|
abstract User |
getSelectedUser(javax.servlet.http.HttpServletRequest request)
|
abstract User |
getSelectedUser(javax.servlet.http.HttpServletRequest request,
boolean checkPermission)
|
abstract User |
getSelectedUser(PortletRequest portletRequest)
|
abstract User |
getSelectedUser(PortletRequest portletRequest,
boolean checkPermission)
|
abstract String |
getServletContextName()
|
abstract long[] |
getSharedContentSiteGroupIds(long companyId,
long groupId,
long userId)
|
abstract Map<String,List<Portlet>> |
getSiteAdministrationCategoriesMap(javax.servlet.http.HttpServletRequest request)
|
abstract PortletURL |
getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay)
|
abstract PortletURL |
getSiteAdministrationURL(javax.servlet.http.HttpServletRequest request,
ThemeDisplay themeDisplay,
String portletName)
|
abstract PortletURL |
getSiteAdministrationURL(PortletResponse portletResponse,
ThemeDisplay themeDisplay)
|
abstract PortletURL |
getSiteAdministrationURL(PortletResponse portletResponse,
ThemeDisplay themeDisplay,
String portletName)
|
abstract long[] |
getSiteAndCompanyGroupIds(long groupId)
|
abstract long[] |
getSiteAndCompanyGroupIds(ThemeDisplay themeDisplay)
|
abstract Locale |
getSiteDefaultLocale(long groupId)
|
abstract long |
getSiteGroupId(long groupId)
|
abstract String |
getSiteLoginURL(ThemeDisplay themeDisplay)
Returns the URL of the login page for the current site if one is available. |
abstract String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri)
|
abstract String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
long timestamp)
|
abstract String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString)
|
abstract String |
getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
String uri,
String queryString,
long timestamp)
|
abstract String |
getStrutsAction(javax.servlet.http.HttpServletRequest request)
|
abstract String[] |
getSystemGroups()
|
abstract String[] |
getSystemOrganizationRoles()
|
abstract String[] |
getSystemRoles()
|
abstract String[] |
getSystemSiteRoles()
|
abstract String |
getUniqueElementId(javax.servlet.http.HttpServletRequest request,
String namespace,
String id)
|
abstract String |
getUniqueElementId(PortletRequest request,
String namespace,
String id)
|
abstract UploadPortletRequest |
getUploadPortletRequest(PortletRequest portletRequest)
|
abstract UploadServletRequest |
getUploadServletRequest(javax.servlet.http.HttpServletRequest request)
|
abstract Date |
getUptime()
|
abstract String |
getURLWithSessionId(String url,
String sessionId)
|
abstract User |
getUser(javax.servlet.http.HttpServletRequest request)
|
abstract User |
getUser(PortletRequest portletRequest)
|
abstract String |
getUserEmailAddress(long userId)
|
abstract long |
getUserId(javax.servlet.http.HttpServletRequest request)
|
abstract long |
getUserId(PortletRequest portletRequest)
|
abstract String |
getUserName(BaseModel<?> baseModel)
|
abstract String |
getUserName(long userId,
String defaultUserName)
|
abstract String |
getUserName(long userId,
String defaultUserName,
javax.servlet.http.HttpServletRequest request)
|
abstract String |
getUserName(long userId,
String defaultUserName,
String userAttribute)
|
abstract String |
getUserName(long userId,
String defaultUserName,
String userAttribute,
javax.servlet.http.HttpServletRequest request)
|
abstract String |
getUserPassword(javax.servlet.http.HttpServletRequest request)
|
abstract String |
getUserPassword(javax.servlet.http.HttpSession session)
|
abstract String |
getUserPassword(PortletRequest portletRequest)
|
abstract String |
getUserValue(long userId,
String param,
String defaultValue)
|
abstract String |
getValidPortalDomain(long companyId,
String domain)
|
abstract long |
getValidUserId(long companyId,
long userId)
|
abstract String |
getVirtualLayoutActualURL(long groupId,
boolean privateLayout,
String mainPath,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract LayoutFriendlyURLComposite |
getVirtualLayoutFriendlyURLComposite(boolean privateLayout,
String friendlyURL,
Map<String,String[]> params,
Map<String,Object> requestContext)
|
abstract String |
getWidgetURL(Portlet portlet,
ThemeDisplay themeDisplay)
|
abstract void |
initCustomSQL()
|
abstract User |
initUser(javax.servlet.http.HttpServletRequest request)
|
abstract void |
invokeTaglibDiscussion(PortletConfig portletConfig,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
abstract boolean |
isAllowAddPortletDefaultResource(javax.servlet.http.HttpServletRequest request,
Portlet portlet)
Deprecated. As of 6.2.0 with no direct replacement |
abstract boolean |
isCDNDynamicResourcesEnabled(javax.servlet.http.HttpServletRequest request)
|
abstract boolean |
isCDNDynamicResourcesEnabled(long companyId)
|
abstract boolean |
isCommunityAdmin(User user,
long groupId)
Deprecated. As of 6.1.0, renamed to isGroupAdmin(User, long) |
abstract boolean |
isCommunityOwner(User user,
long groupId)
Deprecated. As of 6.1.0, renamed to isGroupOwner(User, long) |
abstract boolean |
isCompanyAdmin(User user)
|
abstract boolean |
isCompanyControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
abstract boolean |
isCompanyControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
abstract boolean |
isCompanyControlPanelVisible(ThemeDisplay themeDisplay)
|
abstract boolean |
isControlPanelPortlet(String portletId,
String category,
ThemeDisplay themeDisplay)
|
abstract boolean |
isControlPanelPortlet(String portletId,
ThemeDisplay themeDisplay)
|
abstract boolean |
isGroupAdmin(User user,
long groupId)
|
abstract boolean |
isGroupFriendlyURL(String fullURL,
String groupFriendlyURL,
String layoutFriendlyURL)
|
abstract boolean |
isGroupOwner(User user,
long groupId)
|
abstract boolean |
isLayoutDescendant(Layout layout,
long layoutId)
|
abstract boolean |
isLayoutFirstPageable(Layout layout)
|
abstract boolean |
isLayoutFirstPageable(String type)
|
abstract boolean |
isLayoutFriendliable(Layout layout)
|
abstract boolean |
isLayoutFriendliable(String type)
|
abstract boolean |
isLayoutParentable(Layout layout)
|
abstract boolean |
isLayoutParentable(String type)
|
abstract boolean |
isLayoutSitemapable(Layout layout)
|
abstract boolean |
isLoginRedirectRequired(javax.servlet.http.HttpServletRequest request)
|
abstract boolean |
isMethodGet(PortletRequest portletRequest)
|
abstract boolean |
isMethodPost(PortletRequest portletRequest)
|
abstract boolean |
isMultipartRequest(javax.servlet.http.HttpServletRequest request)
|
abstract boolean |
isOmniadmin(long userId)
|
abstract boolean |
isOmniadmin(User user)
|
abstract boolean |
isReservedParameter(String name)
|
abstract boolean |
isRightToLeft(javax.servlet.http.HttpServletRequest request)
|
abstract boolean |
isRSSFeedsEnabled()
|
abstract boolean |
isSecure(javax.servlet.http.HttpServletRequest request)
|
abstract boolean |
isSkipPortletContentProcessing(Group group,
javax.servlet.http.HttpServletRequest httpServletRequest,
LayoutTypePortlet layoutTypePortlet,
PortletDisplay portletDisplay,
String portletName)
|
abstract boolean |
isSkipPortletContentRendering(Group group,
LayoutTypePortlet layoutTypePortlet,
PortletDisplay portletDisplay,
String portletName)
|
abstract boolean |
isSystemGroup(String groupName)
|
abstract boolean |
isSystemRole(String roleName)
|
abstract boolean |
isUpdateAvailable()
|
abstract boolean |
isValidResourceId(String resourceId)
|
abstract void |
removePortalPortEventListener(PortalPortEventListener portalPortEventListener)
|
abstract void |
resetCDNHosts()
|
abstract Set<String> |
resetPortletAddDefaultResourceCheckWhitelist()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelist() |
abstract Set<String> |
resetPortletAddDefaultResourceCheckWhitelistActions()
Deprecated. As of 6.2.0, replaced by AuthTokenWhitelistUtil.resetPortletInvocationWhitelistActions() |
abstract String |
resetPortletParameters(String url,
String portletId)
|
abstract void |
sendError(Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
abstract void |
sendError(Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
abstract void |
sendError(int status,
Exception e,
ActionRequest actionRequest,
ActionResponse actionResponse)
|
abstract void |
sendError(int status,
Exception e,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
abstract void |
sendRSSFeedsDisabledError(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
|
abstract void |
sendRSSFeedsDisabledError(PortletRequest portletRequest,
PortletResponse portletResponse)
|
abstract void |
setPageDescription(String description,
javax.servlet.http.HttpServletRequest request)
Sets the description for the page, overriding the existing page description. |
abstract void |
setPageKeywords(String keywords,
javax.servlet.http.HttpServletRequest request)
Sets the keywords for the page, overriding the existing page keywords. |
abstract void |
setPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
Sets the subtitle for the page, overriding the existing page subtitle. |
abstract void |
setPageTitle(String title,
javax.servlet.http.HttpServletRequest request)
Sets the whole title for the page, overriding the existing page whole title. |
abstract void |
setPortalPort(javax.servlet.http.HttpServletRequest request)
Sets the port obtained on the first request to the portal. |
abstract void |
storePreferences(PortletPreferences portletPreferences)
|
abstract String[] |
stripURLAnchor(String url,
String separator)
|
abstract String |
transformCustomSQL(String sql)
|
abstract String |
transformSQL(String sql)
|
abstract PortletMode |
updatePortletMode(String portletId,
User user,
Layout layout,
PortletMode portletMode,
javax.servlet.http.HttpServletRequest request)
|
abstract String |
updateRedirect(String redirect,
String oldPath,
String newPath)
|
abstract 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 page
void 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 page
void addPageSubtitle(String subtitle,
javax.servlet.http.HttpServletRequest request)
subtitle - the subtitle to append to the current subtitlerequest - the servlet request for the page
void 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 add
void 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 entry
void 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 entry
void 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 occurred
void 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 request
void 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 redirects
String 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 occurred
String 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 occurred
BaseModel<?> 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 occurred
long 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 occurred
long 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 occurred
String 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 occurred
String 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
SystemExceptionString 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
SystemExceptionlong 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
ExceptionString 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 nulllong 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
SystemExceptionString 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
SystemExceptionint[] 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
SystemExceptionString 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
SystemExceptionString 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
SystemExceptionString 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
SystemExceptionString 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
SystemExceptionString 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
SystemExceptionString 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
SystemExceptionString 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(LayoutSet layoutSet,
ThemeDisplay themeDisplay)
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
SystemExceptionString 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
SystemExceptionPortletPreferences 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
SystemExceptionlong 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
SystemExceptionString 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 occurred
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)
throws PortalException,
SystemException
PortalException
SystemException
User getUser(PortletRequest portletRequest)
throws PortalException,
SystemException
PortalException
SystemException
String getUserEmailAddress(long userId)
throws SystemException
SystemExceptionlong 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
SystemExceptionvoid 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
SystemExceptionboolean 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
SystemExceptionboolean 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
SystemExceptionboolean isMethodGet(PortletRequest portletRequest)
boolean isMethodPost(PortletRequest portletRequest)
boolean isMultipartRequest(javax.servlet.http.HttpServletRequest request)
boolean isOmniadmin(long userId)
boolean isOmniadmin(User user)
boolean isReservedParameter(String name)
boolean isRightToLeft(javax.servlet.http.HttpServletRequest request)
boolean isRSSFeedsEnabled()
boolean isSecure(javax.servlet.http.HttpServletRequest request)
boolean isSkipPortletContentProcessing(Group group,
javax.servlet.http.HttpServletRequest httpServletRequest,
LayoutTypePortlet layoutTypePortlet,
PortletDisplay portletDisplay,
String portletName)
throws Exception
Exception
boolean isSkipPortletContentRendering(Group group,
LayoutTypePortlet layoutTypePortlet,
PortletDisplay portletDisplay,
String portletName)
throws PortalException,
SystemException
PortalException
SystemExceptionboolean isSystemGroup(String groupName)
boolean isSystemRole(String roleName)
boolean isUpdateAvailable()
throws SystemException
SystemExceptionboolean 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.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||