org.sonar.api.web

Interface RubyRailsWebservice

All Superinterfaces:

Extension, ServerComponent, ServerExtension, Webservice

public interface RubyRailsWebservice
extends Webservice

Interface to create a web service by implementing a Ruby On Rails controller. The method getTemplate() return the ROR controller code, the name of the controller class defined in the template MUST match the following name scheme : Api::$Webservice.getId()Controller I.E : Webservice.getId() = TestWS > Api::TestWSController. The plugin will be deployed with the following URL scheme: http://sonarhost/api/plugins/$Webservice.getId()/:action/:id :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 and will call the index controller method if not specified.

Since:

1.11

Method Summary

Methods

Modifier and Type	Method and Description
String	getTemplate()

Methods inherited from interface org.sonar.api.web.Webservice

getId

Method Detail

getTemplate

String getTemplate()

Returns:

Content of the Ruby on Rails web service controller class