Package lumis.portal.presentation

Class PresentationManager

java.lang.Object

lumis.portal.presentation.PresentationManager

All Implemented Interfaces:

IPresentationManager, IPresentationManagerSPI

public class PresentationManager
extends java.lang.Object
implements IPresentationManagerSPI

Presentation manager implemetation.

Since:

4.0.0

Version:

$Revision: 25022 $ $Date: 2022-05-25 11:56:35 -0300 (Wed, 25 May 2022) $

Field Summary

Fields inherited from interface lumis.portal.presentation.IPresentationManager

PROPERTY_PRESENTATION_OUTPUT_DATE_TIME, PROPERTY_PRESENTATION_OUTPUT_SERVER_ID

Constructor Summary

Constructors

Constructor	Description
PresentationManager()

Method Summary

Modifier and Type	Method	Description
void	clearChannelHtmlProcessorsCache(java.lang.String channelId)	Clears the IHtmlProcessor cache.
void	clearHtmlProcessorsCache()	Clears all HTML processor cache.
void	clearServiceInstanceHtmlProcessorsCache(java.lang.String serviceInstanceId)	Clears the IHtmlProcessor cache.
java.util.List<java.lang.String>	getAdministrationBarChannelIds(SessionConfig sessionConfig, ITransaction transaction)	Get the Ids of the administration bar of the Channel.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, java.lang.String website, int mode, PortalRequestContext requestContext, ITransaction transaction)	Deprecated.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, java.lang.String website, int mode, ITransaction daoTransaction)	Deprecated.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, int mode, ITransaction daoTransaction)	Get the default Page.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, IPortalMode mode, PortalRequestContext requestContext, boolean fallbackToFirstWebsitePage, ITransaction transaction)	Get the default Page.
PageConfig	getDefaultPage(SessionConfig sessionConfig, java.lang.String pageId, java.lang.String channelId, IWebsiteBaseURL websiteBaseURL, IPortalMode mode, PortalRequestContext requestContext, ITransaction transaction)	Get the default Page.
java.util.List<IHtmlProcessor>	getProcessors(PageWebResource webResource)	Returns a list with the HTML processors for the given web resource.
void	resetAdministrationBarChannelIds()	Reset the administration bar of the Channel.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PresentationManager

public PresentationManager()

Method Detail

getDefaultPage

@Deprecated
public PageConfig getDefaultPage(SessionConfig sessionConfig,
                                 java.lang.String pageId,
                                 java.lang.String channelId,
                                 java.lang.String website,
                                 int mode,
                                 PortalRequestContext requestContext,
                                 ITransaction transaction)
                          throws ManagerException,
                                 PortalException

Deprecated.

Description copied from interface: IPresentationManagerSPI

Get the default Page.

Specified by:

getDefaultPage in interface IPresentationManagerSPI

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

website - the website base URL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

transaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException

ManagerException

getDefaultPage

public PageConfig getDefaultPage(SessionConfig sessionConfig,
                                 java.lang.String pageId,
                                 java.lang.String channelId,
                                 IWebsiteBaseURL websiteBaseURL,
                                 IPortalMode mode,
                                 PortalRequestContext requestContext,
                                 ITransaction transaction)
                          throws ManagerException,
                                 PortalException

Description copied from interface: IPresentationManagerSPI

Get the default Page.

Specified by:

getDefaultPage in interface IPresentationManagerSPI

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

transaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException

ManagerException

getDefaultPage

public PageConfig getDefaultPage(SessionConfig sessionConfig,
                                 java.lang.String pageId,
                                 java.lang.String channelId,
                                 IWebsiteBaseURL websiteBaseURL,
                                 IPortalMode mode,
                                 PortalRequestContext requestContext,
                                 boolean fallbackToFirstWebsitePage,
                                 ITransaction transaction)
                          throws ManagerException,
                                 PortalException

Description copied from interface: IPresentationManagerSPI

Get the default Page.

Specified by:

getDefaultPage in interface IPresentationManagerSPI

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

