fr.paris.lutece.portal.service.content
Class ContentService

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

public abstract class ContentService
extends AbstractCacheableService

Interface for pages provider services.


Constructor Summary
ContentService()
           
 
Method Summary
abstract  java.lang.String getPage(javax.servlet.http.HttpServletRequest request, int nMode)
          Returns the HTML (or XML) code for a page for a given mode.
 java.lang.String getPluginName()
          Return the name of the plugin
abstract  boolean isInvoked(javax.servlet.http.HttpServletRequest request)
          Analyzes request's parameters to see if the request should be handled by the current Content Service
 void setPluginName(java.lang.String strPluginName)
          Set the plugin name of the content service
 
Methods inherited from class fr.paris.lutece.portal.service.cache.AbstractCacheableService
clone, dispose, enableCache, getCache, getCacheSize, getFromCache, getInfos, getKeys, getMaxElements, getMemorySize, getTimeToLive, initCache, initCache, isCacheEnable, notifyElementEvicted, notifyElementExpired, notifyElementPut, notifyElementRemoved, notifyElementUpdated, notifyRemoveAll, putInCache, resetCache
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface fr.paris.lutece.portal.service.util.LuteceService
getName
 

Constructor Detail

ContentService

public ContentService()
Method Detail

getPage

public abstract java.lang.String getPage(javax.servlet.http.HttpServletRequest request,
                                         int nMode)
                                  throws UserNotSignedException,
                                         SiteMessageException
Returns the HTML (or XML) code for a page for a given mode. The Service should use request parameters to identify the page content to provide.

Parameters:
request - The HTTP request containing content parameters
nMode - The current mode.
Returns:
The HTML (or XML) code of the page.
Throws:
UserNotSignedException - the UserNotSignedException
SiteMessageException - occurs when a site message need to be displayed

isInvoked

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

Parameters:
request - The HTTP request
Returns:
true if this ContentService should handle this request

getPluginName

public java.lang.String getPluginName()
Return the name of the plugin

Returns:
The name of the plugin

setPluginName

public void setPluginName(java.lang.String strPluginName)
Set the plugin name of the content service

Parameters:
strPluginName - the plugin name


Copyright © 2012 Mairie de Paris. All Rights Reserved.