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.ServerComponent;
023    import org.sonar.api.resources.Resource;
024    import org.sonar.api.task.TaskComponent;
025    
026    /**
027     * Grant access to newly created projects.
028     * <p/>
029     * <p>This component is not supposed to be called by standard plugins.</p>
030     *
031     * @since 3.2
032     */
033    public interface ResourcePermissions extends TaskComponent, ServerComponent {
034    
035      /**
036       * Limitation - the resource id is used instead of logical key.
037       */
038      boolean hasRoles(Resource resource);
039    
040      /**
041       * Limitation - the resource id is used instead of logical key.
042       * Important note : the existing roles are overridden by default ones, so it's recommended
043       * to check that {@link ResourcePermissions#hasRoles(org.sonar.api.resources.Resource)} is
044       * false before executing this method.
045       */
046      void grantDefaultRoles(Resource resource);
047    
048      /**
049       * Limitation - the resource id is used instead of logical key.
050       */
051      void grantUserRole(Resource resource, String login, String role);
052    
053      /**
054       * Limitation - the resource id is used instead of logical key.
055       */
056      void grantGroupRole(Resource resource, String groupName, String role);
057    }