org.osivia.portal.api.urls
Interface IPortalUrlFactory

public interface IPortalUrlFactory

Portal URL factory API interface.

Author:

Jean-Sébastien Steux

Field Summary

static java.lang.String	CONTEXTUALIZATION_PAGE Contextualization type "page".
static java.lang.String	CONTEXTUALIZATION_PORTAL Contextualization type "portal".
static java.lang.String	CONTEXTUALIZATION_PORTLET Contextualization type "portlet".
static java.lang.String	DISPLAYCTX_REFRESH Display context refresh.
static java.lang.String	PERM_LINK_TYPE_CMS Permalink type "CMS".
static java.lang.String	PERM_LINK_TYPE_PAGE Permalink type "page".
static java.lang.String	PERM_LINK_TYPE_RSS Permalink type "RSS".
static java.lang.String	PERM_LINK_TYPE_RSS_PICTURE Permalink type "RSS picture".
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

java.lang.String	adaptPortalUrlToNavigation(PortalControllerContext portalControllerContext, java.lang.String orginalUrl) Adapt portal URL to navigation.
java.lang.String	adaptPortalUrlToPopup(PortalControllerContext portalControllerContext, java.lang.String orginalUrl, int adapter) Adapt portal URL to popup.
java.lang.String	getBasePortalUrl(PortalControllerContext portalControllerContext) Get base portal URL.
java.lang.String	getCMSUrl(PortalControllerContext portalControllerContext, java.lang.String pagePath, java.lang.String cmsPath, java.util.Map<java.lang.String,java.lang.String> pageParams, java.lang.String contextualization, java.lang.String displayContext, java.lang.String hideMetaDatas, java.lang.String scope, java.lang.String displayLiveVersion, java.lang.String windowPermReference) Get CMS URL.
java.lang.String	getDestroyPageUrl(PortalControllerContext portalControllerContext, java.lang.String parentId, java.lang.String pageId) Get destroy page URL.
java.lang.String	getHttpErrorUrl(PortalControllerContext portalControllerContext, int httpErrorCode) Get HTTP error page URL.
java.lang.String	getPermaLink(PortalControllerContext portalControllerContext, java.lang.String permLinkRef, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String cmsPath, java.lang.String permLinkType) Get permalink URL.
org.jboss.portal.core.model.portal.Page	getPortalCMSContextualizedPage(PortalControllerContext portalControllerContext, java.lang.String path) Get portal CMS contextualized page.
java.lang.String	getPutDocumentInTrashUrl(PortalControllerContext portalControllerContext, java.lang.String docId, java.lang.String docPath) Get put document in trash URL.
java.lang.String	getRefreshPageUrl(PortalControllerContext portalControllerContext) Get refresh page URL.
java.lang.String	getStartPageUrl(PortalControllerContext portalControllerContext, java.lang.String pageName, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,java.lang.String> params) Get start page URL.
java.lang.String	getStartPageUrl(PortalControllerContext portalControllerContext, java.lang.String parentName, java.lang.String pageName, java.lang.String templateName, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,java.lang.String> params) Get start page URL.
java.lang.String	getStartPortletInRegionUrl(PortalControllerContext portalControllerContext, java.lang.String pageId, java.lang.String portletInstance, java.lang.String region, java.lang.String windowName, java.util.Map<java.lang.String,java.lang.String> props, java.util.Map<java.lang.String,java.lang.String> params) Get start portlet in region URL.
java.lang.String	getStartPortletUrl(PortalControllerContext portalControllerContext, java.lang.String portletInstance, java.util.Map<java.lang.String,java.lang.String> windowProperties, java.util.Map<java.lang.String,java.lang.String> params, boolean popup) Get start portlet URL.
java.lang.String	getStopPortletUrl(PortalControllerContext portalControllerContext, java.lang.String pageId, java.lang.String windowId) Get stop portlet URL.

Field Detail

CONTEXTUALIZATION_PORTLET

static final java.lang.String CONTEXTUALIZATION_PORTLET

Contextualization type "portlet".

See Also:

Constant Field Values

CONTEXTUALIZATION_PAGE

static final java.lang.String CONTEXTUALIZATION_PAGE

Contextualization type "page".

See Also:

Constant Field Values

CONTEXTUALIZATION_PORTAL

static final java.lang.String CONTEXTUALIZATION_PORTAL

Contextualization type "portal".

See Also:

Constant Field Values

PERM_LINK_TYPE_PAGE

static final java.lang.String PERM_LINK_TYPE_PAGE

Permalink type "page".

See Also:

Constant Field Values

PERM_LINK_TYPE_RSS

static final java.lang.String PERM_LINK_TYPE_RSS

Permalink type "RSS".

See Also:

Constant Field Values

PERM_LINK_TYPE_RSS_PICTURE

static final java.lang.String PERM_LINK_TYPE_RSS_PICTURE

Permalink type "RSS picture".

See Also:

Constant Field Values

PERM_LINK_TYPE_CMS

static final java.lang.String PERM_LINK_TYPE_CMS

