001/*
002 * SonarQube
003 * Copyright (C) 2009-2016 SonarSource SA
004 * mailto:contact AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.server.ws;
021
022/**
023 * Used to declare web services that are still implemented in Ruby on Rails.
024 *
025 * @since 4.4
026 */
027public class RailsHandler implements RequestHandler {
028
029  public static final RequestHandler INSTANCE = new RailsHandler();
030
031  private RailsHandler() {
032    // Nothing
033  }
034
035  @Override
036  public void handle(Request request, Response response) {
037    throw new UnsupportedOperationException("This web service is implemented in rails");
038  }
039
040  public static WebService.NewParam addFormatParam(WebService.NewAction action) {
041    return action.createParam("format")
042      .setDescription("Response format can be set through:" +
043        "<ul>" +
044        "<li>Parameter format: xml | json</li>" +
045        "<li>Or the 'Accept' property in the HTTP header:" +
046        "<ul>" +
047        "<li>Accept:text/xml</li>" +
048        "<li>Accept:application/json</li>" +
049        "</ul></li></ul>" +
050        "If nothing is set, json is used")
051      .setPossibleValues("json", "xml");
052  }
053
054  public static WebService.NewParam addJsonOnlyFormatParam(WebService.NewAction action) {
055    return action.createParam("format")
056      .setDescription("Only json response format is available")
057      .setPossibleValues("json");
058  }
059
060}