com.opensymphony.webwork.components
Class Token

java.lang.Object
  extended by com.opensymphony.webwork.components.Component
      extended by com.opensymphony.webwork.components.UIBean
          extended by com.opensymphony.webwork.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 ww:token tag merely places a hidden element that contains the unique token.

Examples

 
 <ww:token />
 
 

Since:
2.2
Version:
$Date: 2006-03-19 00:28:55 +0800 (Sun, 19 Mar 2006) $ $Id: Token.java 2468 2006-03-18 16:28:55Z rgielen $
Author:
Patrick Lightbody, Rene Gielen, Rainer Hermanns
See Also:
TokenInterceptor, TokenSessionStoreInterceptor

Field Summary
static String TEMPLATE
           
 
Fields inherited from class com.opensymphony.webwork.components.UIBean
accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
Token(OgnlValueStack stack, HttpServletRequest request, 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 com.opensymphony.webwork.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
 
Methods inherited from class com.opensymphony.webwork.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, 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(OgnlValueStack stack,
             HttpServletRequest request,
             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 WebWork.


WebWork Project Page