Package org.sonar.api.server.ws.internal

Class SimpleGetRequest

java.lang.Object

org.sonar.api.server.ws.Request

org.sonar.api.server.ws.internal.SimpleGetRequest

public class SimpleGetRequest
extends Request

Fake implementation of Request used for testing. Call the method setParam(String, String) to emulate some parameter values.

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
SimpleGetRequest()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMediaType()	Returns the requested MIME type, or "application/octet-stream" if not specified.
java.util.Map<java.lang.String,java.lang.String[]>	getParams()
java.lang.String	getPath()	Return path of the request
boolean	hasParam(java.lang.String key)	Return true of the parameter is set in the request.
java.util.Optional<java.lang.String>	header(java.lang.String name)	Optional value of the HTTP header with specified name.
LocalConnector	localConnector()	Allows a web service to call another web service.
java.lang.String	method()	Returns the name of the HTTP method with which this request was made.
java.util.List<java.lang.String>	multiParam(java.lang.String key)
java.lang.String	param(java.lang.String key)
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)
SimpleGetRequest	setHeader(java.lang.String name, java.lang.String value)
SimpleGetRequest	setMediaType(java.lang.String mediaType)
SimpleGetRequest	setParam(java.lang.String key, java.lang.String value)
SimpleGetRequest	setPart(java.lang.String key, java.io.InputStream input, java.lang.String fileName)
SimpleGetRequest	setPath(java.lang.String path)

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

getHeaders, getParam, getParam, getParam, getReader, mandatoryMultiParam, mandatoryParam, mandatoryParamAsBoolean, mandatoryParamAsEnum, mandatoryParamAsInt, mandatoryParamAsLong, mandatoryParamAsPart, mandatoryParamAsStrings, param, paramAsBoolean, paramAsBoolean, paramAsDate, paramAsDateTime, paramAsEnum, paramAsEnums, paramAsInt, paramAsInt, paramAsLong, paramAsLong

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleGetRequest

public SimpleGetRequest()

Method Detail

method

public java.lang.String method()

Description copied from class: Request

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

Specified by:

method in class Request

getMediaType

public java.lang.String getMediaType()

Description copied from class: Request

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

Specified by:

getMediaType in class Request

setMediaType

public SimpleGetRequest setMediaType(java.lang.String mediaType)

hasParam

public boolean hasParam(java.lang.String key)

Description copied from class: Request

Return true of the parameter is set in the request. Does NOT take into account the deprecated key of a parameter.

Specified by:

hasParam in class Request

param

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

paramAsStrings

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

Specified by:

paramAsStrings in class Request

paramAsInputStream

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

Specified by:

paramAsInputStream in class Request

setParam

public SimpleGetRequest setParam(java.lang.String key,
                                 @Nullable
                                 java.lang.String value)

getParams

public java.util.Map<java.lang.String,java.lang.String[]> getParams()

Specified by:

getParams in class Request

paramAsPart

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

Specified by:

paramAsPart in class Request

setPart

public SimpleGetRequest setPart(java.lang.String key,
                                java.io.InputStream input,
                                java.lang.String fileName)

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

getPath

public java.lang.String getPath()

Description copied from class: Request

Return path of the request

Specified by:

getPath in class Request

setPath

public SimpleGetRequest setPath(java.lang.String path)

header

public java.util.Optional<java.lang.String> header(java.lang.String name)

Description copied from class: Request

Optional value of the HTTP header with specified name. If present, the result can have an empty string value ("").

Specified by:

header in class Request

setHeader

public SimpleGetRequest setHeader(java.lang.String name,
                                  java.lang.String value)