org.apache.struts2.components
Class Token

java.lang.Object
  org.apache.struts2.components.Component
      org.apache.struts2.components.UIBean
          org.apache.struts2.components.Token

public class Token
extends UIBean

Stop double-submission of forms.

The token tag is used to help with the "double click" submission problem. It is needed if you are using the TokenInterceptor or the TokenSessionInterceptor. The s:token tag merely places a hidden element that contains the unique token.

Examples

 
 <s:token />
 
 

See Also:

TokenInterceptor, TokenSessionStoreInterceptor

Field Summary

static String

TEMPLATE

Fields inherited from class org.apache.struts2.components.UIBean

accesskey, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, standardAttributesMap, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, value

Fields inherited from class org.apache.struts2.components.Component

actionMapper, COMPONENT_STACK, parameters, stack, throwExceptionOnELFailure

Constructor Summary

Token(ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

protected void	evaluateExtraParams() First looks for the token in the PageContext using the supplied name (or TokenHelper.DEFAULT_TOKEN_NAME if no name is provided) so that the same token can be re-used for the scope of a request for the same name.
protected String	getDefaultTemplate() A contract that requires each concrete UI Tag to specify which template should be used as a default.
String	getTokenNameField() Deprecated. Templates should use $parameters from now on, not $tag.

Methods inherited from class org.apache.struts2.components.UIBean

addFormParameter, buildTemplateName, copyParams, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getId, getStandardAttributes, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setId, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTheme, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setValue

Methods inherited from class org.apache.struts2.components.Component

addAllParameters, addParameter, altSyntax, altSyntax, completeExpressionIfAltSyntax, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findStringIfAltSyntax, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, setThrowExceptionsOnELFailure, setUrlHelper, start, stripExpressionIfAltSyntax, stripExpressionIfAltSyntax, toString, usesBody

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE

public static final String TEMPLATE

See Also:

Constant Field Values

Constructor Detail

Token

public Token(ValueStack stack,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)

Method Detail

getDefaultTemplate

protected String getDefaultTemplate()

Description copied from class: UIBean

A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.

Specified by:

getDefaultTemplate in class UIBean

Returns:

The name of the template to be used as the default.

evaluateExtraParams

protected void evaluateExtraParams()

First looks for the token in the PageContext using the supplied name (or TokenHelper.DEFAULT_TOKEN_NAME if no name is provided) so that the same token can be re-used for the scope of a request for the same name. If the token is not in the PageContext, a new Token is created and set into the Session and the PageContext with the name.

Overrides:

evaluateExtraParams in class UIBean

getTokenNameField

public String getTokenNameField()

Deprecated. Templates should use $parameters from now on, not $tag.

This will be removed in a future version of Struts.