org.osivia.portal.api.urls

Interface IPortalUrlFactory

public interface IPortalUrlFactory

Portal URL factory API interface.

Author:

Jean-Sébastien Steux

Field Summary

Fields

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.

Method Summary

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.

Field Detail

CONTEXTUALIZATION_PORTLET

static final String CONTEXTUALIZATION_PORTLET

Contextualization type "portlet".

See Also:

Constant Field Values

CONTEXTUALIZATION_PAGE

static final String CONTEXTUALIZATION_PAGE

Contextualization type "page".

See Also:

Constant Field Values

CONTEXTUALIZATION_PORTAL

static final String CONTEXTUALIZATION_PORTAL

Contextualization type "portal".

See Also:

Constant Field Values

PERM_LINK_TYPE_PAGE

static final String PERM_LINK_TYPE_PAGE

Permalink type "page".

See Also:

Constant Field Values

PERM_LINK_TYPE_RSS

static final String PERM_LINK_TYPE_RSS

Permalink type "RSS".

See Also:

Constant Field Values

PERM_LINK_TYPE_RSS_PICTURE

static final String PERM_LINK_TYPE_RSS_PICTURE

Permalink type "RSS picture".

See Also:

Constant Field Values

PERM_LINK_TYPE_CMS

static final String PERM_LINK_TYPE_CMS

Permalink type "CMS".

See Also:

Constant Field Values

PERM_LINK_TYPE_SHARE

static final String PERM_LINK_TYPE_SHARE

Permalink type share.

See Also:

Constant Field Values

PERM_LINK_TYPE_PORTLET_RESOURCE

static final String PERM_LINK_TYPE_PORTLET_RESOURCE

Permalink type portlet resource.

See Also:

Constant Field Values

POPUP_URL_ADAPTER_OPEN

static final int POPUP_URL_ADAPTER_OPEN

Popup URL adapter open status.

See Also:

Constant Field Values

POPUP_URL_ADAPTER_CLOSE

static final int POPUP_URL_ADAPTER_CLOSE

Popup URL adapter close status.

See Also:

Constant Field Values

POPUP_URL_ADAPTER_CLOSED_NOTIFICATION

static final int POPUP_URL_ADAPTER_CLOSED_NOTIFICATION

Popup URL adapter closed notification status.

See Also:

Constant Field Values

DISPLAYCTX_REFRESH

static final String DISPLAYCTX_REFRESH

Display context refresh.

See Also:

Constant Field Values

DISPLAYCTX_PREVIEW_LIVE_VERSION

static final String DISPLAYCTX_PREVIEW_LIVE_VERSION

Display context preview (live version for validation purpose).

See Also:

Constant Field Values

MBEAN_NAME

static final String MBEAN_NAME

See Also:

Constant Field Values

Method Detail

getPortalCMSContextualizedPage

org.jboss.portal.core.model.portal.Page getPortalCMSContextualizedPage(PortalControllerContext portalControllerContext,
                                                                       String path)
                                                                throws PortalException

Get portal CMS contextualized page. TODO: move it in CMS.

Parameters:

portalControllerContext - portal controller context

path - path

Returns:

contextualized page

Throws:

Exception

PortalException

getCMSUrl

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.

Parameters:

portalControllerContext - portal controller context

pagePath - page path

cmsPath - CMS path

pageParams - page parameters

contextualization - contextualization

displayContext - display context

hideMetaDatas - hide meta datas

scope - scope

displayLiveVersion - display live version

windowPermReference - window perm reference

Returns:

CMS url

getPermaLink

String getPermaLink(PortalControllerContext portalControllerContext,
                    String permLinkRef,
                    Map<String,String> params,
                    String cmsPath,
                    String permLinkType)
             throws PortalException

Get permalink URL.

Parameters:

portalControllerContext - portal controller context

permLinkRef - permalink reference

params - parameters

cmsPath - CMS path

permLinkType - permalink type

