org.sonar.api.server.ws

Class WebService.Context

java.lang.Object

org.sonar.api.server.ws.WebService.Context

Enclosing interface:

WebService

public static class WebService.Context
extends Object

Constructor Summary

Constructors

Constructor and Description
Context()

Method Summary

Modifier and Type	Method and Description
WebService.Controller	controller(String key)
List<WebService.Controller>	controllers()
WebService.NewController	createController(String path) Create a new controller.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Context

public Context()

Method Detail

createController

public WebService.NewController createController(String path)

Create a new controller.
Structure of request URL is http://<server>/<controller path>/<action path>?<parameters>.

Parameters:

path - the controller path must not start or end with "/". It is recommended to start with "api/" and to use lower-case format with underscores, for example "api/coding_rules". Usual actions are "search", "list", "show", "create" and "delete". the plural form is recommended - ex: api/projects

controller

@CheckForNull
public WebService.Controller controller(String key)

controllers

public List<WebService.Controller> controllers()