001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program 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 * This program 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 */
020package org.sonar.api.security;
021
022import org.sonar.api.batch.ScannerSide;
023import org.sonar.api.server.ServerSide;
024import org.sonar.api.resources.Resource;
025
026/**
027 * Grant access to newly created projects.
028 * <br>
029 * <p>This component is not supposed to be called by standard plugins.
030 *
031 * @since 3.2
032 */
033@ScannerSide
034@ServerSide
035public interface ResourcePermissions {
036
037  /**
038   * Limitation - the resource id is used instead of logical key.
039   */
040  boolean hasRoles(Resource resource);
041
042  /**
043   * Limitation - the resource id is used instead of logical key.
044   * Important note : the existing roles are overridden by default ones, so it's recommended
045   * to check that {@link ResourcePermissions#hasRoles(org.sonar.api.resources.Resource)} is
046   * false before executing this method.
047   */
048  void grantDefaultRoles(Resource resource);
049
050  /**
051   * Limitation - the resource id is used instead of logical key.
052   */
053  void grantUserRole(Resource resource, String login, String role);
054
055  /**
056   * Limitation - the resource id is used instead of logical key.
057   */
058  void grantGroupRole(Resource resource, String groupName, String role);
059}