Package org.silverpeas.core.web.mvc.webcomponent

Class WebComponentController<T extends WebComponentRequestContext>

java.lang.Object

org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

org.silverpeas.core.web.mvc.webcomponent.WebComponentController<T>

Type Parameters:

T - the type of the implementation of the WebComponentRequestContext class.

All Implemented Interfaces:

Serializable, ComponentSessionController, SessionCloseable

Direct Known Subclasses:

AbstractCalendarWebController, DocumentTemplateWebController, DragAndDropWebEditorController, MyLinksPeasWebController, WbeWebController

public abstract class WebComponentController<T extends WebComponentRequestContext>
extends AbstractComponentSessionController

Base class for all web component controller. Each implementation must be specified in web component servlet declaration into the linked web.xml.

Author:

Yohann Chastagnier

See Also:

Serialized Form

Field Summary

Fields inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

context

Constructor Summary

Constructors

Constructor	Description
WebComponentController(MainSessionController controller, String spaceId, String componentId)
WebComponentController(MainSessionController controller, ComponentContext context)
WebComponentController(MainSessionController controller, ComponentContext context, String resourceFileName)
WebComponentController(MainSessionController controller, ComponentContext context, String multilangFileName, String iconFileName)
WebComponentController(MainSessionController controller, ComponentContext context, String multilangFileName, String iconFileName, String settingsFileName)

Method Summary

Modifier and Type	Method	Description
protected void	beforeRequestProcessing(T context)	Permits to perform some common initializations.
protected abstract void	onInstantiation(T context)	This method is called one times just after the web controller is instantiated and just before the call of the HTTP web controller method.

Methods inherited from class org.silverpeas.core.web.mvc.controller.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getClipboardErrorMessage, getClipboardExceptionError, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getHighestSilverpeasUserRole, getIcon, getLanguage, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoles, getZoneId, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardSelectedElement, setComponentRootName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebComponentController

public WebComponentController(MainSessionController controller,
                              String spaceId,
                              String componentId)

WebComponentController

public WebComponentController(MainSessionController controller,
                              ComponentContext context)

WebComponentController

public WebComponentController(MainSessionController controller,
                              ComponentContext context,
                              String resourceFileName)

WebComponentController

public WebComponentController(MainSessionController controller,
                              ComponentContext context,
                              String multilangFileName,
                              String iconFileName)

WebComponentController

public WebComponentController(MainSessionController controller,
                              ComponentContext context,
                              String multilangFileName,
                              String iconFileName,
                              String settingsFileName)

Method Detail

onInstantiation

protected abstract void onInstantiation(T context)

This method is called one times just after the web controller is instantiated and just before the call of the HTTP web controller method.

Parameters:

context - the web request context.

beforeRequestProcessing

protected void beforeRequestProcessing(T context)

Permits to perform some common initializations. The method is called just before the method behing the identified path is invoked.

Parameters:

context - the context of the request in relation with the web controller