org.sonar.server.activity.ws.SearchAction 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.0
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact 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.activity.ws;

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.server.activity.Activity;
import org.sonar.server.activity.index.ActivityDoc;
import org.sonar.server.activity.index.ActivityIndex;
import org.sonar.server.activity.index.ActivityQuery;
import org.sonar.server.es.SearchOptions;
import org.sonar.server.es.SearchResult;
import org.sonar.server.search.QueryContext;
import org.sonar.server.user.UserSession;

import static org.sonar.server.es.SearchOptions.MAX_LIMIT;

public class SearchAction implements RequestHandler {

  public static final String PARAM_TYPE = "type";
  public static final String SEARCH_ACTION = "search";

  private final ActivityIndex activityIndex;
  private final ActivityMapping docToJsonMapping;
  private final UserSession userSession;

  public SearchAction(ActivityIndex activityIndex, ActivityMapping docToJsonMapping, UserSession userSession) {
    this.activityIndex = activityIndex;
    this.docToJsonMapping = docToJsonMapping;
    this.userSession = userSession;
  }

  void define(WebService.NewController controller) {
    WebService.NewAction action = controller
      .createAction(SEARCH_ACTION)
      .setDescription("Search for activities")
      .setSince("4.4")
      .setResponseExample(getClass().getResource("search-example.json"))
      .setInternal(true)
      .setHandler(this);

    action.createParam(PARAM_TYPE)
      .setDescription("Activity type")
      .setPossibleValues(Activity.Type.values());

    action.addPagingParams(10, MAX_LIMIT);
    action.addFieldsParam(docToJsonMapping.supportedFields());
  }

  @Override
  public void handle(Request request, Response response) {
    ActivityQuery query = new ActivityQuery();
    query.setTypes(request.paramAsStrings(PARAM_TYPE));

    SearchOptions options = new SearchOptions();
    options.setPage(request.mandatoryParamAsInt(WebService.Param.PAGE), request.mandatoryParamAsInt(WebService.Param.PAGE_SIZE));

    SearchResult results = activityIndex.search(query, options);

    JsonWriter json = response.newJsonWriter().beginObject();
    options.writeJson(json, results.getTotal());
    writeActivities(results, json, new QueryContext(userSession).setFieldsToReturn(request.paramAsStrings(WebService.Param.FIELDS)));
    json.endObject().close();
  }

  private void writeActivities(SearchResult docs, JsonWriter json, QueryContext context) {
    json.name("logs").beginArray();
    for (ActivityDoc doc : docs.getDocs()) {
      docToJsonMapping.write(doc, json, context);
    }
    json.endArray();
  }
}