struts-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Lukasz Lenart (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (WW-4109) ParameterNameAware Javadoc incorrect
Date Mon, 17 Jun 2013 04:52:20 GMT

     [ https://issues.apache.org/jira/browse/WW-4109?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Lukasz Lenart updated WW-4109:
------------------------------

    Description: 
I think the Javadoc of ParameterNameAware is wrong:

{noformat}
* 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.
{noformat}

It's not possible to blacklist parameters because of the "or" in:
{code:java}
boolean acceptableName = acceptableName(name)
                    || (parameterNameAware != null && parameterNameAware.acceptableParameterName(name));
{code}
Since there was some discussion about this some time ago, i would prefer to make ParameterNameAware
deprecate and add a new interface with 3 return values:
-> accept parameter
-> reject parameter
-> no decission, use acceptableName

Another possibility would be to add the result of acceptableName to acceptableParameterName.

e.g. parameterNameAware.acceptableParameterName(name, acceptableName(name)));

The ParameterNameAware-Action can decide, if the result of acceptableName should be overwritten
or not.

Thanks
Andi

  was:
I think the Javadoc of ParameterNameAware is wrong:

{noformat}
* 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.
{noformat}

It's not possible to blacklist parameters because of the "or" in:
{code:java}
boolean acceptableName = acceptableName(name)
                    || (parameterNameAware != null && parameterNameAware.acceptableParameterName(name));
{code}
Since there was some discussion about this some time ago, i would prefer to make ParameterNameAware
deprecate and add a new interface with 3 return values:
-> accept parameter
-> reject parameter
-> no decission, use acceptableName

Another possibility would be to add the result of acceptableName to acceptableParameterName.

e.g. parameterNameAware.acceptableParameterName(name, acceptableName(name)));

The ParameterNameAware-Action can decide, if the result of acceptableName should be overwritten
or not.

Thanks
Andi

    
> ParameterNameAware Javadoc incorrect
> ------------------------------------
>
>                 Key: WW-4109
>                 URL: https://issues.apache.org/jira/browse/WW-4109
>             Project: Struts 2
>          Issue Type: Improvement
>    Affects Versions: 2.3.14.3, 2.3.15
>            Reporter: Andreas Sachs
>            Priority: Minor
>
> I think the Javadoc of ParameterNameAware is wrong:
> {noformat}
> * 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.
> {noformat}
> It's not possible to blacklist parameters because of the "or" in:
> {code:java}
> boolean acceptableName = acceptableName(name)
>                     || (parameterNameAware != null && parameterNameAware.acceptableParameterName(name));
> {code}
> Since there was some discussion about this some time ago, i would prefer to make ParameterNameAware
deprecate and add a new interface with 3 return values:
> -> accept parameter
> -> reject parameter
> -> no decission, use acceptableName
> Another possibility would be to add the result of acceptableName to acceptableParameterName.
> e.g. parameterNameAware.acceptableParameterName(name, acceptableName(name)));
> The ParameterNameAware-Action can decide, if the result of acceptableName should be overwritten
or not.
> Thanks
> Andi

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message