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.acegisecurity.ui;
17
18 import javax.servlet.http.HttpServletRequest;
19
20
21 /**
22 * Provides a {@link org.acegisecurity.Authentication#getDetails()} object for
23 * a given web request.
24 *
25 * @author Ben Alex
26 * @version $Id: AuthenticationDetailsSource.java 1784 2007-02-24 21:00:24Z luke_t $
27 */
28 public interface AuthenticationDetailsSource {
29 //~ Methods ========================================================================================================
30
31 /**
32 * Called by a class when it wishes a new authentication details instance to be created.
33 *
34 * @param request the request object, which may be used by the authentication details object
35 *
36 * @return a fully-configured authentication details instance
37 */
38 Object buildDetails(HttpServletRequest request);
39 }