Open Source Repository

Home /xwork/xwork-core-2.1.6 | Repository Home



com/opensymphony/xwork2/interceptor/ParameterNameAware.java
/*
 * Copyright (c) 2002-2007 by OpenSymphony
 * All rights reserved.
 */
package com.opensymphony.xwork2.interceptor;

/**
 <!-- START SNIPPET: javadoc -->
 *
 * This interface is implemented by actions that want to declare acceptable parameters. Works in conjunction with {@link
 * ParametersInterceptor}. For example, actions may want to create a whitelist of parameters they will accept or a
 * blacklist of paramters they will reject to prevent clients from setting other unexpected (and possibly dangerous)
 * parameters.
 *
 <!-- END SNIPPET: javadoc -->
 *
 @author Bob Lee ([email protected])
 */
public interface ParameterNameAware {

    /**
     * Tests if the the action will accept the parameter with the given name.
     *
     @param parameterName  the parameter name
     @return <tt> if accepted, <tt>false</tt> otherwise
     */
    boolean acceptableParameterName(String parameterName);
    
}