Permalink type "CMS".

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 java.lang.String DISPLAYCTX_REFRESH

Display context refresh.

See Also:

Constant Field Values

Method Detail

getPortalCMSContextualizedPage

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

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

Parameters:

portalControllerContext - portal controller context

path - path

Returns:

contextualized page

Throws:

java.lang.Exception

getCMSUrl

java.lang.String getCMSUrl(PortalControllerContext portalControllerContext,
                           java.lang.String pagePath,
                           java.lang.String cmsPath,
                           java.util.Map<java.lang.String,java.lang.String> pageParams,
                           java.lang.String contextualization,
                           java.lang.String displayContext,
                           java.lang.String hideMetaDatas,
                           java.lang.String scope,
                           java.lang.String displayLiveVersion,
                           java.lang.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

java.lang.String getPermaLink(PortalControllerContext portalControllerContext,
                              java.lang.String permLinkRef,
                              java.util.Map<java.lang.String,java.lang.String> params,
                              java.lang.String cmsPath,
                              java.lang.String permLinkType)
                              throws java.lang.Exception

Get permalink URL.

Parameters:

portalControllerContext - portal controller context

permLinkRef - permalink reference

params - parameters

cmsPath - CMS path

permLinkType - permalink type

Returns:

permalink URL

Throws:

java.lang.Exception

getStartPageUrl

java.lang.String getStartPageUrl(PortalControllerContext portalControllerContext,
                                 java.lang.String parentName,
                                 java.lang.String pageName,
                                 java.lang.String templateName,
                                 java.util.Map<java.lang.String,java.lang.String> props,
                                 java.util.Map<java.lang.String,java.lang.String> params)
                                 throws java.lang.Exception

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:

java.lang.Exception

getStartPageUrl

java.lang.String getStartPageUrl(PortalControllerContext portalControllerContext,
                                 java.lang.String pageName,
                                 java.lang.String templateName,
                                 java.util.Map<java.lang.String,java.lang.String> props,
                                 java.util.Map<java.lang.String,java.lang.String> params)
                                 throws java.lang.Exception

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:

java.lang.Exception

getDestroyPageUrl

java.lang.String getDestroyPageUrl(PortalControllerContext portalControllerContext,
                                   java.lang.String parentId,
                                   java.lang.String pageId)

Get destroy page URL.

Parameters:

portalControllerContext - portal controller context

parentId - parent identifier

pageId - page identifier

Returns:

destroy page URL

adaptPortalUrlToNavigation

java.lang.String adaptPortalUrlToNavigation(PortalControllerContext portalControllerContext,
                                            java.lang.String orginalUrl)
                                            throws java.lang.Exception

Adapt portal URL to navigation.

Parameters:

portalControllerContext - portal controller context

orginalUrl - original URL

Returns:

navigation URL

Throws:

java.lang.Exception

adaptPortalUrlToPopup

java.lang.String adaptPortalUrlToPopup(PortalControllerContext portalControllerContext,
                                       java.lang.String orginalUrl,
                                       int adapter)

Adapt portal URL to popup.

Parameters:

portalControllerContext - portal controller context

orginalUrl - original URL

adapter - adapter status code

Returns:

popup URL

getStartPortletUrl

java.lang.String getStartPortletUrl(PortalControllerContext portalControllerContext,
                                    java.lang.String portletInstance,
                                    java.util.Map<java.lang.String,java.lang.String> windowProperties,
                                    java.util.Map<java.lang.String,java.lang.String> params,
                                    boolean popup)
                                    throws java.lang.Exception

Get start portlet URL.

Parameters:

portalControllerContext - portal controller context

portletInstance - portlet instance

windowProperties - window properties

params - window parameters

popup - popup indicator

Returns:

start portlet URL

Throws:

java.lang.Exception

getStartPortletInRegionUrl

java.lang.String getStartPortletInRegionUrl(PortalControllerContext portalControllerContext,
                                            java.lang.String pageId,
                                            java.lang.String portletInstance,
                                            java.lang.String region,
                                            java.lang.String windowName,
                                            java.util.Map<java.lang.String,java.lang.String> props,
                                            java.util.Map<java.lang.String,java.lang.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

java.lang.String getStopPortletUrl(PortalControllerContext portalControllerContext,
                                   java.lang.String pageId,
                                   java.lang.String windowId)

Get stop portlet URL.

Parameters:

portalControllerContext - portal controller context

pageId - page identifier

windowId - window identifier

Returns:

stop portlet URL

getBasePortalUrl

java.lang.String getBasePortalUrl(PortalControllerContext portalControllerContext)

Get base portal URL.

Parameters:

portalControllerContext - portal controller context

Returns:

base portal URL

getRefreshPageUrl

java.lang.String getRefreshPageUrl(PortalControllerContext portalControllerContext)

Get refresh page URL.

Parameters:

portalControllerContext - portal controller context

Returns:

refresh page URL

getPutDocumentInTrashUrl

java.lang.String getPutDocumentInTrashUrl(PortalControllerContext portalControllerContext,
                                          java.lang.String docId,
                                          java.lang.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

java.lang.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