001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.web;
021    
022    
023    /**
024     * <b>EXPERIMENTAL</b>
025     * <p/>
026     * Interface to create a ruby web service extension point using the Ruby On Rails controller API (ActionController)
027     * The method getTemplate() return the ROR controller code, the name of the controller class defined in the template
028     * MUST match the following name scheme : Api::$Webservice.getId()Controller I.E : Webservice.getId() = TestWS > Api::TestWSController.
029     * The plugin will be deployed with the following URL scheme: http://sonarhost/api/plugins/$Webservice.getId()/:action/:id
030     * :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
031     * and will call the index controler method if not specified.
032     *
033     * @since 1.11
034     */
035    public interface RubyRailsWebservice extends Webservice {
036    
037      /**
038       * @return Content of the Ruby on Rails web service controller class
039       */
040      String getTemplate();
041    }