|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.cache.AbstractCacheableService
fr.paris.lutece.portal.service.content.ContentService
fr.paris.lutece.portal.service.content.XPageAppService
public class XPageAppService
This class delivers Extra pages (xpages) to web components. An XPage is a page where the content is provided by a
specific class, but should be integrated into the portal struture and design. XPageApps are identified by a key
name. To display an XPage into the portal just call the following url :
Portal.jsp?page=keyname¶m1=value1& ...¶mN=valueN
XPage
Field Summary | |
---|---|
static String |
PARAM_XPAGE_APP
|
Constructor Summary | |
---|---|
XPageAppService()
|
Method Summary | |
---|---|
static XPageApplicationEntry |
getApplicationEntry(String strName)
Gets Application entry by name |
static XPageApplication |
getApplicationInstance(XPageApplicationEntry entry)
Get an XPage instance |
int |
getCacheSize()
Gets the number of item currently in the cache. |
String |
getName()
Returns the Content Service name |
String |
getPage(javax.servlet.http.HttpServletRequest request,
int nMode)
Build the XPage content. |
static Collection<XPageApplicationEntry> |
getXPageApplicationsList()
Gets applications list |
boolean |
isCacheEnable()
Gets the current cache status. |
boolean |
isInvoked(javax.servlet.http.HttpServletRequest request)
Analyzes request parameters to see if the request should be handled by the current Content Service |
static void |
registerXPageApplication(XPageApplicationEntry entry)
Register an application by its entry defined in the plugin xml file |
void |
resetCache()
Reset the cache. |
void |
setCache(boolean bCache)
Enable or disable the cache feature. |
Methods inherited from class fr.paris.lutece.portal.service.content.ContentService |
---|
getPluginName, setPluginName |
Methods inherited from class fr.paris.lutece.portal.service.cache.AbstractCacheableService |
---|
clone, dispose, enableCache, getCache, getFromCache, getInfos, getKeys, getMaxElements, getMemorySize, getTimeToLive, initCache, initCache, notifyElementEvicted, notifyElementExpired, notifyElementPut, notifyElementRemoved, notifyElementUpdated, notifyRemoveAll, putInCache, removeKey |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PARAM_XPAGE_APP
Constructor Detail |
---|
public XPageAppService()
Method Detail |
---|
public static void registerXPageApplication(XPageApplicationEntry entry) throws LuteceInitException
entry
- The application entry
LuteceInitException
- If an error occuredpublic String getName()
public boolean isInvoked(javax.servlet.http.HttpServletRequest request)
isInvoked
in class ContentService
request
- The HTTP request
public void setCache(boolean bCache)
bCache
- true to enable the cache, false to disablepublic boolean isCacheEnable()
isCacheEnable
in interface CacheableService
isCacheEnable
in class AbstractCacheableService
public void resetCache()
resetCache
in interface CacheableService
resetCache
in class AbstractCacheableService
public int getCacheSize()
getCacheSize
in interface CacheableService
getCacheSize
in class AbstractCacheableService
public String getPage(javax.servlet.http.HttpServletRequest request, int nMode) throws UserNotSignedException, SiteMessageException
getPage
in class ContentService
request
- The HTTP request.nMode
- The current mode.
UserNotSignedException
- The User Not Signed Exception
SiteMessageException
- occurs when a site message need to be displayedpublic static XPageApplicationEntry getApplicationEntry(String strName)
strName
- The application's name
public static Collection<XPageApplicationEntry> getXPageApplicationsList()
public static XPageApplication getApplicationInstance(XPageApplicationEntry entry)
entry
- The Xpage entry
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |