001 //$HeadURL$
002 /*----------------------------------------------------------------------------
003 This file is part of deegree, http://deegree.org/
004 Copyright (C) 2001-2009 by:
005 Department of Geography, University of Bonn
006 and
007 lat/lon GmbH
008
009 This library is free software; you can redistribute it and/or modify it under
010 the terms of the GNU Lesser General Public License as published by the Free
011 Software Foundation; either version 2.1 of the License, or (at your option)
012 any later version.
013 This library is distributed in the hope that it will be useful, but WITHOUT
014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016 details.
017 You should have received a copy of the GNU Lesser General Public License
018 along with this library; if not, write to the Free Software Foundation, Inc.,
019 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020
021 Contact information:
022
023 lat/lon GmbH
024 Aennchenstr. 19, 53177 Bonn
025 Germany
026 http://lat-lon.de/
027
028 Department of Geography, University of Bonn
029 Prof. Dr. Klaus Greve
030 Postfach 1147, 53001 Bonn
031 Germany
032 http://www.geographie.uni-bonn.de/deegree/
033
034 e-mail: info@deegree.org
035 ----------------------------------------------------------------------------*/
036 package org.deegree.security;
037
038 import java.util.Map;
039
040 import javax.servlet.http.HttpServletRequest;
041
042 import org.deegree.security.drm.WrongCredentialsException;
043 import org.deegree.security.drm.model.User;
044
045 /**
046 *
047 *
048 * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
049 * @author last edited by: $Author: poth $
050 *
051 * @version $Revision: 6251 $, $Date: 2007-03-19 16:59:28 +0100 (Mo, 19 Mrz 2007) $
052 */
053 public abstract class AbstractAuthentication {
054
055 private String authenticationName;
056
057 protected Map<String, String> initParams;
058
059 /**
060 *
061 * @param authenticationName
062 * @param initParams
063 */
064 public AbstractAuthentication( String authenticationName, Map<String, String> initParams ) {
065 this.authenticationName = authenticationName;
066 this.initParams = initParams;
067 }
068
069 /**
070 * returns the name of the authentication method implemented by a class
071 *
072 * @return name of the authentication method implemented by a class
073 */
074 public String getAuthenticationName() {
075 return authenticationName;
076 }
077
078 /**
079 * authenticates a user and returns an instance of {@link User} if authentication has been successfull. Otherwise a
080 * WrongCredentialsException will be thrown.
081 *
082 * @return an instance of User
083 * @param params
084 * authentication parameters
085 * @throws WrongCredentialsException
086 * if authentication was not successfull
087 * @deprecated use {@link #authenticate(HttpServletRequest)} instead
088 */
089 public abstract User authenticate( Map<String, String> params )
090 throws WrongCredentialsException;
091
092 /**
093 * authenticates a user and returns an instance of {@link User} if authentication has been successfull. Otherwise a
094 * WrongCredentialsException will be thrown.
095 *
096 * @return an instance of User
097 * @param params
098 * authentication parameters
099 * @param request
100 * @throws WrongCredentialsException
101 * if authentication was not successfull
102 */
103 public abstract User authenticate( Map<String, String> params, HttpServletRequest request )
104 throws WrongCredentialsException;
105 }