org.sonar.api.server.ws

Class Request

java.lang.Object

org.sonar.api.server.ws.Request

Direct Known Subclasses:

SimpleGetRequest, ValidatingRequest

public abstract class Request
extends Object

Since:

4.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Request.Part

Constructor Summary

Constructors

Constructor and Description
Request()

Method Summary

Modifier and Type	Method and Description
abstract String	getMediaType() Returns the requested MIME type, or "application/octet-stream" if not specified.
abstract String	getPath() Return path of the request
abstract boolean	hasParam(String key) Return true of the parameter is set.
abstract LocalConnector	localConnector() Allows a web service to call another web service.
String	mandatoryParam(String key) Returns a non-null value.
boolean	mandatoryParamAsBoolean(String key) Returns a boolean value.
<E extends Enum<E>> E	mandatoryParamAsEnum(String key, Class<E> enumClass)
int	mandatoryParamAsInt(String key) Returns an int value.
long	mandatoryParamAsLong(String key) Returns a long value.
Request.Part	mandatoryParamAsPart(String key)
List<String>	mandatoryParamAsStrings(String key)
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) Deprecated. to be dropped in 4.4. Default values are declared in ws metadata
Boolean	paramAsBoolean(String key)
boolean	paramAsBoolean(String key, boolean defaultValue) Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsBoolean(String).
Date	paramAsDate(String key)
Date	paramAsDateTime(String key)
<E extends Enum<E>> E	paramAsEnum(String key, Class<E> enumClass)
<E extends Enum<E>> List<E>	paramAsEnums(String key, Class<E> enumClass)
abstract InputStream	paramAsInputStream(String key)
Integer	paramAsInt(String key)
int	paramAsInt(String key, int defaultValue) Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsInt(String).
Long	paramAsLong(String key)
long	paramAsLong(String key, long defaultValue) Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsLong(String).
abstract Request.Part	paramAsPart(String key)
List<String>	paramAsStrings(String key)

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

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.

getMediaType

public abstract String getMediaType()

Returns the requested MIME type, or "application/octet-stream" if not specified.

hasParam

public abstract boolean hasParam(String key)

Return true of the parameter is set.

mandatoryParam

public String mandatoryParam(String key)

Returns a non-null value. To be used when parameter is required or has a default value.

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsBoolean

public boolean mandatoryParamAsBoolean(String key)

Returns a boolean value. To be used when parameter is required or has a default value.

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsInt

public int mandatoryParamAsInt(String key)

Returns an int value. To be used when parameter is required or has a default value.

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsLong

public long mandatoryParamAsLong(String key)

Returns a long value. To be used when parameter is required or has a default value.

Throws:

IllegalArgumentException - is value is null or blank

mandatoryParamAsEnum

public <E extends Enum<E>> E mandatoryParamAsEnum(String key,
                                                  Class<E> enumClass)

mandatoryParamAsStrings

public List<String> mandatoryParamAsStrings(String key)

paramAsStrings

@CheckForNull
public List<String> paramAsStrings(String key)

param

@CheckForNull
public abstract String param(String key)

paramAsInputStream

@CheckForNull
public abstract InputStream paramAsInputStream(String key)

paramAsPart

@CheckForNull
public abstract Request.Part paramAsPart(String key)

mandatoryParamAsPart

public Request.Part mandatoryParamAsPart(String key)

param

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

Deprecated. to be dropped in 4.4. Default values are declared in ws metadata

paramAsBoolean

@Deprecated
public boolean paramAsBoolean(String key,
                                          boolean defaultValue)

Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsBoolean(String).

paramAsInt

@Deprecated
public int paramAsInt(String key,
                                  int defaultValue)

Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsInt(String).

paramAsLong

@Deprecated
public long paramAsLong(String key,
                                    long defaultValue)

Deprecated. to be dropped in 4.4. Default values must be declared in WebService then this method can be replaced by mandatoryParamAsLong(String).

paramAsBoolean

@CheckForNull
public Boolean paramAsBoolean(String key)

paramAsInt

@CheckForNull
public Integer paramAsInt(String key)

paramAsLong

@CheckForNull
public Long paramAsLong(String key)

paramAsEnum

@CheckForNull
public <E extends Enum<E>> E paramAsEnum(String key,
                                                       Class<E> enumClass)

paramAsEnums

@CheckForNull
public <E extends Enum<E>> List<E> paramAsEnums(String key,
                                                              Class<E> enumClass)

paramAsDateTime

@CheckForNull
public Date paramAsDateTime(String key)

paramAsDate

@CheckForNull
public Date paramAsDate(String key)

localConnector

@Beta
public abstract LocalConnector localConnector()

Allows a web service to call another web service.

Since:

5.5

See Also:

LocalConnector

getPath

public abstract String getPath()

Return path of the request

Since:

6.0