Returns:

permalink URL

Throws:

PortalException

getStartPageUrl

String getStartPageUrl(PortalControllerContext portalControllerContext,
                       String parentName,
                       String pageName,
                       String templateName,
                       Map<String,String> props,
                       Map<String,String> params)
                throws PortalException

Get start page URL.

Parameters:

portalControllerContext - portal controller context

parentName - parent page name

pageName - page name

templateName - template name

props - page properties

params - page parameters

Returns:

start page URL

Throws:

PortalException

getStartPageUrl

String getStartPageUrl(PortalControllerContext portalControllerContext,
                       String pageName,
                       String templateName,
                       Map<String,String> props,
                       Map<String,String> params)
                throws PortalException

Get start page URL.

Parameters:

portalControllerContext - portal controller context

pageName - page name

templateName - template name

props - page properties

params - page parameters

Returns:

start page URL

Throws:

PortalException

getDestroyPageUrl

@Deprecated
String getDestroyPageUrl(PortalControllerContext portalControllerContext,
                                     String parentId,
                                     String pageId)

Deprecated. remove useless attribute parentId

Get destroy page URL.

Parameters:

portalControllerContext - portal controller context

parentId - parent identifier

pageId - page identifier

Returns:

destroy page URL

getDestroyPageUrl

String getDestroyPageUrl(PortalControllerContext portalControllerContext,
                         String pageId)

Get destroy page URL.

Parameters:

portalControllerContext - portal controller context

pageId - page identifier

Returns:

URL

getDestroyPageUrl

String getDestroyPageUrl(PortalControllerContext portalControllerContext,
                         String pageId,
                         boolean closeChildren)

Get destroy page URL.

Parameters:

portalControllerContext - portal controller context

pageId - page identifier

closeChildren - close children indicator

Returns:

URL

getDestroyCurrentPageUrl

String getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext)
                         throws PortalException

Get destroy current page URL.

Parameters:

portalControllerContext - portal controller context

Returns:

URL

Throws:

PortalException

getDestroyCurrentPageUrl

String getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext,
                                String redirectionUrl)
                         throws PortalException

Get destroy current page URL.

Parameters:

portalControllerContext - portal controller context

redirectionUrl - redirection URL

Returns:

URL

Throws:

PortalException

getDestroyCurrentPageUrl

String getDestroyCurrentPageUrl(PortalControllerContext portalControllerContext,
                                String redirectionUrl,
                                boolean closeChildren)
                         throws PortalException

Get destroy current page URL.

Parameters:

portalControllerContext - portal controller context

redirectionUrl - redirection URL

closeChildren - close children indicator

Returns:

URL

Throws:

PortalException

adaptPortalUrlToNavigation

String adaptPortalUrlToNavigation(PortalControllerContext portalControllerContext,
                                  String originalUrl)

Adapt portal URL to navigation.

Parameters:

portalControllerContext - portal controller context

originalUrl - original URL

Returns:

navigation URL

adaptPortalUrlToPopup

String adaptPortalUrlToPopup(PortalControllerContext portalControllerContext,
                             String originalUrl,
                             int adapter)

Adapt portal URL to popup.

Parameters:

portalControllerContext - portal controller context

originalUrl - original URL

adapter - adapter status code

Returns:

popup URL

getStartPortletUrl

@Deprecated
String getStartPortletUrl(PortalControllerContext portalControllerContext,
                                      String portletInstance,
                                      Map<String,String> windowProperties,
                                      boolean popup)
                               throws PortalException

Deprecated. see

Get start portlet URL.

Parameters:

portalControllerContext - portal controller context

portletInstance - portlet instance

windowProperties - window properties

popup - popup indicator

Returns:

start portlet URL

Throws:

PortalException

getStartPortletUrl

String getStartPortletUrl(PortalControllerContext portalControllerContext,
                          String portletInstance,
                          Map<String,String> windowProperties)
                   throws PortalException

