|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.page.PageService
public class PageService
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 | |
---|---|
static java.lang.String |
REDIRECTION_KEY
|
static java.lang.String |
TEMPLATE_PAGE_ACCESS_CONTROLED
Access Controled template |
static java.lang.String |
TEMPLATE_PAGE_ACCESS_DENIED
Access denied template |
Constructor Summary | |
---|---|
PageService()
Creates a new PageService object. |
Method Summary | |
---|---|
void |
addPageEventListener(PageEventListener listener)
Add a new page event listener |
java.lang.String |
buildPageContent(java.lang.String strIdPage,
int nMode,
javax.servlet.http.HttpServletRequest request,
java.lang.Boolean bCanBeCached)
Build the page content. |
void |
createPage(Page page)
Create a page |
ImageResource |
getImageResource(int nIdResource)
Gets the image resource for a given resource |
java.lang.String |
getName()
Returns the Content Service name |
java.lang.String |
getPage(javax.servlet.http.HttpServletRequest request,
int nMode)
Returns the page for a given ID. |
java.lang.String |
getPage(java.lang.String strIdPage,
int nMode,
javax.servlet.http.HttpServletRequest request)
Returns the page for a given ID. |
java.lang.String |
getPageContent(int nIdPage,
int nMode,
javax.servlet.http.HttpServletRequest request)
Build the page content. |
java.lang.String |
getResourceImagePage(java.lang.String strPageId)
Management of the image associated to the page |
java.lang.String |
getResourceTypeId()
Returns the resource type Id |
void |
invalidateContent(int nPageId)
Invalidate Page Content |
boolean |
isAuthorizedAdminPage(int nIdPage,
java.lang.String strPermission,
AdminUser user)
Check that a given user is allowed to access a page for a given permission and his workgroups |
void |
processPageEvent(PageEvent event)
Process a page event |
void |
removePage(int nPageId)
Remove a given page |
void |
setPageCacheKeyService(ICacheKeyService cacheKeyService)
|
void |
setPortletCacheKeyService(ICacheKeyService cacheKeyService)
|
void |
setRoleRemovalService(RemovalListenerService removalService)
|
void |
updatePage(Page page)
Update a given page |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String REDIRECTION_KEY
public static final java.lang.String TEMPLATE_PAGE_ACCESS_DENIED
public static final java.lang.String TEMPLATE_PAGE_ACCESS_CONTROLED
Constructor Detail |
---|
public PageService()
Method Detail |
---|
public java.lang.String getName()
public java.lang.String getPage(javax.servlet.http.HttpServletRequest request, int nMode) throws SiteMessageException
getPage
in interface IPageService
request
- The page IDnMode
- The current mode.
SiteMessageException
- If a message shouldbe displayedpublic java.lang.String getPage(java.lang.String strIdPage, int nMode, javax.servlet.http.HttpServletRequest request) throws SiteMessageException
getPage
in interface IPageService
strIdPage
- The page IDnMode
- The current mode.request
- The HttpRequest
SiteMessageException
- occurs when a site message need to be displayedpublic java.lang.String buildPageContent(java.lang.String strIdPage, int nMode, javax.servlet.http.HttpServletRequest request, java.lang.Boolean bCanBeCached) throws SiteMessageException
strIdPage
- The page IDnMode
- The current mode.request
- The HttpRequestbCanBeCached
- The boolean
SiteMessageException
- occurs when a site message need to be displayedpublic java.lang.String getPageContent(int nIdPage, int nMode, javax.servlet.http.HttpServletRequest request) throws SiteMessageException
getPageContent
in interface IPageService
nIdPage
- The page IDnMode
- The current mode.request
- The HttpRequest
SiteMessageException
- occurs when a site message need to be displayedpublic void setPageCacheKeyService(ICacheKeyService cacheKeyService)
cacheKeyService
- the _cacheKeyService to setpublic void setPortletCacheKeyService(ICacheKeyService cacheKeyService)
cacheKeyService
- the _cacheKeyService to setpublic void setRoleRemovalService(RemovalListenerService removalService)
removalService
- the removal listener servicepublic void addPageEventListener(PageEventListener listener)
listener
- An event listener to addpublic java.lang.String getResourceTypeId()
getResourceTypeId
in interface ImageResourceProvider
getResourceTypeId
in interface IPageService
public ImageResource getImageResource(int nIdResource)
getImageResource
in interface ImageResourceProvider
nIdResource
- The Resource id
public void createPage(Page page)
createPage
in interface IPageService
page
- The page to createpublic void updatePage(Page page)
updatePage
in interface IPageService
page
- The page to updatepublic void removePage(int nPageId)
removePage
in interface IPageService
nPageId
- The page Idpublic void processPageEvent(PageEvent event)
processPageEvent
in interface PageEventListener
event
- The event to processpublic void invalidateContent(int nPageId)
invalidateContent
in interface IPageService
nPageId
- The Page IDpublic boolean isAuthorizedAdminPage(int nIdPage, java.lang.String strPermission, AdminUser user)
isAuthorizedAdminPage
in interface IPageService
nIdPage
- the id of the page to checkstrPermission
- the permission neededuser
- The current user
public java.lang.String getResourceImagePage(java.lang.String strPageId)
strPageId
- The page identifier
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |