org.sonar.server.issue.filter.AppAction.java Source code

Introduction

Here is the source code for org.sonar.server.issue.filter.AppAction.java

Source

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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.issue.filter;

import com.google.common.io.Resources;
import org.sonar.api.server.ws.Request;
import org.sonar.api.server.ws.RequestHandler;
import org.sonar.api.server.ws.Response;
import org.sonar.api.server.ws.WebService;
import org.sonar.api.utils.text.JsonWriter;
import org.sonar.core.issue.DefaultIssueFilter;
import org.sonar.server.user.UserSession;

import java.util.List;

public class AppAction implements RequestHandler {

    private final IssueFilterService service;
    private final IssueFilterWriter issueFilterWriter;

    public AppAction(IssueFilterService service, IssueFilterWriter issueFilterWriter) {
        this.service = service;
        this.issueFilterWriter = issueFilterWriter;
    }

    void define(WebService.NewController controller) {
        WebService.NewAction action = controller.createAction("app");
        action.setDescription("Data required for rendering the page 'Issues'").setInternal(true).setHandler(this)
                .setResponseExample(Resources.getResource(this.getClass(), "app-example-show.json"));
        action.createParam("id").setDescription("Optionally, the ID of the current filter");
    }

    @Override
    public void handle(Request request, Response response) throws Exception {
        UserSession session = UserSession.get();

        JsonWriter json = response.newJsonWriter();
        json.beginObject();

        // Current filter (optional)
        Integer filterId = request.paramAsInt("id");
        DefaultIssueFilter filter = null;
        if (filterId != null && filterId >= 0) {
            filter = service.find((long) filterId, session);
        }

        // Permissions
        json.prop("canManageFilters", session.isLoggedIn());
        json.prop("canBulkChange", session.isLoggedIn());

        // Selected filter
        if (filter != null) {
            issueFilterWriter.write(session, filter, json);
        }

        // Favorite filters, if logged in
        if (session.isLoggedIn()) {
            List<DefaultIssueFilter> favorites = service.findFavoriteFilters(session);
            json.name("favorites").beginArray();
            for (DefaultIssueFilter favorite : favorites) {
                json.beginObject().prop("id", favorite.id()).prop("name", favorite.name()).endObject();
            }
            json.endArray();
        }

        json.endObject();
        json.close();
    }

}