3 * Copyright (C) 2009-2023 SonarSource SA
4 * mailto:info AT sonarsource DOT com
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 3 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 package org.sonar.server.v2.api.rule.controller;
22 import java.util.HashMap;
24 import org.sonar.api.rule.RuleKey;
25 import org.sonar.server.common.rule.ReactivationException;
26 import org.sonar.server.common.rule.service.NewCustomRule;
27 import org.sonar.server.common.rule.service.RuleInformation;
28 import org.sonar.server.common.rule.service.RuleService;
29 import org.sonar.server.user.UserSession;
30 import org.sonar.server.v2.api.rule.converter.RuleRestResponseGenerator;
31 import org.sonar.server.v2.api.rule.request.Impact;
32 import org.sonar.server.v2.api.rule.request.RuleCreateRestRequest;
33 import org.sonar.server.v2.api.rule.response.RuleRestResponse;
34 import org.springframework.http.HttpStatus;
35 import org.springframework.web.server.ResponseStatusException;
37 import static org.sonar.db.permission.GlobalPermission.ADMINISTER_QUALITY_PROFILES;
39 public class DefaultRuleController implements RuleController {
40 private final UserSession userSession;
41 private final RuleService ruleService;
42 private final RuleRestResponseGenerator ruleRestResponseGenerator;
44 public DefaultRuleController(UserSession userSession, RuleService ruleService, RuleRestResponseGenerator ruleRestResponseGenerator) {
45 this.userSession = userSession;
46 this.ruleService = ruleService;
47 this.ruleRestResponseGenerator = ruleRestResponseGenerator;
51 public RuleRestResponse create(RuleCreateRestRequest request) {
54 .checkPermission(ADMINISTER_QUALITY_PROFILES);
56 RuleInformation ruleInformation = ruleService.createCustomRule(toNewCustomRule(request));
57 return ruleRestResponseGenerator.toRuleRestResponse(ruleInformation);
58 } catch (ReactivationException e) {
59 throw new ResponseStatusException(HttpStatus.CONFLICT, e.getMessage(), e);
63 private static NewCustomRule toNewCustomRule(RuleCreateRestRequest request) {
64 NewCustomRule newCustomRule = NewCustomRule.createForCustomRule(RuleKey.parse(request.key()), RuleKey.parse(request.templateKey()))
65 .setName(request.name())
66 .setMarkdownDescription(request.markdownDescription())
67 .setStatus(request.status())
68 .setCleanCodeAttribute(request.cleanCodeAttribute())
69 .setImpacts(request.impacts().stream().map(DefaultRuleController::toNewCustomRuleImpact).toList())
70 .setPreventReactivation(true);
71 if (request.parameters() != null) {
72 Map<String, String> params = new HashMap<>();
73 request.parameters().forEach(p -> params.put(p.key(), p.defaultValue()));
74 newCustomRule.setParameters(params);
79 private static NewCustomRule.Impact toNewCustomRuleImpact(Impact impact) {
80 return new NewCustomRule.Impact(impact.softwareQuality(), impact.severity());