01: /**********************************************************************************
02: *
03: * $Id: Authn.java 9271 2006-05-10 21:52:49Z ray@media.berkeley.edu $
04: *
05: ***********************************************************************************
06: *
07: * Copyright (c) 2005 The Regents of the University of California, The MIT Corporation
08: *
09: * Licensed under the Educational Community License, Version 1.0 (the "License");
10: * you may not use this file except in compliance with the License.
11: * You may obtain a copy of the License at
12: *
13: * http://www.opensource.org/licenses/ecl1.php
14: *
15: * Unless required by applicable law or agreed to in writing, software
16: * distributed under the License is distributed on an "AS IS" BASIS,
17: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18: * See the License for the specific language governing permissions and
19: * limitations under the License.
20: *
21: **********************************************************************************/package org.sakaiproject.tool.gradebook.facades;
22:
23: /**
24: * Facade to abstract external authentication services.
25: * Since this is an application-wide singleton pointing to an otherwise opaque service,
26: * we do not assume that the authenticator has access to (for example) an up-to-date
27: * fully constructed FacesContext.
28: */
29: public interface Authn {
30: /**
31: * @return an ID uniquely identifying the currently authenticated user in a
32: * site, or null if the user has not been authenticated.
33: */
34: public String getUserUid();
35:
36: /**
37: * @param whatToAuthn the javax.servlet.http.HttpServletRequest or
38: * javax.portlet.PortletRequest for which authentication should be checked. Since
39: * they don't share an interface, a generic object is passed.
40: */
41: public void setAuthnContext(Object whatToAuthn);
42: }
|