/*
* Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
*
* This file is part of Resin(R) Open Source
*
* Each copy or derived work must preserve the copyright notice and this
* notice unmodified.
*
* Resin Open Source is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Resin Open Source is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
* of NON-INFRINGEMENT. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with Resin Open Source; if not, write to the
*
* Free Software Foundation, Inc.
* 59 Temple Place, Suite 330
* Boston, MA 02111-1307 USA
*
* @author Sam
*/
package com.caucho.rewrite;
import java.util.regex.Pattern;
import javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletRequest;
import com.caucho.config.ConfigException;
import com.caucho.config.Configurable;
import com.caucho.util.L10N;
/**
* Passes if the named parameter exists and has a value
* that matches a regular expression.
*
* <pre>
* <web-app xmlns:resin="urn:java:com.caucho.resin">
*
* <resin:Forbidden regexp="^/local/">
* <resin:IfQueryParam name="foo" regexp="bar"/>
* </resin:Forbidden>
*
* </web-app>
* </pre>
*
* <p>RequestPredicates may be used for both security and rewrite conditions.
*/
@Configurable
public class IfQueryParam implements RequestPredicate
{
private static final L10N L = new L10N(IfQueryParam.class);
private String _name;
private Pattern _regexp;
public IfQueryParam()
{
}
/**
* Sets the name of the query parameter to test.
*
* @param name the name of the parameter.
*/
@Configurable
public void setName(String name)
{
_name = name;
}
/**
* Sets the regular expression to compare against the query parameter.
*
* @param regexp the regular expression to test
*/
@Configurable
public void setRegexp(Pattern regexp)
{
_regexp = regexp;
}
public void setValue(Pattern regexp)
{
setRegexp(regexp);
}
@PostConstruct
public void init()
{
if (_name == null)
throw new ConfigException(L.l("'name' is a required attribute for {0}",
getClass().getSimpleName()));
}
/**
* True if the predicate matches.
*
* @param request the servlet request to test
*/
@Override
public boolean isMatch(HttpServletRequest request)
{
String value = request.getParameter(_name);
if (value != null)
return _regexp == null || _regexp.matcher(value).find();
else
return false;
}
}