1 /*
2 * Copyright (c) 2002-2007 by OpenSymphony
3 * All rights reserved.
4 */
5 package com.opensymphony.xwork2.interceptor;
6
7 /**
8 * <!-- START SNIPPET: javadoc -->
9 *
10 * This interface is implemented by actions that want to declare acceptable parameters. Works in conjunction with {@link
11 * ParametersInterceptor}. For example, actions may want to create a whitelist of parameters they will accept or a
12 * blacklist of paramters they will reject to prevent clients from setting other unexpected (and possibly dangerous)
13 * parameters.
14 *
15 * <!-- END SNIPPET: javadoc -->
16 *
17 * @author Bob Lee (crazybob@google.com)
18 */
19 public interface ParameterNameAware {
20
21 /**
22 * Tests if the the action will accept the parameter with the given name.
23 *
24 * @param parameterName the parameter name
25 * @return <tt> if accepted, <tt>false</tt> otherwise
26 */
27 boolean acceptableParameterName(String parameterName);
28
29 }