org.sonar.api.server.ws
Class Request

java.lang.Object
  org.sonar.api.server.ws.Request

Direct Known Subclasses:

WsTester.TestRequest

public abstract class Request
extends Object

Since:

4.2

Constructor Summary

Request()

Method Summary

abstract WebService.Action	action()
String	mandatoryParam(String key) Returns value of a mandatory parameter
boolean	mandatoryParamAsBoolean(String key) Returns value of a mandatory parameter
int	mandatoryParamAsInt(String key) Returns value of a mandatory parameter
long	mandatoryParamAsLong(String key) Returns value of a mandatory parameter
abstract String	method() Returns the name of the HTTP method with which this request was made.
abstract String	param(String key)
String	param(String key, String defaultValue)
Boolean	paramAsBoolean(String key)
boolean	paramAsBoolean(String key, boolean defaultValue)
Integer	paramAsInt(String key)
int	paramAsInt(String key, int defaultValue)
Long	paramAsLong(String key)
long	paramAsLong(String key, long defaultValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request()

Method Detail

action

public abstract WebService.Action action()

method

public abstract String method()

Returns the name of the HTTP method with which this request was made. Possible values are GET and POST. Others are not supported.

mandatoryParam

public String mandatoryParam(String key)

Returns value of a mandatory parameter

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsBoolean

public boolean mandatoryParamAsBoolean(String key)

Returns value of a mandatory parameter

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsInt

public int mandatoryParamAsInt(String key)

Returns value of a mandatory parameter

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsLong

public long mandatoryParamAsLong(String key)

Returns value of a mandatory parameter

Throws:

IllegalArgumentException - is value is null or blank

param

@CheckForNull
public abstract String param(String key)

param

@CheckForNull
public String param(String key,
                                 @CheckForNull
                                 String defaultValue)

paramAsInt

@CheckForNull
public Integer paramAsInt(String key)

paramAsInt

public int paramAsInt(String key,
                      int defaultValue)

paramAsLong

@CheckForNull
public Long paramAsLong(String key)

paramAsLong

public long paramAsLong(String key,
                        long defaultValue)

paramAsBoolean

@CheckForNull
public Boolean paramAsBoolean(String key)

paramAsBoolean

public boolean paramAsBoolean(String key,
                              boolean defaultValue)