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
19
20 /**
21 * Provides a {@link org.springframework.security.Authentication#getDetails()} object for
22 * a given web request.
23 *
24 * @author Ben Alex
25 * @version $Id: AuthenticationDetailsSource.java 2727 2008-03-13 14:42:38Z luke_t $
26 */
27 public interface AuthenticationDetailsSource {
28 //~ Methods ========================================================================================================
29
30 /**
31 * Called by a class when it wishes a new authentication details instance to be created.
32 *
33 * @param context the request object, which may be used by the authentication details object
34 *
35 * @return a fully-configured authentication details instance
36 */
37 Object buildDetails(Object context);
38 }