/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * 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 org.springframework.security.ui;

import javax.servlet.http.HttpServletRequest;

import org.springframework.security.Authentication;
import org.springframework.security.ui.savedrequest.SavedRequest;

/**
 * Used by {@link AbstractProcessingFilter} to determine target URL in case of
 * successful authentication.
 * 
 * @author Martino Piccinato
 * @version $Id$
 * @since 2.0
 *
 */
public interface TargetUrlResolver {
	
	/**
	 * @param savedRequest The request that initiated the authentication process
	 * @param currentRequest the current request
	 * @param auth The authentication token generated after successful authentication
	 * @return The URL to be used 
	 */
	public String determineTargetUrl(SavedRequest savedRequest, HttpServletRequest currentRequest, Authentication auth);

}
