public class XPageAppService extends ContentService
Portal.jsp?page=keyname¶m1=value1& ...¶mN=valueN
XPage
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_XPAGE_APP |
Constructor and Description |
---|
XPageAppService() |
Modifier and Type | Method and Description |
---|---|
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.
|
getPluginName, setPluginName
clone, dispose, enableCache, getCache, getFromCache, getInfos, getKeys, getMaxElements, getMemorySize, getTimeToLive, initCache, initCache, notifyElementEvicted, notifyElementExpired, notifyElementPut, notifyElementRemoved, notifyElementUpdated, notifyRemoveAll, putInCache, removeKey
public static final String PARAM_XPAGE_APP
public static void registerXPageApplication(XPageApplicationEntry entry) throws LuteceInitException
entry
- The application entryLuteceInitException
- If an error occuredpublic String getName()
public boolean isInvoked(javax.servlet.http.HttpServletRequest request)
isInvoked
in class ContentService
request
- The HTTP requestpublic 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 ExceptionSiteMessageException
- occurs when a site message need to be displayedpublic static XPageApplicationEntry getApplicationEntry(String strName)
strName
- The application's namepublic static Collection<XPageApplicationEntry> getXPageApplicationsList()
public static XPageApplication getApplicationInstance(XPageApplicationEntry entry)
entry
- The Xpage entryCopyright © 2020 City of Paris. All rights reserved.