fr.paris.lutece.portal.service.page

Class PageService

java.lang.Object

fr.paris.lutece.portal.service.page.PageService

All Implemented Interfaces:

ImageResourceProvider, IPageService, PageEventListener, PortletEventListener, EventListener

public class PageService
extends Object
implements IPageService, ImageResourceProvider, PageEventListener, PortletEventListener

This class delivers pages to web componants. It handles XML tranformation to HTML and provides a cache feature in order to reduce the number of tranformations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REDIRECTION_KEY Key for redirections
static String	TEMPLATE_PAGE_ACCESS_CONTROLED Access Controled template
static String	TEMPLATE_PAGE_ACCESS_DENIED Access denied template

Constructor Summary

Constructors

Constructor and Description
PageService(PageCacheService pageCacheService, PortletCacheService portletCacheService) Creates a new PageService object.

Method Summary

Modifier and Type	Method and Description
static void	addPageEventListener(PageEventListener listener) Add a new page event listener
String	buildPageContent(String strIdPage, int nMode, javax.servlet.http.HttpServletRequest request) Build the page content.
void	createPage(Page page) Create a page
ImageResource	getImageResource(int nIdResource) Gets the image resource for a given resource
String	getName() Returns the Content Service name
String	getPage(javax.servlet.http.HttpServletRequest request, int nMode) Returns the page for a given ID.
String	getPage(String strIdPage, int nMode, javax.servlet.http.HttpServletRequest request) Returns the page for a given ID.
PageCacheService	getPageCacheService() Gets the page cache service.
String	getPageContent(int nIdPage, int nMode, javax.servlet.http.HttpServletRequest request) Build the page content.
PortletCacheService	getPortletCacheService() Gets the portlet cache service
String	getResourceImagePage(String strPageId) Management of the image associated to the page
String	getResourceTypeId() Returns the resource type Id
void	invalidateContent(int nPageId) Invalidate Page Content
boolean	isAuthorizedAdminPage(int nIdPage, String strPermission, AdminUser user) Check that a given user is allowed to access a page for a given permission
void	processPageEvent(PageEvent event) Process a page event
void	processPortletEvent(PortletEvent event) Process a portlet event
void	removePage(int nPageId) Remove a given page
void	setPageCacheKeyService(ICacheKeyService cacheKeyService)
void	setPageCacheService(PageCacheService pageCacheService) Sets the cache page service
void	setPortletCacheKeyService(ICacheKeyService cacheKeyService)
void	setPortletCacheService(PortletCacheService portletCacheService) Gets the portlet cache service
void	setRoleRemovalService(RemovalListenerService removalService)
static void	updateChildrenAuthorizationNode(int nIdParentPage, Integer nIdNewAuthorizationNode) update authorization node of children page
void	updatePage(Page page) Update a given page

Methods inherited from class java.lang.Object

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

Field Detail

REDIRECTION_KEY

public static final String REDIRECTION_KEY

Key for redirections

See Also:

Constant Field Values

TEMPLATE_PAGE_ACCESS_DENIED

public static final String TEMPLATE_PAGE_ACCESS_DENIED

Access denied template

See Also:

Constant Field Values

TEMPLATE_PAGE_ACCESS_CONTROLED

public static final String TEMPLATE_PAGE_ACCESS_CONTROLED

Access Controled template

See Also:

Constant Field Values

Constructor Detail

PageService

@Inject
public PageService(PageCacheService pageCacheService,
                           PortletCacheService portletCacheService)

Creates a new PageService object.

Parameters:

pageCacheService - the page cache service

portletCacheService - the portlet cache service

Method Detail

getName

public String getName()

Returns the Content Service name

Returns:

The name as a String

getPage

public String getPage(javax.servlet.http.HttpServletRequest request,
                      int nMode)
               throws SiteMessageException

Returns the page for a given ID. The page is built using XML data of each portlet or retrieved from the cache if it's enable.

Specified by:

getPage in interface IPageService

Parameters:

request - The page ID

nMode - The current mode.

Returns:

The HTML code of the page as a String.

Throws:

SiteMessageException - If a message shouldbe displayed

getPage

public String getPage(String strIdPage,
                      int nMode,
                      javax.servlet.http.HttpServletRequest request)
               throws SiteMessageException

Returns the page for a given ID. The page is built using XML data of each portlet or retrieved from the cache if it's enable.

Specified by:

getPage in interface IPageService

Parameters:

