1 /*******************************************************************************
2 * Copyright 2012 Internet2
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16 /*
17 * @author mchyzer
18 * $Id: WsCustomAuthentication.java,v 1.1 2008-04-01 08:38:34 mchyzer Exp $
19 */
20 package edu.internet2.middleware.grouper.ws.security;
21
22 import javax.servlet.http.HttpServletRequest;
23
24 import edu.internet2.middleware.grouper.ws.exceptions.WsInvalidQueryException;
25
26
27 /**
28 * <pre>
29 * implement this interface and provide the class to the classpath and grouper-ws.properties
30 * to override the default of httpServletRequest.getUserPrincipal();
31 * for non-Rampart authentication
32 *
33 * if user is not found, throw a runtime exception. Could be WsInvalidQueryException
34 * which is a type of runtime exception (experiment and see what you want the response to
35 * look like)
36 *
37 * </pre>
38 */
39 public interface WsCustomAuthentication {
40
41 /**
42 * retrieve the current username (subjectId) from the request object.
43 * @param httpServletRequest
44 * @return the logged in username (subjectId)
45 * @throws WsInvalidQueryException if there is a problem
46 */
47 public String retrieveLoggedInSubjectId(HttpServletRequest httpServletRequest)
48 throws WsInvalidQueryException;
49
50 }