001 //$HeadURL$
002 /*---------------- FILE HEADER ------------------------------------------
003 This file is part of deegree.
004 Copyright (C) 2001-2008 by:
005 Department of Geography, University of Bonn
006 http://www.giub.uni-bonn.de/deegree/
007 lat/lon GmbH
008 http://www.lat-lon.de
009
010 This library is free software; you can redistribute it and/or
011 modify it under the terms of the GNU Lesser General Public
012 License as published by the Free Software Foundation; either
013 version 2.1 of the License, or (at your option) any later version.
014 This library is distributed in the hope that it will be useful,
015 but WITHOUT ANY WARRANTY; without even the implied warranty of
016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017 Lesser General Public License for more details.
018 You should have received a copy of the GNU Lesser General Public
019 License along with this library; if not, write to the Free Software
020 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
021 Contact:
022
023 Andreas Poth
024 lat/lon GmbH
025 Aennchenstr. 19
026 53177 Bonn
027 Germany
028 E-Mail: poth@lat-lon.de
029
030 Prof. Dr. Klaus Greve
031 Department of Geography
032 University of Bonn
033 Meckenheimer Allee 166
034 53115 Bonn
035 Germany
036 E-Mail: greve@giub.uni-bonn.de
037 ---------------------------------------------------------------------------*/
038 package org.deegree.security;
039
040 import java.util.Map;
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
080 * successfull. Otherwise a WrongCredentialsException will be thrown
081 *
082 * @return an instance of User
083 * @param params
084 * @throws WrongCredentialsException
085 */
086 public abstract User authenticate( Map<String, String> params )
087 throws WrongCredentialsException;
088 }