001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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 License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.security;
021    
022    import org.sonar.api.ServerExtension;
023    
024    /**
025     * @since 2.14
026     */
027    public abstract class SecurityRealm implements ServerExtension {
028    
029      /**
030       * @return unique name of this realm, e.g. "ldap"
031       */
032      public String getName() {
033        return getClass().getSimpleName();
034      }
035    
036      /**
037       * Invoked during server startup and can be used to initialize internal state.
038       */
039      public void init() {
040      }
041    
042      /**
043       * @return {@link LoginPasswordAuthenticator} associated with this realm, never null
044       * @deprecated replaced by doGetAuthenticator in version 3.1
045       */
046      @Deprecated
047      public LoginPasswordAuthenticator getLoginPasswordAuthenticator() {
048        return null;
049      }
050    
051      /**
052       * @since 3.1
053       */
054      public Authenticator doGetAuthenticator() {
055        // this method is not overridden when deprecated getLoginPasswordAuthenticator
056        // is used
057        return new Authenticator() {
058          @Override
059          public boolean doAuthenticate(Context context) {
060            return getLoginPasswordAuthenticator().authenticate(context.getUsername(), context.getPassword());
061          }
062        };
063      }
064    
065      /**
066       * @return {@link ExternalUsersProvider} associated with this realm, null if not supported
067       */
068      public ExternalUsersProvider getUsersProvider() {
069        return null;
070      }
071    
072      /**
073       * @return {@link ExternalGroupsProvider} associated with this realm, null if not supported
074       */
075      public ExternalGroupsProvider getGroupsProvider() {
076        return null;
077      }
078    }