Package org.sonar.api.server.ws.impl

Class ValidatingRequest

java.lang.Object

org.sonar.api.server.ws.Request

org.sonar.api.server.ws.impl.ValidatingRequest

public abstract class ValidatingRequest
extends Request

Since:

4.2

Nested Class Summary

Nested classes/interfaces inherited from class org.sonar.api.server.ws.Request

Request.Param<T>, Request.Part, Request.StringParam

Field Summary

Fields inherited from class org.sonar.api.server.ws.Request

MSG_PARAMETER_MISSING

Constructor Summary

Constructors

Constructor	Description
ValidatingRequest()

Method Summary

Modifier and Type	Method	Description
WebService.Action	action()
LocalConnector	localConnector()	Allows a web service to call another web service.
java.util.List<java.lang.String>	multiParam(java.lang.String key)
java.lang.String	param(java.lang.String key)
<E extends java.lang.Enum<E>> java.util.List<E>	paramAsEnums(java.lang.String key, java.lang.Class<E> enumClass)
java.io.InputStream	paramAsInputStream(java.lang.String key)
Request.Part	paramAsPart(java.lang.String key)
java.util.List<java.lang.String>	paramAsStrings(java.lang.String key)
protected abstract java.io.InputStream	readInputStreamParam(java.lang.String key)
protected abstract java.util.List<java.lang.String>	readMultiParam(java.lang.String key)
protected abstract java.lang.String	readParam(java.lang.String key)
protected abstract Request.Part	readPart(java.lang.String key)
void	setAction(WebService.Action action)
void	setLocalConnector(LocalConnector lc)

Methods inherited from class org.sonar.api.server.ws.Request

getHeaders, getMediaType, getParam, getParam, getParam, getParams, getPath, getReader, hasParam, header, mandatoryMultiParam, mandatoryParam, mandatoryParamAsBoolean, mandatoryParamAsEnum, mandatoryParamAsInt, mandatoryParamAsLong, mandatoryParamAsPart, mandatoryParamAsStrings, method, paramAsBoolean, paramAsDate, paramAsDateTime, paramAsEnum, paramAsInt, paramAsLong

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatingRequest

public ValidatingRequest()

Method Detail

setAction

public void setAction(WebService.Action action)

action

public WebService.Action action()

localConnector

public LocalConnector localConnector()

Description copied from class: Request

Allows a web service to call another web service.

Specified by:

localConnector in class Request

See Also:

LocalConnector

setLocalConnector

public void setLocalConnector(LocalConnector lc)

param

@CheckForNull
public java.lang.String param(java.lang.String key)

Specified by:

param in class Request

multiParam

public java.util.List<java.lang.String> multiParam(java.lang.String key)

Specified by:

multiParam in class Request

paramAsInputStream

@CheckForNull
public java.io.InputStream paramAsInputStream(java.lang.String key)

Specified by:

paramAsInputStream in class Request

paramAsPart

@CheckForNull
public Request.Part paramAsPart(java.lang.String key)

Specified by:

paramAsPart in class Request

paramAsStrings

@CheckForNull
public java.util.List<java.lang.String> paramAsStrings(java.lang.String key)

Specified by:

paramAsStrings in class Request

paramAsEnums

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

Overrides:

paramAsEnums in class Request

readParam

@CheckForNull
protected abstract java.lang.String readParam(java.lang.String key)

readMultiParam

protected abstract java.util.List<java.lang.String> readMultiParam(java.lang.String key)

readInputStreamParam

@CheckForNull
protected abstract java.io.InputStream readInputStreamParam(java.lang.String key)

readPart

@CheckForNull
protected abstract Request.Part readPart(java.lang.String key)