    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 org.deegree.security.drm.WrongCredentialsException;
    041    import org.deegree.security.drm.model.User;
    042
    043    /**
    044     *
    045     *
    046     * @author <a href="mailto:poth@lat-lon.de">Andreas Poth</a>
    047     * @author last edited by: $Author: poth $
    048     *
    049     * @version $Revision: 6251 $, $Date: 2007-03-19 16:59:28 +0100 (Mo, 19 Mrz 2007) $
    050     */
    051    public abstract class AbstractAuthentication {
    052
    053        private String authenticationName;
    054
    055        protected Map<String, String> initParams;
    056
    057        /**
    058         *
    059         * @param authenticationName
    060         * @param initParams
    061         */
    062        public AbstractAuthentication( String authenticationName, Map<String, String> initParams ) {
    063            this.authenticationName = authenticationName;
    064            this.initParams = initParams;
    065        }
    066
    067        /**
    068         * returns the name of the authentication method implemented by a class
    069         *
    070         * @return name of the authentication method implemented by a class
    071         */
    072        public String getAuthenticationName() {
    073            return authenticationName;
    074        }
    075
    076        /**
    077         * authenticates a user and returns an instance of {@link User} if authentication has been
    078         * successfull. Otherwise a WrongCredentialsException will be thrown.
    079         *
    080         * @return an instance of User
    081         * @param params
    082         *            authentication parameters
    083         * @throws WrongCredentialsException
    084         *             if authentication was not successfull
    085         */
    086        public abstract User authenticate( Map<String, String> params )
    087                                throws WrongCredentialsException;
    088    }