01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/security/I_CmsAuthorizationHandler.java,v $
03: * Date : $Date: 2008-02-27 12:05:29 $
04: * Version: $Revision: 1.5 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.security;
33:
34: import org.opencms.file.CmsObject;
35: import org.opencms.main.CmsException;
36:
37: import javax.servlet.http.HttpServletRequest;
38:
39: /**
40: * Defines general authorization methods.<p>
41: *
42: * One of the application scenarios for this interface is a personalized SSO implementation.<p>
43: *
44: * @author Michael Moossen
45: *
46: * @version $Revision: 1.5 $
47: *
48: * @since 6.5.4
49: */
50: public interface I_CmsAuthorizationHandler {
51:
52: /**
53: * Creates a new cms object from the given request object.<p>
54: *
55: * This method is called by OpenCms every time a resource is requested
56: * and the session can not automatically be authenticated.<p>
57: *
58: * @param request the http request to authenticate
59: *
60: * @return the cms context object associated to the current session
61: */
62: CmsObject initCmsObject(HttpServletRequest request);
63:
64: /**
65: * Authenticates the current request with additional user information.<p>
66: *
67: * You have to call this method by your own.<p>
68: *
69: * @param request the http request to authenticate
70: * @param userName the user name to authenticate
71: * @param pwd the user password to authenticate with
72: *
73: * @return the cms context object associated to the given user
74: *
75: * @throws CmsException if something goes wrong
76: */
77: CmsObject initCmsObject(HttpServletRequest request,
78: String userName, String pwd) throws CmsException;
79: }
|