com.ocpsoft.rewrite.servlet.spi.RequestParameterProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rewrite-api-servlet Show documentation

The newest version!

/*
 * Copyright 2011 Lincoln Baxter, III
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ocpsoft.rewrite.servlet.spi;

import java.util.Map;

import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;

/**
 * Supplies additional request parameters to the {@link HttpServletRequest} object.
 * 
 * @author Lincoln Baxter, III
 * 
 */
public interface RequestParameterProvider
{
   /**
    * Return a map of parameters to be added to the current request as if they had been passed with the HTTP request
    * from the browser. This occurs during the wrapping stage of the lifecycle.
    * 
    * @see {@link RewriteLifecycleListener}
    */
   Map getParameters(ServletRequest request, ServletResponse response);
}