org.sonar.server.ws.WsUtils.java Source code

Introduction

Here is the source code for org.sonar.server.ws.WsUtils.java

Source

/*
 * SonarQube
 * Copyright (C) 2009-2017 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.ws;

import com.google.common.base.Optional;
import com.google.protobuf.Message;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.util.List;
import javax.annotation.Nullable;
import org.apache.commons.io.IOUtils;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.Response;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.core.util.ProtobufJsonFormat;
import org.sonar.server.exceptions.BadRequestException;
import org.sonar.server.exceptions.NotFoundException;
import org.sonarqube.ws.MediaTypes;
import org.sonarqube.ws.MessageFormatter;

import static java.lang.String.format;

public class WsUtils {

    private WsUtils() {
        // only statics
    }

    public static void writeProtobuf(Message msg, Request request, Response response) {
        OutputStream output = response.stream().output();
        try {
            if (request.getMediaType().equals(MediaTypes.PROTOBUF)) {
                response.stream().setMediaType(MediaTypes.PROTOBUF);
                msg.writeTo(output);
            } else {
                response.stream().setMediaType(MediaTypes.JSON);
                try (JsonWriter writer = JsonWriter.of(new OutputStreamWriter(output, StandardCharsets.UTF_8))) {
                    ProtobufJsonFormat.write(msg, writer);
                }
            }
        } catch (Exception e) {
            throw new IllegalStateException(
                    format("Error while writing protobuf message %s", MessageFormatter.print(msg)), e);
        } finally {
            IOUtils.closeQuietly(output);
        }
    }

    /**
     * @throws BadRequestException
     */
    public static void checkRequest(boolean expression, String message, Object... messageArguments) {
        if (!expression) {
            throw BadRequestException.create(format(message, messageArguments));
        }
    }

    public static void checkRequest(boolean expression, List<String> messages) {
        if (!expression) {
            throw BadRequestException.create(messages);
        }
    }

    /**
     * @throws NotFoundException if the value if null
     * @return the value
     */
    public static <T> T checkFound(@Nullable T value, String message, Object... messageArguments) {
        if (value == null) {
            throw new NotFoundException(format(message, messageArguments));
        }

        return value;
    }

    /**
     * @throws NotFoundException if the value is not present
     * @return the value
     */
    public static <T> T checkFoundWithOptional(Optional<T> value, String message, Object... messageArguments) {
        if (!value.isPresent()) {
            throw new NotFoundException(format(message, messageArguments));
        }

        return value.get();
    }

    public static <T> T checkFoundWithOptional(java.util.Optional<T> value, String message,
            Object... messageArguments) {
        if (!value.isPresent()) {
            throw new NotFoundException(format(message, messageArguments));
        }

        return value.get();
    }
}