View Javadoc

1   /* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
2    *
3    * Licensed under the Apache License, Version 2.0 (the "License");
4    * you may not use this file except in compliance with the License.
5    * You may obtain a copy of the License at
6    *
7    *     http://www.apache.org/licenses/LICENSE-2.0
8    *
9    * Unless required by applicable law or agreed to in writing, software
10   * distributed under the License is distributed on an "AS IS" BASIS,
11   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12   * See the License for the specific language governing permissions and
13   * limitations under the License.
14   */
15  
16  package org.springframework.security.ui;
17  
18  import javax.servlet.http.HttpServletRequest;
19  
20  import org.springframework.security.Authentication;
21  import org.springframework.security.ui.savedrequest.SavedRequest;
22  
23  /**
24   * Used by {@link AbstractProcessingFilter} to determine target URL in case of
25   * successful authentication.
26   * 
27   * @author Martino Piccinato
28   * @version $Id: TargetUrlResolver.java 2668 2008-02-28 11:03:05Z luke_t $
29   * @since 2.0
30   *
31   */
32  public interface TargetUrlResolver {
33      
34      /**
35       * @param savedRequest The request that initiated the authentication process
36       * @param currentRequest the current request
37       * @param auth The authentication token generated after successful authentication
38       * @return The URL to be used 
39       */
40      public String determineTargetUrl(SavedRequest savedRequest, HttpServletRequest currentRequest, Authentication auth);
41  
42  }