strIdPage - The page ID

nMode - The current mode.

request - The HttpRequest

Returns:

The HTML code of the page as a String.

Throws:

SiteMessageException - occurs when a site message need to be displayed

buildPageContent

public String buildPageContent(String strIdPage,
                               int nMode,
                               javax.servlet.http.HttpServletRequest request)
                        throws SiteMessageException

Build the page content.

Parameters:

strIdPage - The page ID

nMode - The current mode.

request - The HttpRequest

Returns:

The HTML code of the page as a String.

Throws:

SiteMessageException - occurs when a site message need to be displayed

getPageContent

public String getPageContent(int nIdPage,
                             int nMode,
                             javax.servlet.http.HttpServletRequest request)
                      throws SiteMessageException

Build the page content.

Specified by:

getPageContent in interface IPageService

Parameters:

nIdPage - The page ID

nMode - The current mode.

request - The HttpRequest

Returns:

The HTML code of the page as a String.

Throws:

SiteMessageException - occurs when a site message need to be displayed

setPageCacheKeyService

public void setPageCacheKeyService(ICacheKeyService cacheKeyService)

Parameters:

cacheKeyService - the _cacheKeyService to set

setPortletCacheKeyService

public void setPortletCacheKeyService(ICacheKeyService cacheKeyService)

Parameters:

cacheKeyService - the _cacheKeyService to set

setRoleRemovalService

public void setRoleRemovalService(RemovalListenerService removalService)

Parameters:

removalService - the removal listener service

addPageEventListener

public static void addPageEventListener(PageEventListener listener)

Add a new page event listener

Parameters:

listener - An event listener to add

getResourceTypeId

public String getResourceTypeId()

Returns the resource type Id

Specified by:

getResourceTypeId in interface ImageResourceProvider

Specified by:

getResourceTypeId in interface IPageService

Returns:

The resource type Id

getImageResource

public ImageResource getImageResource(int nIdResource)

Gets the image resource for a given resource

Specified by:

getImageResource in interface ImageResourceProvider

Parameters:

nIdResource - The Resource id

Returns:

The image resource

createPage

public void createPage(Page page)

Create a page

Specified by:

createPage in interface IPageService

Parameters:

page - The page to create

updatePage

public void updatePage(Page page)

Update a given page

Specified by:

updatePage in interface IPageService

Parameters:

page - The page to update

removePage

public void removePage(int nPageId)

Remove a given page

Specified by:

removePage in interface IPageService

Parameters:

nPageId - The page Id

processPageEvent

public void processPageEvent(PageEvent event)

Process a page event

Specified by:

processPageEvent in interface PageEventListener

Parameters:

event - The event to process

processPortletEvent

public void processPortletEvent(PortletEvent event)

Process a portlet event

Specified by:

processPortletEvent in interface PortletEventListener

Parameters:

event - The event to process

invalidateContent

public void invalidateContent(int nPageId)

Invalidate Page Content

Specified by:

invalidateContent in interface IPageService

Parameters:

nPageId - The Page ID

isAuthorizedAdminPage

public boolean isAuthorizedAdminPage(int nIdPage,
                                     String strPermission,
                                     AdminUser user)

Check that a given user is allowed to access a page for a given permission

Specified by:

isAuthorizedAdminPage in interface IPageService

Parameters:

nIdPage - the id of the page to check

strPermission - the permission needed

user - The current user

Returns:

true if authorized, otherwise false

getResourceImagePage

public String getResourceImagePage(String strPageId)

Management of the image associated to the page

Parameters:

strPageId - The page identifier

Returns:

The url

getPageCacheService

public PageCacheService getPageCacheService()

Gets the page cache service.

Returns:

the page cache service

setPageCacheService

public void setPageCacheService(PageCacheService pageCacheService)

Sets the cache page service

Parameters:

pageCacheService - the page cache service

getPortletCacheService

public PortletCacheService getPortletCacheService()

Gets the portlet cache service

Returns:

the porlet cache service

setPortletCacheService

public void setPortletCacheService(PortletCacheService portletCacheService)

Gets the portlet cache service

Parameters:

portletCacheService - the portlet cache service

updateChildrenAuthorizationNode

public static void updateChildrenAuthorizationNode(int nIdParentPage,
                                                   Integer nIdNewAuthorizationNode)

update authorization node of children page

Parameters:

nIdParentPage - id of the parent page

nIdNewAuthorizationNode - the new authorization id