|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.portal.PortalService
public final class PortalService
This class provides methods to build the pages of the portal and manage the cache
Method Summary | |
---|---|
static java.lang.String |
buildPageContent(int nCurrentPageId,
PageData data,
int nMode,
javax.servlet.http.HttpServletRequest request)
Returns the html code which represents the page content |
static java.lang.String |
buildPageContent(PageData data,
int nMode,
javax.servlet.http.HttpServletRequest request)
Returns the html code which represents the page content |
static java.lang.String |
formatPath(java.lang.String strPath,
int nMode,
javax.servlet.http.HttpServletRequest request)
Formats the path specified in parameter and returns it |
static java.util.Collection<CacheableService> |
getCacheableServicesList()
Deprecated. Use CacheService.getCacheableServicesList() instead |
static java.util.Collection<ContentService> |
getContentServicesList()
Returns all registered Content services |
static java.lang.String |
getDefaultPage(javax.servlet.http.HttpServletRequest request,
int nMode)
Return the default page of the portal (the home page) |
static ContentService |
getInvokedContentService(javax.servlet.http.HttpServletRequest request)
Analyzes request's parameters to find the ContentService that should handle the request |
static java.util.Collection<Page> |
getPagePath(int nPageId)
Builds a collection of pages corresponding to the path of the page specified in parameter |
static java.lang.String |
getPagePathContent(int nPageId,
int nMode,
javax.servlet.http.HttpServletRequest request)
Returns the formated path of the site page whose identifier is specified in parameter |
static int |
getRootPageId()
Returns the identifier of the root page of the portal read in the lutece.properties file |
static java.lang.String |
getXmlPagesList(java.util.Collection<Page> listPages)
Return the xml content of the pages contained in the list specified in parameter |
static java.lang.String |
getXPagePathContent(java.lang.String strXPageName,
int nMode,
javax.servlet.http.HttpServletRequest request)
Returns the formated path of a xpage (ex : result of a seek) |
static java.lang.String |
getXPagePathContent(java.lang.String strXPageName,
int nMode,
java.lang.String strTitlesUrls,
javax.servlet.http.HttpServletRequest request)
Returns the formated extended path of an xpage. |
static void |
registerCacheableService(java.lang.String strName,
CacheableService cs)
Deprecated. Use CacheService.registerCacheableService( String strName, CacheableService cs ) instead |
static void |
registerContentService(java.lang.String strName,
ContentService cs)
Registers a new ContentService |
static void |
resetCache()
Deprecated. use CacheService.resetCaches() |
static void |
setXslPortalPath(java.util.Map<java.lang.String,java.lang.String> mapParameters,
int nMode)
Sets XSL portal path |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
@Deprecated public static void resetCache()
public static ContentService getInvokedContentService(javax.servlet.http.HttpServletRequest request)
request
- The HTTP request
public static void registerContentService(java.lang.String strName, ContentService cs)
strName
- The namecs
- The ContentServicepublic static java.util.Collection<ContentService> getContentServicesList()
@Deprecated public static void registerCacheableService(java.lang.String strName, CacheableService cs)
strName
- The namecs
- The CacheableService@Deprecated public static java.util.Collection<CacheableService> getCacheableServicesList()
public static int getRootPageId()
public static java.lang.String getDefaultPage(javax.servlet.http.HttpServletRequest request, int nMode) throws SiteMessageException
request
- The requestnMode
- the mode id
SiteMessageException
- occurs when a site message need to be displayedpublic static java.lang.String getXmlPagesList(java.util.Collection<Page> listPages)
listPages
- The pages list
public static java.lang.String buildPageContent(PageData data, int nMode, javax.servlet.http.HttpServletRequest request)
data
- The structure which contains the informations about the pagenMode
- The mode in which displaying the page : normal or administrationrequest
- The request
public static java.lang.String buildPageContent(int nCurrentPageId, PageData data, int nMode, javax.servlet.http.HttpServletRequest request)
nCurrentPageId
- the current page iddata
- The structure which contains the informations about the pagenMode
- The mode in which displaying the page : normal or administrationrequest
- The request
public static java.lang.String getPagePathContent(int nPageId, int nMode, javax.servlet.http.HttpServletRequest request)
nPageId
- The identifier of the pagenMode
- The mode to use for the formattingrequest
- The HTTP request
public static java.lang.String getXPagePathContent(java.lang.String strXPageName, int nMode, javax.servlet.http.HttpServletRequest request)
strXPageName
- The xpage namenMode
- The mode to use for the formattingrequest
- The HTTP request
public static java.util.Collection<Page> getPagePath(int nPageId)
nPageId
- The identifier of the page
public static java.lang.String formatPath(java.lang.String strPath, int nMode, javax.servlet.http.HttpServletRequest request)
strPath
- The path to formatnMode
- The mode to use for the formattingrequest
- The HTTP request
public static java.lang.String getXPagePathContent(java.lang.String strXPageName, int nMode, java.lang.String strTitlesUrls, javax.servlet.http.HttpServletRequest request)
strXPageName
- The xpage namenMode
- The mode to use for the formattingstrTitlesUrls
- list of links (url and titles)request
- The HTTP request
public static void setXslPortalPath(java.util.Map<java.lang.String,java.lang.String> mapParameters, int nMode)
mapParameters
- Parameters as a mapnMode
- The mode
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |