01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/user/tags/sakai_2-4-1/user-api/api/src/java/org/sakaiproject/user/api/AuthenticationManager.java $
03: * $Id: AuthenticationManager.java 7194 2006-03-29 02:18:22Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.user.api;
21:
22: /**
23: * <p>
24: * AuthenticationManager provides authentication of end-users.
25: * </p>
26: */
27: public interface AuthenticationManager {
28: /**
29: * Attempt to authenticate a user by the given evidence. Success produces the authenticated user id. Failure throws an exception.
30: *
31: * @param e
32: * The collected evidence to authenticate.
33: * @return The authentication information if authenticated.
34: * @throws AuthenticationException
35: * if the evidence is not understood or not valid.
36: */
37: Authentication authenticate(Evidence e)
38: throws AuthenticationException;
39: }
|