fr.paris.lutece.portal.service.portal
Class StandaloneAppService

java.lang.Object
  extended by fr.paris.lutece.portal.service.cache.AbstractCacheableService
      extended by fr.paris.lutece.portal.service.content.ContentService
          extended by fr.paris.lutece.portal.service.portal.StandaloneAppService
All Implemented Interfaces:
CacheableService, LuteceService, Cloneable, net.sf.ehcache.event.CacheEventListener

public class StandaloneAppService
extends ContentService

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 :
RunStandaloneApp.jsp?page=keyname&param1=value1& ...&paramN=valueN

See Also:
XPage

Field Summary
static String PARAM_STANDALONE_APP
           
 
Constructor Summary
StandaloneAppService()
           
 
Method Summary
 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.
 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
 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

PARAM_STANDALONE_APP

public static final String PARAM_STANDALONE_APP
See Also:
Constant Field Values
Constructor Detail

StandaloneAppService

public StandaloneAppService()
Method Detail

getName

public String getName()
Returns the Content Service name

Returns:
The name as a String

isInvoked

public boolean isInvoked(javax.servlet.http.HttpServletRequest request)
Analyzes request parameters to see if the request should be handled by the current Content Service

Specified by:
isInvoked in class ContentService
Parameters:
request - The HTTP request
Returns:
true if this ContentService should handle this request

setCache

public void setCache(boolean bCache)
Enable or disable the cache feature.

Parameters:
bCache - true to enable the cache, false to disable

isCacheEnable

public boolean isCacheEnable()
Gets the current cache status.

Specified by:
isCacheEnable in interface CacheableService
Overrides:
isCacheEnable in class AbstractCacheableService
Returns:
true if enable, otherwise false

resetCache

public void resetCache()
Reset the cache.

Specified by:
resetCache in interface CacheableService
Overrides:
resetCache in class AbstractCacheableService

getCacheSize

public int getCacheSize()
Gets the number of item currently in the cache.

Specified by:
getCacheSize in interface CacheableService
Overrides:
getCacheSize in class AbstractCacheableService
Returns:
the number of item currently in the cache.

getPage

public String getPage(javax.servlet.http.HttpServletRequest request,
                      int nMode)
               throws UserNotSignedException,
                      SiteMessageException
Build the XPage content.

Specified by:
getPage in class ContentService
Parameters:
request - The HTTP request.
nMode - The current mode.
Returns:
The HTML code of the page.
Throws:
UserNotSignedException - a userNotSignedException
SiteMessageException - occurs when a site message need to be displayed


Copyright © 2014 Mairie de Paris. All Rights Reserved.