com.caucho.rewrite.IfMethod Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 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 javax.annotation.PostConstruct;
import javax.servlet.http.HttpServletRequest;

import com.caucho.config.ConfigException;
import com.caucho.config.Configurable;
import com.caucho.util.L10N;

/**
 * Match if the HTTP method matches the value.
 *
 *  * <resin:Forbidden
 *             xmlns:resin="urn:java:com.caucho.resin">
 *   <resin:Method method="POST"/>
 * </resin:Forbidden>
 * 
 *
 * RequestPredicates may be used for security and rewrite actions.
 */
@Configurable
public class IfMethod implements RequestPredicate, CacheablePredicate
{
  private static final L10N L = new L10N(IfMethod.class);
  
  private String _method;

  /**
   * Sets the HTTP method value to test: GET, POST, etc..
   */
  @Configurable
  public void setMethod(String value)
  {
    _method = value;
  }

  /**
   * Sets the HTTP method value to test.
   */
  @Configurable
  public void setValue(String value)
  {
    setMethod(value);
  }

  @PostConstruct
  public void init()
  {
    if (_method == null)
      throw new ConfigException(L.l("'method' 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)
  {
    return _method.equals(request.getMethod());
  }
  
  @Override
  public String toString()
  {
    return getClass().getSimpleName() + "[" + _method + "]";
  }
}