Get start portlet URL.

Parameters:

portalControllerContext - portal controller context

portletInstance - portlet instance

windowProperties - window properties

Returns:

URL

Throws:

PortalException

getStartPortletUrl

String getStartPortletUrl(PortalControllerContext portalControllerContext,
                          String portletInstance,
                          Map<String,String> windowProperties,
                          PortalUrlType type)
                   throws PortalException

Get start portlet URL.

Parameters:

portalControllerContext - portal controller context

portletInstance - portlet instance

windowProperties - window properties

type - portal URL type

Returns:

URL

Throws:

PortalException

getStartPortletInNewPage

String getStartPortletInNewPage(PortalControllerContext portalCtx,
                                String pageName,
                                String pageDisplayName,
                                String portletInstance,
                                Map<String,String> windowProperties,
                                Map<String,String> windowParams)
                         throws PortalException

Gets the start portlet URL in new page.

Parameters:

portalCtx - the portal ctx

pageName - the page name (assumes the unicity of the page)

pageDisplayName - the page display name

portletInstance - the portlet instance

windowProperties - the window properties

windowParams - the window parameters

Returns:

the start portlet in new page

Throws:

PortalException

getStartPortletInRegionUrl

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.

Parameters:

portalControllerContext - portal controller context

pageId - page identifier

portletInstance - portlet instance

region - target region name

windowName - window name

props - window properties

params - window parameters

Returns:

start portlet URL

getStopPortletUrl

String getStopPortletUrl(PortalControllerContext portalControllerContext,
                         String pageId,
                         String windowId)

Get stop portlet URL.

Parameters:

portalControllerContext - portal controller context

pageId - page identifier

windowId - window identifier

Returns:

stop portlet URL

getBasePortalUrl

String getBasePortalUrl(PortalControllerContext portalControllerContext)

Get base portal URL.

Parameters:

portalControllerContext - portal controller context

Returns:

base portal URL

getRefreshPageUrl

String getRefreshPageUrl(PortalControllerContext portalControllerContext)

Get refresh page URL.

Parameters:

portalControllerContext - portal controller context

Returns:

refresh page URL

getRefreshPageUrl

String getRefreshPageUrl(PortalControllerContext portalControllerContext,
                         boolean newContentNotify)

Get refresh page URL and notify creation of new content.

Parameters:

portalControllerContext - portal controller context

newContentNotify - set to true for enable notifications after this command

Returns:

refresh page URL

getPutDocumentInTrashUrl

String getPutDocumentInTrashUrl(PortalControllerContext portalControllerContext,
                                String docId,
                                String docPath)

Get put document in trash URL.

Parameters:

portalControllerContext - portal controller context

docId - document identifier

docPath - document path

Returns:

put document in trash URL

getHttpErrorUrl

String getHttpErrorUrl(PortalControllerContext portalControllerContext,
                       int httpErrorCode)

Get HTTP error page URL.

Parameters:

portalControllerContext - portal controller context

httpErrorCode - HTTP error code (example : 404)

Returns:

HTTP error page URL

getEcmUrl

String getEcmUrl(PortalControllerContext pcc,
                 EcmViews command,
                 String path,
                 Map<String,String> requestParameters)
          throws PortalException

Get an ECM URL (for front office views)

Parameters:

pcc - portal controller context

command - the name of the command (create document, view, ...) managed by the ecm

path - path of the document

requestParameters - params added in the http url

Returns:

the url

Throws:

PortalException

getBackURL

String getBackURL(PortalControllerContext portalControllerContext,
                  boolean mobile)

Get back URL.

Parameters:

portalControllerContext - portal controller context

mobile - mobile indicator

Returns:

back URL

getBackURL

String getBackURL(PortalControllerContext portalControllerContext,
                  boolean mobile,
                  boolean refresh)

Get back URL.

Parameters:

portalControllerContext - portal controller context

mobile - mobile indicator