mode - the current portal mode.

requestContext - the portal request context map.

fallbackToFirstWebsitePage - if true, will try to fallback to first website's page if pageId and channelId not specified and no applicable PageLinkConfig exists; otherwise will return null.

transaction - the current transaction.

Returns:

the default page, or null if it was not found.

Throws:

ManagerException

PortalException

getAdministrationBarChannelIds

public java.util.List<java.lang.String> getAdministrationBarChannelIds(SessionConfig sessionConfig,
                                                                       ITransaction transaction)
                                                                throws PortalException

Description copied from interface: IPresentationManager

Get the Ids of the administration bar of the Channel.

Specified by:

getAdministrationBarChannelIds in interface IPresentationManager

Returns:

Returns the administrationBarChannelConfigs.

Throws:

PortalException

resetAdministrationBarChannelIds

public void resetAdministrationBarChannelIds()

Description copied from interface: IPresentationManager

Reset the administration bar of the Channel.

Specified by:

resetAdministrationBarChannelIds in interface IPresentationManager

getDefaultPage

@Deprecated
public PageConfig getDefaultPage(SessionConfig sessionConfig,
                                 java.lang.String pageId,
                                 java.lang.String channelId,
                                 java.lang.String website,
                                 int mode,
                                 ITransaction daoTransaction)
                          throws ManagerException,
                                 PortalException

Deprecated.

Description copied from interface: IPresentationManager

Get the default Page.

Specified by:

getDefaultPage in interface IPresentationManager

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

website - the website base URL that the user is accessing.

mode - the current portal mode.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException - if any error occurs during the processing

ManagerException

getDefaultPage

public PageConfig getDefaultPage(SessionConfig sessionConfig,
                                 java.lang.String pageId,
                                 java.lang.String channelId,
                                 IWebsiteBaseURL websiteBaseURL,
                                 int mode,
                                 ITransaction daoTransaction)
                          throws ManagerException,
                                 PortalException

Description copied from interface: IPresentationManager

Get the default Page.

Specified by:

getDefaultPage in interface IPresentationManager

Parameters:

sessionConfig - the session identifier of the current user.

pageId - The destination page identifier.

channelId - The destination channel identifier.

websiteBaseURL - the IWebsiteBaseURL that the user is accessing.

mode - the current portal mode.

daoTransaction - the current transaction.

Returns:

a PageConfig.

Throws:

PortalException - if any error occurs during the processing.

ManagerException

getProcessors

public java.util.List<IHtmlProcessor> getProcessors(PageWebResource webResource)
                                             throws PortalException

Description copied from interface: IPresentationManagerSPI

Returns a list with the HTML processors for the given web resource. Based on the given resource, collect all service instances that belongs to services that has HMTL processors and order them by priority.

Specified by:

getProcessors in interface IPresentationManagerSPI

Parameters:

webResource - the web resource.

Returns:

a list with the HTML processors for the given web resource .

Throws:

PortalException

clearChannelHtmlProcessorsCache

public void clearChannelHtmlProcessorsCache(java.lang.String channelId)

Description copied from interface: IPresentationManagerSPI

Clears the IHtmlProcessor cache.

Specified by:

clearChannelHtmlProcessorsCache in interface IPresentationManagerSPI

Parameters:

channelId - the affected channel identifier.

clearServiceInstanceHtmlProcessorsCache

public void clearServiceInstanceHtmlProcessorsCache(java.lang.String serviceInstanceId)

Description copied from interface: IPresentationManagerSPI

Clears the IHtmlProcessor cache.

Specified by:

clearServiceInstanceHtmlProcessorsCache in interface IPresentationManagerSPI

Parameters:

serviceInstanceId - the affected service instance identifier.

clearHtmlProcessorsCache

public void clearHtmlProcessorsCache()

Description copied from interface: IPresentationManagerSPI

Clears all HTML processor cache.

Specified by:

clearHtmlProcessorsCache in interface IPresentationManagerSPI