org.sonar.server.permission.ws.template.WsTemplateRef Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation
There is a newer version: 7.2.1
/*
 * SonarQube
 * Copyright (C) 2009-2018 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.permission.ws.template;

import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.server.ws.Request;

import static org.sonar.server.ws.WsUtils.checkRequest;
import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_ORGANIZATION;
import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_ID;
import static org.sonarqube.ws.client.permission.PermissionsWsParameters.PARAM_TEMPLATE_NAME;

/**
 * Reference to a template as defined by WS request. Guaranties one of template id or
 * template name is provided, not both.
 */
public class WsTemplateRef {

  private final String uuid;
  private final String organization;
  private final String name;

  private WsTemplateRef(@Nullable String uuid, @Nullable String organization, @Nullable String name) {
    checkRequest(uuid != null ^ name != null, "Template name or template id must be provided, not both.");

    this.uuid = uuid;
    this.organization = organization;
    this.name = name;
  }

  public static WsTemplateRef fromRequest(Request wsRequest) {
    String uuid = wsRequest.param(PARAM_TEMPLATE_ID);
    String organization = wsRequest.param(PARAM_ORGANIZATION);
    String name = wsRequest.param(PARAM_TEMPLATE_NAME);

    return new WsTemplateRef(uuid, organization, name);
  }

  public static WsTemplateRef newTemplateRef(@Nullable String uuid, @Nullable String organization, @Nullable String name) {
    return new WsTemplateRef(uuid, organization, name);
  }

  @CheckForNull
  public String uuid() {
    return this.uuid;
  }

  @CheckForNull
  public String getOrganization() {
    return this.organization;
  }

  @CheckForNull
  public String name() {
    return this.name;
  }
}