fr.paris.lutece.portal.service.content

Class ContentService

java.lang.Object

fr.paris.lutece.portal.service.cache.AbstractCacheableService

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

All Implemented Interfaces:

CacheableService, LuteceService, 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

Constructors

Constructor and Description
ContentService()

Method Summary

Modifier and Type	Method and Description
abstract String	getPage(javax.servlet.http.HttpServletRequest request, int nMode) Returns the HTML (or XML) code for a page for a given mode.
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(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, removeKey, resetCache

Methods inherited from class java.lang.Object

equals, 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 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 String getPluginName()

Return the name of the plugin

Returns:

The name of the plugin

setPluginName

public void setPluginName(String strPluginName)

Set the plugin name of the content service

Parameters:

strPluginName - the plugin name