public interface IPortalUrlFactory
| Modifier and Type | Field and Description |
|---|---|
static String |
CONTEXTUALIZATION_PAGE
Contextualization type "page".
|
static String |
CONTEXTUALIZATION_PORTAL
Contextualization type "portal".
|
static String |
CONTEXTUALIZATION_PORTLET
Contextualization type "portlet".
|
static String |
DISPLAYCTX_PREVIEW_LIVE_VERSION
Display context preview (live version for validation purpose).
|
static String |
DISPLAYCTX_REFRESH
Display context refresh.
|
static String |
MBEAN_NAME |
static String |
PERM_LINK_TYPE_CMS
Permalink type "CMS".
|
static String |
PERM_LINK_TYPE_PAGE
Permalink type "page".
|
static String |
PERM_LINK_TYPE_PORTLET_RESOURCE
Permalink type portlet resource.
|
static String |
PERM_LINK_TYPE_RSS
Permalink type "RSS".
|
static String |
PERM_LINK_TYPE_RSS_PICTURE
Permalink type "RSS picture".
|
static String |
PERM_LINK_TYPE_SHARE
Permalink type share.
|
static int |
POPUP_URL_ADAPTER_CLOSE
Popup URL adapter close status.
|
static int |
POPUP_URL_ADAPTER_CLOSED_NOTIFICATION
Popup URL adapter closed notification status.
|
static int |
POPUP_URL_ADAPTER_OPEN
Popup URL adapter open status.
|
| Modifier and Type | Method and Description |
|---|---|
String |
adaptPortalUrlToNavigation(PortalControllerContext portalControllerContext,
String originalUrl)
Adapt portal URL to navigation.
|
String |
adaptPortalUrlToPopup(PortalControllerContext portalControllerContext,
String originalUrl,
int adapter)
Adapt portal URL to popup.
|
String |
getAdvancedSearchUrl(PortalControllerContext portalControllerContext,
String search,
boolean advancedSearch)
Get advanced search URL.
|
String |
getAdvancedSearchUrl(PortalControllerContext portalControllerContext,
String search,
boolean advancedSearch,
Map<String,List<String>> selectors)
Get advanced search URL with prevalued selectors.
|
String |
getBackURL(PortalControllerContext portalControllerContext,
boolean mobile)
Get back URL.
|
String |
getBackURL(PortalControllerContext portalControllerContext,
boolean mobile,
boolean refresh)
Get back URL.
|
String |
getBasePortalUrl(PortalControllerContext portalControllerContext)
Get base portal URL.
|
String |
getCMSUrl(PortalControllerContext portalControllerContext,
String pagePath,
String cmsPath,
Map<String,String> pageParams,
String contextualization,
String displayContext,
String hideMetaDatas,
String scope,
String displayLiveVersion,
String windowPermReference)
Get CMS URL.
|
String |
getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext)
Get destroy current page URL.
|
String |
getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext,
String redirectionUrl)
Get destroy current page URL.
|
String |
getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext,
String redirectionUrl,
boolean closeChildren)
Get destroy current page URL.
|
String |
getDestroyPageUrl(PortalControllerContext portalControllerContext,
String pageId)
Get destroy page URL.
|
String |
getDestroyPageUrl(PortalControllerContext portalControllerContext,
String pageId,
boolean closeChildren)
Get destroy page URL.
|
String |
getDestroyPageUrl(PortalControllerContext portalControllerContext,
String parentId,
String pageId)
Deprecated.
remove useless attribute parentId
|
String |
getEcmCommandUrl(PortalControllerContext portalControllerContext,
String path,
EcmCommonCommands commandName)
Return an url who fire the ECM
|
String |
getEcmCommandUrl(PortalControllerContext portalControllerContext,
String path,
EcmCommonCommands commandName,
String redirectionPath)
Return an url who fire the ECM
|
String |
getEcmCommandUrl(PortalControllerContext portalControllerContext,
String path,
String commandName,
String redirectionPath)
Return an url who fire the ECM
|
String |
getEcmUrl(PortalControllerContext pcc,
EcmViews command,
String path,
Map<String,String> requestParameters)
Get an ECM URL (for front office views)
|
String |
getHomePageUrl(PortalControllerContext portalControllerContext,
boolean refresh)
Get home page URL.
|
String |
getHttpErrorUrl(PortalControllerContext portalControllerContext,
int httpErrorCode)
Get HTTP error page URL.
|
String |
getLoginUrl(PortalControllerContext portalControllerContext)
Get login URL.
|
String |
getParameterizedURL(PortalControllerContext portalControllerContext,
String cmsPath,
String template,
String renderset,
String layoutState,
Boolean permalinks)
Get parameterized URL.
|
String |
getPermaLink(PortalControllerContext portalControllerContext,
String permLinkRef,
Map<String,String> params,
String cmsPath,
String permLinkType)
Get permalink URL.
|
org.jboss.portal.core.model.portal.Page |
getPortalCMSContextualizedPage(PortalControllerContext portalControllerContext,
String path)
Get portal CMS contextualized page.
|
String |
getProfiledHomePageUrl(PortalControllerContext portalControllerContext)
Get profiled home page URL.
|
String |
getPutDocumentInTrashUrl(PortalControllerContext portalControllerContext,
String docId,
String docPath)
Get put document in trash URL.
|
String |
getRefreshPageUrl(PortalControllerContext portalControllerContext)
Get refresh page URL.
|
String |
getRefreshPageUrl(PortalControllerContext portalControllerContext,
boolean newContentNotify)
Get refresh page URL and notify creation of new content.
|
String |
getSharingLinkUrl(PortalControllerContext portalControllerContext,
String id)
Get sharing link URL.
|
String |
getStartPageUrl(PortalControllerContext portalControllerContext,
String pageName,
String templateName,
Map<String,String> props,
Map<String,String> params)
Get start page URL.
|
String |
getStartPageUrl(PortalControllerContext portalControllerContext,
String parentName,
String pageName,
String templateName,
Map<String,String> props,
Map<String,String> params)
Get start page URL.
|
String |
getStartPortletInNewPage(PortalControllerContext portalCtx,
String pageName,
String pageDisplayName,
String portletInstance,
Map<String,String> windowProperties,
Map<String,String> windowParams)
Gets the start portlet URL in new page.
|
String |
getStartPortletInRegionUrl(PortalControllerContext portalControllerContext,
String pageId,
String portletInstance,
String region,
String windowName,
Map<String,String> props,
Map<String,String> params)
Get start portlet in region URL.
|
String |
getStartPortletUrl(PortalControllerContext portalControllerContext,
String portletInstance,
Map<String,String> windowProperties)
Get start portlet URL.
|
String |
getStartPortletUrl(PortalControllerContext portalControllerContext,
String portletInstance,
Map<String,String> windowProperties,
boolean popup)
Deprecated.
see
|
String |
getStartPortletUrl(PortalControllerContext portalControllerContext,
String portletInstance,
Map<String,String> windowProperties,
PortalUrlType type)
Get start portlet URL.
|
String |
getStopPortletUrl(PortalControllerContext portalControllerContext,
String pageId,
String windowId)
Get stop portlet URL.
|
String |
getUserWorkspaceCommandUrl(PortalControllerContext portalControllerContext)
Get user workspace command URL
|
String |
getViewPageUrl(PortalControllerContext portalControllerContext,
String id)
Get view page URL.
|
static final String CONTEXTUALIZATION_PORTLET
static final String CONTEXTUALIZATION_PAGE
static final String CONTEXTUALIZATION_PORTAL
static final String PERM_LINK_TYPE_PAGE
static final String PERM_LINK_TYPE_RSS
static final String PERM_LINK_TYPE_RSS_PICTURE
static final String PERM_LINK_TYPE_CMS
static final String PERM_LINK_TYPE_SHARE
static final String PERM_LINK_TYPE_PORTLET_RESOURCE
static final int POPUP_URL_ADAPTER_OPEN
static final int POPUP_URL_ADAPTER_CLOSE
static final int POPUP_URL_ADAPTER_CLOSED_NOTIFICATION
static final String DISPLAYCTX_REFRESH
static final String DISPLAYCTX_PREVIEW_LIVE_VERSION
static final String MBEAN_NAME
org.jboss.portal.core.model.portal.Page getPortalCMSContextualizedPage(PortalControllerContext portalControllerContext, String path) throws PortalException
portalControllerContext - portal controller contextpath - pathExceptionPortalExceptionString getCMSUrl(PortalControllerContext portalControllerContext, String pagePath, String cmsPath, Map<String,String> pageParams, String contextualization, String displayContext, String hideMetaDatas, String scope, String displayLiveVersion, String windowPermReference)
portalControllerContext - portal controller contextpagePath - page pathcmsPath - CMS pathpageParams - page parameterscontextualization - contextualizationdisplayContext - display contexthideMetaDatas - hide meta datasscope - scopedisplayLiveVersion - display live versionwindowPermReference - window perm referenceString getPermaLink(PortalControllerContext portalControllerContext, String permLinkRef, Map<String,String> params, String cmsPath, String permLinkType) throws PortalException
portalControllerContext - portal controller contextpermLinkRef - permalink referenceparams - parameterscmsPath - CMS pathpermLinkType - permalink typePortalExceptionString getStartPageUrl(PortalControllerContext portalControllerContext, String parentName, String pageName, String templateName, Map<String,String> props, Map<String,String> params) throws PortalException
portalControllerContext - portal controller contextparentName - parent page namepageName - page nametemplateName - template nameprops - page propertiesparams - page parametersPortalExceptionString getStartPageUrl(PortalControllerContext portalControllerContext, String pageName, String templateName, Map<String,String> props, Map<String,String> params) throws PortalException
portalControllerContext - portal controller contextpageName - page nametemplateName - template nameprops - page propertiesparams - page parametersPortalException@Deprecated String getDestroyPageUrl(PortalControllerContext portalControllerContext, String parentId, String pageId)
portalControllerContext - portal controller contextparentId - parent identifierpageId - page identifierString getDestroyPageUrl(PortalControllerContext portalControllerContext, String pageId)
portalControllerContext - portal controller contextpageId - page identifierString getDestroyPageUrl(PortalControllerContext portalControllerContext, String pageId, boolean closeChildren)
portalControllerContext - portal controller contextpageId - page identifiercloseChildren - close children indicatorString getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext) throws PortalException
portalControllerContext - portal controller contextPortalExceptionString getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext, String redirectionUrl) throws PortalException
portalControllerContext - portal controller contextredirectionUrl - redirection URLPortalExceptionString getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext, String redirectionUrl, boolean closeChildren) throws PortalException
portalControllerContext - portal controller contextredirectionUrl - redirection URLcloseChildren - close children indicatorPortalExceptionString adaptPortalUrlToNavigation(PortalControllerContext portalControllerContext, String originalUrl)
portalControllerContext - portal controller contextoriginalUrl - original URLString adaptPortalUrlToPopup(PortalControllerContext portalControllerContext, String originalUrl, int adapter)
portalControllerContext - portal controller contextoriginalUrl - original URLadapter - adapter status code@Deprecated String getStartPortletUrl(PortalControllerContext portalControllerContext, String portletInstance, Map<String,String> windowProperties, boolean popup) throws PortalException
portalControllerContext - portal controller contextportletInstance - portlet instancewindowProperties - window propertiespopup - popup indicatorPortalExceptionString getStartPortletUrl(PortalControllerContext portalControllerContext, String portletInstance, Map<String,String> windowProperties) throws PortalException
portalControllerContext - portal controller contextportletInstance - portlet instancewindowProperties - window propertiesPortalExceptionString getStartPortletUrl(PortalControllerContext portalControllerContext, String portletInstance, Map<String,String> windowProperties, PortalUrlType type) throws PortalException
portalControllerContext - portal controller contextportletInstance - portlet instancewindowProperties - window propertiestype - portal URL typePortalExceptionString getStartPortletInNewPage(PortalControllerContext portalCtx, String pageName, String pageDisplayName, String portletInstance, Map<String,String> windowProperties, Map<String,String> windowParams) throws PortalException
portalCtx - the portal ctxpageName - the page name (assumes the unicity of the page)pageDisplayName - the page display nameportletInstance - the portlet instancewindowProperties - the window propertieswindowParams - the window parametersPortalExceptionString getStartPortletInRegionUrl(PortalControllerContext portalControllerContext, String pageId, String portletInstance, String region, String windowName, Map<String,String> props, Map<String,String> params)
portalControllerContext - portal controller contextpageId - page identifierportletInstance - portlet instanceregion - target region namewindowName - window nameprops - window propertiesparams - window parametersString getStopPortletUrl(PortalControllerContext portalControllerContext, String pageId, String windowId)
portalControllerContext - portal controller contextpageId - page identifierwindowId - window identifierString getBasePortalUrl(PortalControllerContext portalControllerContext)
portalControllerContext - portal controller contextString getRefreshPageUrl(PortalControllerContext portalControllerContext)
portalControllerContext - portal controller contextString getRefreshPageUrl(PortalControllerContext portalControllerContext, boolean newContentNotify)
portalControllerContext - portal controller contextnewContentNotify - set to true for enable notifications after this commandString getPutDocumentInTrashUrl(PortalControllerContext portalControllerContext, String docId, String docPath)
portalControllerContext - portal controller contextdocId - document identifierdocPath - document pathString getHttpErrorUrl(PortalControllerContext portalControllerContext, int httpErrorCode)
portalControllerContext - portal controller contexthttpErrorCode - HTTP error code (example : 404)String getEcmUrl(PortalControllerContext pcc, EcmViews command, String path, Map<String,String> requestParameters) throws PortalException
pcc - portal controller contextcommand - the name of the command (create document, view, ...) managed by the ecmpath - path of the documentrequestParameters - params added in the http urlPortalExceptionString getBackURL(PortalControllerContext portalControllerContext, boolean mobile)
portalControllerContext - portal controller contextmobile - mobile indicatorString getBackURL(PortalControllerContext portalControllerContext, boolean mobile, boolean refresh)
portalControllerContext - portal controller contextmobile - mobile indicatorrefresh - refresh indicatorString getParameterizedURL(PortalControllerContext portalControllerContext, String cmsPath, String template, String renderset, String layoutState, Boolean permalinks)
portalControllerContext - portal controller contextcmsPath - CMS pathtemplate - template, may be nullrenderset - renderset, may be nulllayoutState - layout state, may be nullpermalinks - permalinks indicator, may be nullString getEcmCommandUrl(PortalControllerContext portalControllerContext, String path, EcmCommonCommands commandName) throws PortalException
portalControllerContext - path - commandName - PortalExceptionString getEcmCommandUrl(PortalControllerContext portalControllerContext, String path, EcmCommonCommands commandName, String redirectionPath) throws PortalException
portalControllerContext - path - redirectionPath - commandName - PortalExceptionString getEcmCommandUrl(PortalControllerContext portalControllerContext, String path, String commandName, String redirectionPath) throws PortalException
portalControllerContext - path - param - redirectionPathcommandName - PortalExceptionString getHomePageUrl(PortalControllerContext portalControllerContext, boolean refresh) throws PortalException
portalControllerContext - portal controller contextrefresh - refresh page indicatorPortalExceptionString getProfiledHomePageUrl(PortalControllerContext portalControllerContext) throws PortalException
portalControllerContext - portal controller contextPortalExceptionString getViewPageUrl(PortalControllerContext portalControllerContext, String id) throws PortalException
portalControllerContext - portal controller contextid - page identifierPortalExceptionString getSharingLinkUrl(PortalControllerContext portalControllerContext, String id) throws javax.portlet.PortletException
portalControllerContext - portal controller contextid - link identifierjavax.portlet.PortletExceptionString getAdvancedSearchUrl(PortalControllerContext portalControllerContext, String search, boolean advancedSearch) throws PortalException
portalControllerContext - portal controller contextsearch - search queryadvancedSearch - advanced search indicatorPortalExceptionString getAdvancedSearchUrl(PortalControllerContext portalControllerContext, String search, boolean advancedSearch, Map<String,List<String>> selectors) throws PortalException
portalControllerContext - portal controller contextsearch - search queryadvancedSearch - advanced search indicatorselector - selectorsPortalExceptionString getUserWorkspaceCommandUrl(PortalControllerContext portalControllerContext) throws PortalException
portalControllerContext - portal controller contextPortalExceptionString getLoginUrl(PortalControllerContext portalControllerContext) throws PortalException
portalControllerContext - portal controller contextPortalExceptionCopyright © 2021. All rights reserved.