001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    
021    package org.sonar.api.server.ws;
022    
023    /**
024     * Used to declare web services that are still implemented in Ruby on Rails.
025     *
026     * @since 4.4
027     */
028    public class RailsHandler implements RequestHandler {
029    
030      public static final RequestHandler INSTANCE = new RailsHandler();
031    
032      private RailsHandler() {
033        // Nothing
034      }
035    
036      @Override
037      public void handle(Request request, Response response) {
038        throw new UnsupportedOperationException("This web service is implemented in rails");
039      }
040    
041      public static WebService.NewParam addFormatParam(WebService.NewAction action) {
042        return action.createParam("format")
043          .setDescription("Response format can be set through:" +
044            "<ul>" +
045            "<li>Parameter format: xml | json</li>" +
046            "<li>Or the 'Accept' property in the HTTP header:" +
047            "<ul>" +
048            "<li>Accept:text/xml</li>" +
049            "<li>Accept:application/json</li>" +
050            "</ul></li></ul>" +
051            "If nothing is set, json is used")
052          .setPossibleValues("json", "xml");
053      }
054    
055      public static WebService.NewParam addJsonOnlyFormatParam(WebService.NewAction action) {
056        return action.createParam("format")
057          .setDescription("Only json response format is available")
058          .setPossibleValues("json");
059      }
060    
061    }