org.sonar.api.server.ws.RailsHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-plugin-api Show documentation

There is a newer version: 5.1

/*
 * 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.api.server.ws;

/**
 * Used to declare web services that are still implemented in Ruby on Rails.
 *
 * @since 4.4
 */
public class RailsHandler implements RequestHandler {

  public static final RequestHandler INSTANCE = new RailsHandler();

  private RailsHandler() {
    // Nothing
  }

  @Override
  public void handle(Request request, Response response) {
    throw new UnsupportedOperationException("This web service is implemented in rails");
  }

  public static WebService.NewParam addFormatParam(WebService.NewAction action) {
    return action.createParam("format")
      .setDescription("Response format can be set through:" +
        "" +
        "Parameter format: xml | json" +
        "Or the 'Accept' property in the HTTP header:" +
        "" +
        "Accept:text/xml" +
        "Accept:application/json" +
        "" +
        "If nothing is set, json is used")
      .setPossibleValues("json", "xml");
  }

  public static WebService.NewParam addJsonOnlyFormatParam(WebService.NewAction action) {
    return action.createParam("format")
      .setDescription("Only json response format is available")
      .setPossibleValues("json");
  }

}