refresh - refresh indicator

Returns:

back URL

getParameterizedURL

String getParameterizedURL(PortalControllerContext portalControllerContext,
                           String cmsPath,
                           String template,
                           String renderset,
                           String layoutState,
                           Boolean permalinks)

Get parameterized URL.

Parameters:

portalControllerContext - portal controller context

cmsPath - CMS path

template - template, may be null

renderset - renderset, may be null

layoutState - layout state, may be null

permalinks - permalinks indicator, may be null

Returns:

parameterized URL

getEcmCommandUrl

String getEcmCommandUrl(PortalControllerContext portalControllerContext,
                        String path,
                        EcmCommonCommands commandName)
                 throws PortalException

Return an url who fire the ECM

Parameters:

portalControllerContext -

path -

commandName -

Returns:

the url

Throws:

PortalException

getEcmCommandUrl

String getEcmCommandUrl(PortalControllerContext portalControllerContext,
                        String path,
                        EcmCommonCommands commandName,
                        String redirectionPath)
                 throws PortalException

Return an url who fire the ECM

Parameters:

portalControllerContext -

path -

redirectionPath -

commandName -

Returns:

the url

Throws:

PortalException

getEcmCommandUrl

String getEcmCommandUrl(PortalControllerContext portalControllerContext,
                        String path,
                        String commandName,
                        String redirectionPath)
                 throws PortalException

Return an url who fire the ECM

Parameters:

portalControllerContext -

path -

param - redirectionPath

commandName -

Returns:

the url

Throws:

PortalException

getHomePageUrl

String getHomePageUrl(PortalControllerContext portalControllerContext,
                      boolean refresh)
               throws PortalException

Get home page URL.

Parameters:

portalControllerContext - portal controller context

refresh - refresh page indicator

Returns:

URL

Throws:

PortalException

getProfiledHomePageUrl

String getProfiledHomePageUrl(PortalControllerContext portalControllerContext)
                       throws PortalException

Get profiled home page URL.

Parameters:

portalControllerContext - portal controller context

Returns:

URL

Throws:

PortalException

getViewPageUrl

String getViewPageUrl(PortalControllerContext portalControllerContext,
                      String id)
               throws PortalException

Get view page URL.

Parameters:

portalControllerContext - portal controller context

id - page identifier

Returns:

URL

Throws:

PortalException

getSharingLinkUrl

String getSharingLinkUrl(PortalControllerContext portalControllerContext,
                         String id)
                  throws javax.portlet.PortletException

Get sharing link URL.

Parameters:

portalControllerContext - portal controller context

id - link identifier

Returns:

URL

Throws:

javax.portlet.PortletException

getAdvancedSearchUrl

String getAdvancedSearchUrl(PortalControllerContext portalControllerContext,
                            String search,
                            boolean advancedSearch)
                     throws PortalException

Get advanced search URL.

Parameters:

portalControllerContext - portal controller context

search - search query

advancedSearch - advanced search indicator

Returns:

Throws:

PortalException

getAdvancedSearchUrl

String getAdvancedSearchUrl(PortalControllerContext portalControllerContext,
                            String search,
                            boolean advancedSearch,
                            Map<String,List<String>> selectors)
                     throws PortalException

Get advanced search URL with prevalued selectors.

Parameters:

portalControllerContext - portal controller context

search - search query

advancedSearch - advanced search indicator

selector - selectors

Returns:

Throws:

PortalException

getUserWorkspaceCommandUrl

String getUserWorkspaceCommandUrl(PortalControllerContext portalControllerContext)
                           throws PortalException

Get user workspace command URL

Parameters:

portalControllerContext - portal controller context

Returns:

URL

Throws:

PortalException

getLoginUrl

String getLoginUrl(PortalControllerContext portalControllerContext)
            throws PortalException

Get login URL.

Parameters:

portalControllerContext - portal controller context

Returns:

URL

Throws:

PortalException