001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * Sonar is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.security;
021    
022    import org.sonar.api.ServerExtension;
023    
024    /**
025     * @since 1.12
026     * @see SecurityRealm
027     */
028    public interface LoginPasswordAuthenticator extends ServerExtension {
029    
030      /**
031       * @throws RuntimeException if the authenticator can not be initialized at sonar server startup, eg. if the connection to LDAP server is refused
032       * @deprecated in 2.14, but was left for backward compatibility - when this authenticator is not a part of {@link SecurityRealm}, otherwise has no effect and not invoked
033       */
034      @Deprecated
035      void init();
036    
037      /**
038       * @return true, if user was successfully authenticated with specified username and password, false otherwise
039       * @throws RuntimeException in case of unexpected error such as connection failure
040       */
041      boolean authenticate(String username, String password);
042    
043    }