FileDocCategorySizeDatePackage
TokenHelper.javaAPI DocExample6165Mon Jul 23 13:26:56 BST 2007org.apache.struts2.util

TokenHelper

public class TokenHelper extends Object
TokenHelper

Fields Summary
public static final String
DEFAULT_TOKEN_NAME
The default name to map the token value
public static final String
TOKEN_NAME_FIELD
The name of the field which will hold the token name
private static final Log
LOG
private static final Random
RANDOM
Constructors Summary
Methods Summary
public static java.lang.StringgenerateGUID()

        return new BigInteger(165, RANDOM).toString(36).toUpperCase();
public static java.lang.StringgetToken()
Gets a transaction token into the session using the default token name.

return
token

        return getToken(DEFAULT_TOKEN_NAME);
public static java.lang.StringgetToken(java.lang.String tokenName)
Gets the Token value from the params in the ServletActionContext using the given name

param
tokenName the name of the parameter which holds the token value
return
the token String or null, if the token could not be found

        Map params = ActionContext.getContext().getParameters();
        String[] tokens = (String[]) params.get(tokenName);
        String token;

        if ((tokens == null) || (tokens.length < 1)) {
            LOG.warn("Could not find token mapped to token name " + tokenName);

            return null;
        }

        token = tokens[0];

        return token;
public static java.lang.StringgetTokenName()
Gets the token name from the Parameters in the ServletActionContext

return
the token name found in the params, or null if it could not be found

        Map params = ActionContext.getContext().getParameters();

        if (!params.containsKey(TOKEN_NAME_FIELD)) {
            LOG.warn("Could not find token name in params.");

            return null;
        }

        String[] tokenNames = (String[]) params.get(TOKEN_NAME_FIELD);
        String tokenName;

        if ((tokenNames == null) || (tokenNames.length < 1)) {
            LOG.warn("Got a null or empty token name.");

            return null;
        }

        tokenName = tokenNames[0];

        return tokenName;
public static java.lang.StringsetToken()
Sets a transaction token into the session using the default token name.

return
the token string



                         
        
        return setToken(DEFAULT_TOKEN_NAME);
public static java.lang.StringsetToken(java.lang.String tokenName)
Sets a transaction token into the session using the provided token name.

param
tokenName the name to store into the session with the token as the value
return
the token string

        Map session = ActionContext.getContext().getSession();
        String token = generateGUID();
        try {
            session.put(tokenName, token);
        }
        catch(IllegalStateException e) {
            // WW-1182 explain to user what the problem is
            String msg = "Error creating HttpSession due response is commited to client. You can use the CreateSessionInterceptor or create the HttpSession from your action before the result is rendered to the client: " + e.getMessage();
            LOG.error(msg, e);
            throw new IllegalArgumentException(msg);
        }

        return token;
public static booleanvalidToken()
Checks for a valid transaction token in the current request params. If a valid token is found, it is removed so the it is not valid again.

return
false if there was no token set into the params (check by looking for {@link #TOKEN_NAME_FIELD}), true if a valid token is found

        String tokenName = getTokenName();

        if (tokenName == null) {
            if (LOG.isDebugEnabled())
                LOG.debug("no token name found -> Invalid token ");
            return false;
        }

        String token = getToken(tokenName);

        if (token == null) {
            if (LOG.isDebugEnabled())
                LOG.debug("no token found for token name "+tokenName+" -> Invalid token ");
            return false;
        }

        Map session = ActionContext.getContext().getSession();
        String sessionToken = (String) session.get(tokenName);

        if (!token.equals(sessionToken)) {
            LOG.warn(LocalizedTextUtil.findText(TokenHelper.class, "struts.internal.invalid.token", ActionContext.getContext().getLocale(), "Form token {0} does not match the session token {1}.", new Object[]{
                    token, sessionToken
            }));

            return false;
        }

        // remove the token so it won't be used again
        session.remove(tokenName);

        return true;