org.sonar.api.server.ws

Class WebService.Action

java.lang.Object

org.sonar.api.server.ws.WebService.Action

Enclosing interface:

WebService

@Immutable
public static class WebService.Action
extends Object

Method Summary

Modifier and Type	Method and Description
String	deprecatedKey()
String	deprecatedSince()
String	description()
RequestHandler	handler()
boolean	isInternal()
boolean	isPost()
String	key()
WebService.Param	param(String key)
Collection<WebService.Param>	params()
String	path()
URL	responseExample()
String	responseExampleAsString()
String	responseExampleFormat()
String	since() Set if different than controller.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

key

public String key()

deprecatedKey

public String deprecatedKey()

path

public String path()

description

@CheckForNull
public String description()

since

@CheckForNull
public String since()

Set if different than controller.

deprecatedSince

@CheckForNull
public String deprecatedSince()

isPost

public boolean isPost()

isInternal

public boolean isInternal()

handler

public RequestHandler handler()

responseExample

@CheckForNull
public URL responseExample()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

responseExampleAsString

@CheckForNull
public String responseExampleAsString()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

responseExampleFormat

@CheckForNull
public String responseExampleFormat()

See Also:

WebService.NewAction.setResponseExample(java.net.URL)

param

@CheckForNull
public WebService.Param param(String key)

params

public Collection<WebService.Param> params()

toString

public String toString()

Overrides:

toString in class Object