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

Class WebComponentRequestContext<T extends WebComponentController>

java.lang.Object

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

Type Parameters:

T - The type of the implementation of the WebComponentController abstract class.

Direct Known Subclasses:

AbstractCalendarWebRequestContext, DocumentTemplateWebRequestContext, DragAndDropWebEditorRequestContext, MyLinksPeasWebRequestContext, WbeWebRequestContext

public abstract class WebComponentRequestContext<T extends WebComponentController>
extends Object

Author:

Yohann Chastagnier

Constructor Summary

Constructors

Constructor	Description
WebComponentRequestContext()

Method Summary

Modifier and Type	Method	Description
void	addRedirectVariable(String variableName, String variableValue)
void	beforeRequestProcessing()	This methods permits to perform initializations before the HTTP method (and associated method invocation) aimed is performed.
String	getComponentInstanceId()
String	getComponentInstanceLabel()
String	getComponentName()
String	getComponentUriBase()
SilverpeasRole	getHighestUserRole()
Class<? extends Annotation>	getHttpMethodClass()
String	getInstanceParameterValue(String parameterName)
WebMessager	getMessager()
org.silverpeas.kernel.bundle.LocalizationBundle	getMultilang()
NavigationContext	getNavigationContext()
Map<String,String>	getPathVariables()
HttpRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
String	getSpaceId()
String	getSpaceLabel()
UserDetail	getUser()
Collection<SilverpeasRole>	getUserRoles()
ZoneId	getZoneId()
boolean	isComingFromRedirect()
Navigation	redirectToHtmlEditor(String objectId, String objectType, String returnPath, boolean indexIt)	Handles the navigation to the html editor.
Navigation	redirectToHtmlEditor(ContributionManagementContext contributionManagementContext, String objectId, String objectType, String returnPath, boolean indexIt)	Handles the navigation to the html editor.
Navigation	redirectToHtmlEditor(ContributionManagementContext contributionManagementContext, WysiwygRouting.WysiwygRoutingContext wysiwygContext)	Handles the navigation to the html editor.
Navigation	redirectToHtmlEditor(WysiwygRouting.WysiwygRoutingContext wysiwygContext)	Handles the navigation to the html editor.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebComponentRequestContext

public WebComponentRequestContext()

Method Detail

beforeRequestProcessing

public void beforeRequestProcessing()

This methods permits to perform initializations before the HTTP method (and associated method invocation) aimed is performed.

getHttpMethodClass

public Class<? extends Annotation> getHttpMethodClass()

getRequest

public HttpRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getNavigationContext

public NavigationContext getNavigationContext()

Returns:

the navigation context associated to the current instancied component.

See Also:

NavigationContext

getPathVariables

public Map<String,String> getPathVariables()

addRedirectVariable

public void addRedirectVariable(String variableName,
                                String variableValue)

getZoneId

public ZoneId getZoneId()

getMultilang

public org.silverpeas.kernel.bundle.LocalizationBundle getMultilang()

getMessager

public WebMessager getMessager()

getComponentUriBase

public String getComponentUriBase()

getComponentInstanceId

public String getComponentInstanceId()

getComponentInstanceLabel

public String getComponentInstanceLabel()

getComponentName

public String getComponentName()

getInstanceParameterValue

public String getInstanceParameterValue(String parameterName)

getSpaceId

public String getSpaceId()

getSpaceLabel

public String getSpaceLabel()

getUser

public UserDetail getUser()

getUserRoles

public Collection<SilverpeasRole> getUserRoles()

getHighestUserRole

public SilverpeasRole getHighestUserRole()

isComingFromRedirect

public boolean isComingFromRedirect()

redirectToHtmlEditor

public Navigation redirectToHtmlEditor(String objectId,
                                       String objectType,
                                       String returnPath,
                                       boolean indexIt)

Handles the navigation to the html editor.

redirectToHtmlEditor

public Navigation redirectToHtmlEditor(WysiwygRouting.WysiwygRoutingContext wysiwygContext)

Handles the navigation to the html editor.

redirectToHtmlEditor

public Navigation redirectToHtmlEditor(ContributionManagementContext contributionManagementContext,
                                       String objectId,
                                       String objectType,
                                       String returnPath,
                                       boolean indexIt)

Handles the navigation to the html editor.

redirectToHtmlEditor

public Navigation redirectToHtmlEditor(ContributionManagementContext contributionManagementContext,
                                       WysiwygRouting.WysiwygRoutingContext wysiwygContext)

Handles the navigation to the html editor.