001/* 002 * SonarQube, open source software quality management tool. 003 * Copyright (C) 2008-2013 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 */ 020package org.sonar.api.web; 021 022 023/** 024 * Interface to create a web service by implementing a Ruby On Rails controller. 025 * The method getTemplate() return the ROR controller code, the name of the controller class defined in the template 026 * MUST match the following name scheme : Api::$Webservice.getId()Controller I.E : Webservice.getId() = TestWS > Api::TestWSController. 027 * The plugin will be deployed with the following URL scheme: http://sonarhost/api/plugins/$Webservice.getId()/:action/:id 028 * :action is the name of the controller method to call, :id is a param that will be passed to the controller, these 2 params are not mandatory 029 * and will call the index controller method if not specified. 030 * 031 * @since 1.11 032 */ 033public interface RubyRailsWebservice extends Webservice { 034 035 /** 036 * @return Content of the Ruby on Rails web service controller class 037 */ 038 String getTemplate(); 039}