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 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       */
045      public abstract LoginPasswordAuthenticator getLoginPasswordAuthenticator();
046    
047      /**
048       * @return {@link ExternalUsersProvider} associated with this realm, null if not supported
049       */
050      public ExternalUsersProvider getUsersProvider() {
051        return null;
052      }
053    
054      /**
055       * @return {@link ExternalGroupsProvider} associated with this realm, null if not supported
056       */
057      public ExternalGroupsProvider getGroupsProvider() {
058        return null;
059      }
060    
061    }